]>
code.delx.au - refind/blob - libeg/libeg.h
3 * EFI graphics library header for users
5 * Copyright (c) 2006 Christoph Pfisterer
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the
20 * * Neither the name of Christoph Pfisterer nor the names of the
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 #ifndef __LIBEG_LIBEG_H__
38 #define __LIBEG_LIBEG_H__
43 /* This should be compatible with EFI_UGA_PIXEL */
55 #define EG_EIPIXELMODE_GRAY (0)
56 #define EG_EIPIXELMODE_GRAY_ALPHA (1)
57 #define EG_EIPIXELMODE_COLOR (2)
58 #define EG_EIPIXELMODE_COLOR_ALPHA (3)
59 #define EG_EIPIXELMODE_ALPHA (4)
60 #define EG_MAX_EIPIXELMODE EG_EIPIXELMODE_ALPHA
62 #define EG_EICOMPMODE_NONE (0)
63 #define EG_EICOMPMODE_RLE (1)
64 #define EG_EICOMPMODE_EFICOMPRESS (2)
77 VOID
egInitScreen(VOID
);
78 VOID
egGetScreenSize(OUT UINTN
*ScreenWidth
, OUT UINTN
*ScreenHeight
);
79 CHAR16
* egScreenDescription(VOID
);
80 BOOLEAN
egHasGraphicsMode(VOID
);
81 BOOLEAN
egIsGraphicsModeEnabled(VOID
);
82 VOID
egSetGraphicsModeEnabled(IN BOOLEAN Enable
);
83 // NOTE: Even when egHasGraphicsMode() returns FALSE, you should
84 // call egSetGraphicsModeEnabled(FALSE) to ensure the system
85 // is running in text mode. egHasGraphicsMode() only determines
86 // if libeg can draw to the screen in graphics mode.
88 EG_IMAGE
* egCreateImage(IN UINTN Width
, IN UINTN Height
, IN BOOLEAN HasAlpha
);
89 EG_IMAGE
* egCreateFilledImage(IN UINTN Width
, IN UINTN Height
, IN BOOLEAN HasAlpha
, IN EG_PIXEL
*Color
);
90 EG_IMAGE
* egCopyImage(IN EG_IMAGE
*Image
);
91 VOID
egFreeImage(IN EG_IMAGE
*Image
);
93 EG_IMAGE
* egLoadImage(IN EFI_FILE
* BaseDir
, IN CHAR16
*FileName
, IN BOOLEAN WantAlpha
);
94 EG_IMAGE
* egLoadIcon(IN EFI_FILE
* BaseDir
, IN CHAR16
*FileName
, IN UINTN IconSize
);
95 EG_IMAGE
* egDecodeImage(IN UINT8
*FileData
, IN UINTN FileDataLength
, IN CHAR16
*Format
, IN BOOLEAN WantAlpha
);
96 EG_IMAGE
* egPrepareEmbeddedImage(IN EG_EMBEDDED_IMAGE
*EmbeddedImage
, IN BOOLEAN WantAlpha
);
98 EG_IMAGE
* egEnsureImageSize(IN EG_IMAGE
*Image
, IN UINTN Width
, IN UINTN Height
, IN EG_PIXEL
*Color
);
100 EFI_STATUS
egLoadFile(IN EFI_FILE
* BaseDir
, IN CHAR16
*FileName
,
101 OUT UINT8
**FileData
, OUT UINTN
*FileDataLength
);
102 EFI_STATUS
egSaveFile(IN EFI_FILE
* BaseDir OPTIONAL
, IN CHAR16
*FileName
,
103 IN UINT8
*FileData
, IN UINTN FileDataLength
);
105 VOID
egFillImage(IN OUT EG_IMAGE
*CompImage
, IN EG_PIXEL
*Color
);
106 VOID
egFillImageArea(IN OUT EG_IMAGE
*CompImage
,
107 IN UINTN AreaPosX
, IN UINTN AreaPosY
,
108 IN UINTN AreaWidth
, IN UINTN AreaHeight
,
110 VOID
egComposeImage(IN OUT EG_IMAGE
*CompImage
, IN EG_IMAGE
*TopImage
, IN UINTN PosX
, IN UINTN PosY
);
112 VOID
egMeasureText(IN CHAR16
*Text
, OUT UINTN
*Width
, OUT UINTN
*Height
);
113 VOID
egRenderText(IN CHAR16
*Text
, IN OUT EG_IMAGE
*CompImage
, IN UINTN PosX
, IN UINTN PosY
);
115 VOID
egClearScreen(IN EG_PIXEL
*Color
);
116 VOID
egDrawImage(IN EG_IMAGE
*Image
, IN UINTN ScreenPosX
, IN UINTN ScreenPosY
);
117 VOID
egDrawImageArea(IN EG_IMAGE
*Image
,
118 IN UINTN AreaPosX
, IN UINTN AreaPosY
,
119 IN UINTN AreaWidth
, IN UINTN AreaHeight
,
120 IN UINTN ScreenPosX
, IN UINTN ScreenPosY
);
122 VOID
egScreenShot(VOID
);
125 #endif /* __LIBEG_LIBEG_H__ */