\r
typedef VOID *EFI_FONT_HANDLE;\r
\r
-//\r
-// EFI_HII_OUT_FLAGS\r
-// \r
+///\r
+/// EFI_HII_OUT_FLAGS\r
+/// \r
typedef UINT32 EFI_HII_OUT_FLAGS;\r
+\r
#define EFI_HII_OUT_FLAG_CLIP 0x00000001\r
#define EFI_HII_OUT_FLAG_WRAP 0x00000002\r
#define EFI_HII_OUT_FLAG_CLIP_CLEAN_Y 0x00000004\r
#define EFI_HII_DIRECT_TO_SCREEN 0x00000080\r
\r
/**\r
-\r
Definition of EFI_HII_ROW_INFO.\r
-\r
- @param StartIndex The index of the first character in the\r
- string which is displayed on the line.\r
-\r
- @param EndIndex The index of the last character in the string\r
- which is displayed on the line. If this is the\r
- same as StartIndex, then no characters are\r
- displayed.\r
-\r
- @param LineHeight The height of the line, in pixels.\r
-\r
- @param LineWidth The width of the text on the line, in pixels.\r
-\r
- @param BaselineOffset The number of pixels above the bottom of\r
- the row of the font baseline or 0 if\r
- none.\r
-\r
**/\r
typedef struct _EFI_HII_ROW_INFO {\r
+ ///\r
+ /// The index of the first character in the string which is displayed on the line.\r
+ ///\r
UINTN StartIndex;\r
+ ///\r
+ /// The index of the last character in the string which is displayed on the line.\r
+ /// If this is the same as StartIndex, then no characters are displayed. \r
+ ///\r
UINTN EndIndex;\r
- UINTN LineHeight;\r
- UINTN LineWidth;\r
+ UINTN LineHeight; ///< The height of the line, in pixels.\r
+ UINTN LineWidth; ///< The width of the text on the line, in pixels.\r
+ \r
+ ///\r
+ /// The number of pixels above the bottom of the row of the font baseline or 0 if none. \r
+ ///\r
UINTN BaselineOffset;\r
} EFI_HII_ROW_INFO;\r
\r
-//\r
-// EFI_FONT_INFO_MASK\r
-// \r
+///\r
+/// Font info flag. All flags (FONT, SIZE, STYLE, and COLOR) are defined.\r
+/// They are defined as EFI_FONT_INFO_***\r
+///\r
typedef UINT32 EFI_FONT_INFO_MASK;\r
+\r
#define EFI_FONT_INFO_SYS_FONT 0x00000001\r
#define EFI_FONT_INFO_SYS_SIZE 0x00000002\r
#define EFI_FONT_INFO_SYS_STYLE 0x00000004\r
// \r
typedef struct {\r
EFI_HII_FONT_STYLE FontStyle;\r
- UINT16 FontSize; // character cell height in pixels\r
+ UINT16 FontSize; ///< character cell height in pixels\r
CHAR16 FontName[1];\r
} EFI_FONT_INFO;\r
\r
/**\r
+ Describes font output-related information.\r
+\r
This structure is used for describing the way in which a string\r
should be rendered in a particular font. FontInfo specifies the\r
basic font information and ForegroundColor and BackgroundColor\r
in FontInfoMask describe where the system default should be\r
supplied instead of the specified information. The flags also\r
describe what options can be used to make a match between the\r
- font requested and the font available. If EFI_FONT_INFO_SYS_FONT\r
- is specified, then the font name in FontInfo is ignored and the\r
- system font name is used. This flag cannot be used with\r
- EFI_FONT_INFO_ANY_FONT. If EFI_FONT_INFO_SYS_SIZE is specified,\r
- then the font height specified in FontInfo is ignored and the\r
- system font height is used instead. This flag cannot be used\r
- with EFI_FONT_INFO_ANY_SIZE. If EFI_FONT_INFO_SYS_STYLE is\r
- specified, then the font style in FontInfo is ignored and the\r
- system font style is used. This flag cannot be used with\r
- EFI_FONT_INFO_ANY_STYLE. If EFI_FONT_INFO_SYS_FORE_COLOR is\r
- specified, then ForegroundColor is ignored and the system\r
- foreground color is used. If EFI_FONT_INFO_SYS_BACK_COLOR is\r
- specified, then BackgroundColor is ignored and the system\r
- background color is used. If EFI_FONT_INFO_RESIZE is specified,\r
- then the system may attempt to stretch or shrink a font to meet\r
- the size requested. This flag cannot be used with\r
- EFI_FONT_INFO_ANY_SIZE. If EFI_FONT_INFO_RESTYLE is specified,\r
- then the system may attempt to remove some of the specified\r
- styles in order to meet the style requested. This flag cannot be\r
- used with EFI_FONT_INFO_ANY_STYLE. If EFI_FONT_INFO_ANY_FONT is\r
- specified, then the system may attempt to match with any font.\r
- This flag cannot be used with EFI_FONT_INFO_SYS_FONT. If\r
- EFI_FONT_INFO_ANY_SIZE is specified, then the system may attempt\r
- to match with any font size. This flag cannot be used with\r
- EFI_FONT_INFO_SYS_SIZE or EFI_FONT_INFO_RESIZE. If\r
- EFI_FONT_INFO_ANY_STYLE is specified, then the system may\r
- attempt to match with any font style. This flag cannot be used\r
- with EFI_FONT_INFO_SYS_STYLE or EFI_FONT_INFO_RESTYLE.\r
-\r
-\r
- @param ForegroundColor The color of the "on" pixels in the\r
- glyph in the bitmap.\r
- \r
- @param BackgroundColor The color of the "off" pixels in the\r
- glyph in the bitmap.\r
- \r
- @param FontInfoMask The font information mask determines\r
- which portion of the font information\r
- will be used and what to do if the\r
- specific font is not available.\r
-\r
- @param FontInfo Points to the font information or NULL if the\r
- string should use the default system font.\r
- \r
+ font requested and the font available.\r
**/\r
typedef struct _EFI_FONT_DISPLAY_INFO {\r
EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;\r
IN CONST EFI_STRING String OPTIONAL\r
);\r
\r
-/**\r
- @par Protocol Description:\r
- The protocol provides the service to retrieve the font informations.\r
-\r
- @param StringToImage Render a string to a bitmap or to the display.\r
-\r
- @param StringIdToImage Render a string to a bitmap or to the display.\r
-\r
- @param GetGlyph Return a specific glyph in a specific font.\r
-\r
- @param GetFontInfo Return font information for a specific font.\r
-\r
-**/\r
+///\r
+/// The protocol provides the service to retrieve the font informations.\r
+///\r
struct _EFI_HII_FONT_PROTOCOL {\r
EFI_HII_STRING_TO_IMAGE StringToImage;\r
EFI_HII_STRING_ID_TO_IMAGE StringIdToImage;\r
projects / mirror_edk2.git / blobdiff