/** @file\r
The file provides services to retrieve font information.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation\r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php. \r
+ \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
**/\r
\r
typedef VOID *EFI_FONT_HANDLE;\r
\r
///\r
-/// EFI_HII_OUT_FLAGS\r
+/// EFI_HII_OUT_FLAGS.\r
/// \r
typedef UINT32 EFI_HII_OUT_FLAGS;\r
\r
} EFI_HII_ROW_INFO;\r
\r
///\r
-/// EFI_FONT_INFO_MASK\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
} 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
+ font requested and the font available.\r
**/\r
typedef struct _EFI_FONT_DISPLAY_INFO {\r
EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;\r
\r
This function renders a string to a bitmap or the screen using\r
the specified font, color and options. It either draws the\r
- string and glyphs on an existing bitmap, allocates a new bitmap\r
+ string and glyphs on an existing bitmap, allocates a new bitmap,\r
or uses the screen. The strings can be clipped or wrapped.\r
Optionally, the function also returns the information about each\r
row and the character position on that row. If\r
outside the bounding box specified by Width and Height are\r
ignored. The information in the RowInfoArray only describes\r
characters which are at least partially displayed. For the final\r
- row, the LineHeight and BaseLine may describe pixels which are\r
+ row, the LineHeight and BaseLine may describe pixels that are\r
outside the limit specified by Height (unless\r
EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is specified) even though those\r
pixels were not drawn. The LineWidth may describe pixels which\r
will use the pixel value from Blt. This flag cannot be used if\r
Blt is NULL upon entry. If EFI_HII_IGNORE_IF_NO_GLYPH is set,\r
then characters which have no glyphs are not drawn. Otherwise,\r
- they are replaced with Unicode character 0xFFFD (REPLACEMENT\r
+ they are replaced with Unicode character code 0xFFFD (REPLACEMENT\r
CHARACTER). If EFI_HII_IGNORE_LINE_BREAK is set, then explicit\r
line break characters will be ignored. If\r
EFI_HII_DIRECT_TO_SCREEN is set, then the string will be written\r
containing row information and\r
RowInfoArraySize will be updated to contain\r
the number of elements. This array describes\r
- the characters which were at least partially\r
+ the characters that were at least partially\r
drawn and the heights of the rows. It is the\r
caller's responsibility to free this buffer.\r
\r
string on the row where it is\r
displayed. Non-printing characters\r
will have the offset ~0. The caller is\r
- responsible to allocate a buffer large\r
+ responsible for allocating a buffer large\r
enough so that there is one entry for\r
each character in the string, not\r
including the null-terminator. It is\r
\r
This function renders a string as a bitmap or to the screen\r
and can clip or wrap the string. The bitmap is either supplied\r
- by the caller or else is allocated by the function. The\r
+ by the caller or allocated by the function. The\r
strings are drawn with the font, size and style specified and\r
can be drawn transparently or opaquely. The function can also\r
return information about each row and each character's\r
position on the row. If EFI_HII_OUT_FLAG_CLIP is set, then\r
- text will be formatted only based on explicit line breaks and\r
- all pixels which would lie outside the bounding box specified\r
+ text will be formatted based only on explicit line breaks, and\r
+ all pixels that would lie outside the bounding box specified\r
by Width and Height are ignored. The information in the\r
RowInfoArray only describes characters which are at least\r
partially displayed. For the final row, the LineHeight and\r
EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is set, then it modifies the\r
behavior of EFI_HII_OUT_FLAG_CLIP so that if a row's bottom\r
most pixel cannot fit, then it will not be drawn at all. This\r
- flag requires that EFI_HII_OUT_FLAG_CLIP be set. Draft for\r
- Review HII Protocols Version 2.1 November 3, 2006 1285 If\r
+ flag requires that EFI_HII_OUT_FLAG_CLIP be set. If\r
EFI_HII_OUT_FLAG_WRAP is set, then text will be wrapped at the\r
right-most line-break opportunity prior to a character whose\r
right-most extent would exceed Width. If no line-break\r
use the pixel value from Blt. This flag cannot be used if Blt\r
is NULL upon entry. If EFI_HII_IGNORE_IF_NO_GLYPH is set, then\r
characters which have no glyphs are not drawn. Otherwise, they\r
- are replaced with Unicode character 0xFFFD (REPLACEMENT\r
+ are replaced with Unicode character code 0xFFFD (REPLACEMENT\r
CHARACTER). If EFI_HII_IGNORE_LINE_BREAK is set, then explicit\r
line break characters will be ignored. If\r
EFI_HII_DIRECT_TO_SCREEN is set, then the string will be\r
@retval EFI_OUT_OF_RESOURCES Unable to allocate an output\r
buffer for RowInfoArray or Blt.\r
\r
- @retval EFI_INVALID_PARAMETER The String or Blt or Height or\r
+ @retval EFI_INVALID_PARAMETER The String, or Blt, or Height, or\r
Width was NULL.\r
@retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r
@retval EFI_INVALID_PARAMETER Flags were invalid combination.\r
- @retval EFI_NOT_FOUND The specified PackageList is not in the Database \r
+ @retval EFI_NOT_FOUND The specified PackageList is not in the Database, \r
or the stringid is not in the specified PackageList. \r
\r
**/\r
\r
@param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
\r
- @param Char Character to retrieve.\r
+ @param Char The character to retrieve.\r
\r
@param StringInfo Points to the string font and color\r
information or NULL if the string should use\r
the default system font and color.\r
\r
- @param Blt Thus must point to a NULL on entry. A buffer will\r
+ @param Blt This must point to a NULL on entry. A buffer will\r
be allocated to hold the output and the pointer\r
updated on exit. It is the caller's responsibility\r
to free this buffer.\r
\r
- @param Baseline Number of pixels from the bottom of the bitmap\r
+ @param Baseline The number of pixels from the bottom of the bitmap\r
to the baseline.\r
\r
\r
- @retval EFI_SUCCESS Glyph bitmap created.\r
+ @retval EFI_SUCCESS The glyph bitmap created.\r
\r
@retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.\r
\r
@retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was\r
replaced with the glyph for\r
- Unicode character 0xFFFD.\r
+ Unicode character code 0xFFFD.\r
\r
- @retval EFI_INVALID_PARAMETER Blt is NULL or Width is NULL or\r
+ @retval EFI_INVALID_PARAMETER Blt is NULL, or Width is NULL, or\r
Height is NULL\r
\r
\r
to NULL if there are no more matching fonts.\r
\r
@param StringInfoIn Upon entry, points to the font to return\r
- information about. If NULL, then the information about the system default \r
- font will be returned.\r
+ information about. If NULL, then the information \r
+ about the system default font will be returned.\r
\r
@param StringInfoOut Upon return, contains the matching\r
font's information. If NULL, then no\r
@retval EFI_SUCCESS Matching font returned successfully.\r
\r
@retval EFI_NOT_FOUND No matching font was found.\r
- \r
- @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.\r
\r
@retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the request.\r
\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
+///\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