| d1f95000 |
1 | /** @file\r |
| 2 | The file provides services to retrieve font information.\r |
| 3 | \r |
| 54cf8780 |
4 | Copyright (c) 2006 - 2008, Intel Corporation\r |
| d1f95000 |
5 | All rights reserved. This program and the accompanying materials \r |
| 6 | are licensed and made available under the terms and conditions of the BSD License \r |
| 7 | which accompanies this distribution. The full text of the license may be found at \r |
| 8 | http://opensource.org/licenses/bsd-license.php \r |
| 9 | \r |
| 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
| 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
| 12 | \r |
| d1f95000 |
13 | **/\r |
| 14 | \r |
| 15 | #ifndef __HII_FONT_H__\r |
| 16 | #define __HII_FONT_H__\r |
| 17 | \r |
| 5a1fc221 |
18 | #include <Protocol/GraphicsOutput.h>\r |
| d1f95000 |
19 | #include <Protocol/HiiImage.h>\r |
| 20 | \r |
| 21 | #define EFI_HII_FONT_PROTOCOL_GUID \\r |
| 22 | { 0xe9ca4775, 0x8657, 0x47fc, { 0x97, 0xe7, 0x7e, 0xd6, 0x5a, 0x8, 0x43, 0x24 } }\r |
| 23 | \r |
| 24 | typedef struct _EFI_HII_FONT_PROTOCOL EFI_HII_FONT_PROTOCOL;\r |
| 25 | \r |
| 5a1fc221 |
26 | typedef VOID *EFI_FONT_HANDLE;\r |
| d1f95000 |
27 | \r |
| 28 | //\r |
| 29 | // EFI_HII_OUT_FLAGS\r |
| 30 | // \r |
| 31 | typedef UINT32 EFI_HII_OUT_FLAGS;\r |
| 32 | #define EFI_HII_OUT_FLAG_CLIP 0x00000001\r |
| 33 | #define EFI_HII_OUT_FLAG_WRAP 0x00000002\r |
| 54cf8780 |
34 | #define EFI_HII_OUT_FLAG_CLIP_CLEAN_Y 0x00000004\r |
| 35 | #define EFI_HII_OUT_FLAG_CLIP_CLEAN_X 0x00000008\r |
| d1f95000 |
36 | #define EFI_HII_OUT_FLAG_TRANSPARENT 0x00000010\r |
| 37 | #define EFI_HII_IGNORE_IF_NO_GLYPH 0x00000020\r |
| 38 | #define EFI_HII_IGNORE_LINE_BREAK 0x00000040\r |
| 39 | #define EFI_HII_DIRECT_TO_SCREEN 0x00000080\r |
| 40 | \r |
| 41 | /**\r |
| 42 | \r |
| 43 | Definition of EFI_HII_ROW_INFO.\r |
| 44 | \r |
| 45 | @param StartIndex The index of the first character in the\r |
| 46 | string which is displayed on the line.\r |
| 47 | \r |
| 48 | @param EndIndex The index of the last character in the string\r |
| 49 | which is displayed on the line. If this is the\r |
| 50 | same as StartIndex, then no characters are\r |
| 51 | displayed.\r |
| 52 | \r |
| 53 | @param LineHeight The height of the line, in pixels.\r |
| 54 | \r |
| 55 | @param LineWidth The width of the text on the line, in\r |
| 56 | pixels.\r |
| 57 | \r |
| 58 | @param BaselineOffset The number of pixels above the bottom of\r |
| 59 | the row of the font baseline or 0 if\r |
| 60 | none.\r |
| 61 | \r |
| 62 | **/\r |
| 63 | typedef struct _EFI_HII_ROW_INFO {\r |
| 64 | UINTN StartIndex;\r |
| 65 | UINTN EndIndex;\r |
| 66 | UINTN LineHeight;\r |
| 67 | UINTN LineWidth;\r |
| 68 | UINTN BaselineOffset;\r |
| 69 | } EFI_HII_ROW_INFO;\r |
| 70 | \r |
| 71 | //\r |
| 72 | // EFI_FONT_INFO_MASK\r |
| 73 | // \r |
| 74 | typedef UINT32 EFI_FONT_INFO_MASK;\r |
| 75 | #define EFI_FONT_INFO_SYS_FONT 0x00000001\r |
| 76 | #define EFI_FONT_INFO_SYS_SIZE 0x00000002\r |
| 77 | #define EFI_FONT_INFO_SYS_STYLE 0x00000004\r |
| 78 | #define EFI_FONT_INFO_SYS_FORE_COLOR 0x00000010\r |
| 79 | #define EFI_FONT_INFO_SYS_BACK_COLOR 0x00000020\r |
| 80 | #define EFI_FONT_INFO_RESIZE 0x00001000\r |
| 81 | #define EFI_FONT_INFO_RESTYLE 0x00002000\r |
| 82 | #define EFI_FONT_INFO_ANY_FONT 0x00010000\r |
| 83 | #define EFI_FONT_INFO_ANY_SIZE 0x00020000\r |
| 84 | #define EFI_FONT_INFO_ANY_STYLE 0x00040000\r |
| 85 | \r |
| 86 | //\r |
| 87 | // EFI_FONT_INFO\r |
| 88 | // \r |
| 89 | typedef struct {\r |
| 54cf8780 |
90 | EFI_HII_FONT_STYLE FontStyle;\r |
| 91 | UINT16 FontSize; // character cell height in pixels\r |
| 92 | CHAR16 FontName[1];\r |
| d1f95000 |
93 | } EFI_FONT_INFO;\r |
| 94 | \r |
| 95 | /**\r |
| 96 | This structure is used for describing the way in which a string\r |
| 97 | should be rendered in a particular font. FontInfo specifies the\r |
| 98 | basic font information and ForegroundColor and BackgroundColor\r |
| 99 | specify the color in which they should be displayed. The flags\r |
| 100 | in FontInfoMask describe where the system default should be\r |
| 101 | supplied instead of the specified information. The flags also\r |
| 102 | describe what options can be used to make a match between the\r |
| 103 | font requested and the font available. If EFI_FONT_INFO_SYS_FONT\r |
| 104 | is specified, then the font name in FontInfo is ignored and the\r |
| 105 | system font name is used. This flag cannot be used with\r |
| 106 | EFI_FONT_INFO_ANY_FONT. If EFI_FONT_INFO_SYS_SIZE is specified,\r |
| 107 | then the font height specified in FontInfo is ignored and the\r |
| 108 | system font height is used instead. This flag cannot be used\r |
| 109 | with EFI_FONT_INFO_ANY_SIZE. If EFI_FONT_INFO_SYS_STYLE is\r |
| 110 | specified, then the font style in FontInfo is ignored and the\r |
| 111 | system font style is used. This flag cannot be used with\r |
| 112 | EFI_FONT_INFO_ANY_STYLE. If EFI_FONT_INFO_SYS_FORE_COLOR is\r |
| 113 | specified, then ForegroundColor is ignored and the system\r |
| 114 | foreground color is used. If EFI_FONT_INFO_SYS_BACK_COLOR is\r |
| 115 | specified, then BackgroundColor is ignored and the system\r |
| 116 | background color is used. If EFI_FONT_INFO_RESIZE is specified,\r |
| 117 | then the system may attempt to stretch or shrink a font to meet\r |
| 118 | the size requested. This flag cannot be used with\r |
| 119 | EFI_FONT_INFO_ANY_SIZE. If EFI_FONT_INFO_RESTYLE is specified,\r |
| 120 | then the system may attempt to remove some of the specified\r |
| 121 | styles in order to meet the style requested. This flag cannot be\r |
| 122 | used with EFI_FONT_INFO_ANY_STYLE. If EFI_FONT_INFO_ANY_FONT is\r |
| 123 | specified, then the system may attempt to match with any font.\r |
| 124 | This flag cannot be used with EFI_FONT_INFO_SYS_FONT. If\r |
| 125 | EFI_FONT_INFO_ANY_SIZE is specified, then the system may attempt\r |
| 126 | to match with any font size. This flag cannot be used with\r |
| 127 | EFI_FONT_INFO_SYS_SIZE or EFI_FONT_INFO_RESIZE. If\r |
| 128 | EFI_FONT_INFO_ANY_STYLE is specified, then the system may\r |
| 129 | attempt to match with any font style. This flag cannot be used\r |
| 130 | with EFI_FONT_INFO_SYS_STYLE or EFI_FONT_INFO_RESTYLE.\r |
| 131 | \r |
| 132 | @param FontInfo Points to the font information or NULL if the\r |
| 133 | string should use the default system font.\r |
| 134 | \r |
| 135 | @param ForegroundColor The color of the "on" pixels in the\r |
| 136 | glyph in the bitmap.\r |
| 137 | \r |
| 138 | @param BackgroundColor The color of the "off" pixels in the\r |
| 139 | glyph in the bitmap.\r |
| 140 | \r |
| 141 | @param FontInfoMask The font information mask determines\r |
| 142 | which portion of the font information\r |
| 143 | will be used and what to do if the\r |
| 144 | specific font is not available.\r |
| 145 | \r |
| 146 | **/\r |
| 147 | typedef struct _EFI_FONT_DISPLAY_INFO {\r |
| d1f95000 |
148 | EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;\r |
| 149 | EFI_GRAPHICS_OUTPUT_BLT_PIXEL BackgroundColor;\r |
| 150 | EFI_FONT_INFO_MASK FontInfoMask;\r |
| 5a1fc221 |
151 | EFI_FONT_INFO FontInfo; \r |
| d1f95000 |
152 | } EFI_FONT_DISPLAY_INFO;\r |
| 153 | \r |
| 154 | /**\r |
| 155 | \r |
| 156 | This function renders a string to a bitmap or the screen using\r |
| 157 | the specified font, color and options. It either draws the\r |
| 158 | string and glyphs on an existing bitmap, allocates a new bitmap\r |
| 159 | or uses the screen. The strings can be clipped or wrapped.\r |
| 160 | Optionally, the function also returns the information about each\r |
| 161 | row and the character position on that row. If\r |
| 162 | EFI_HII_OUT_FLAG_CLIP is set, then text will be formatted only\r |
| 163 | based on explicit line breaks and all pixels which would lie\r |
| 164 | outside the bounding box specified by Width and Height are\r |
| 165 | ignored. The information in the RowInfoArray only describes\r |
| 166 | characters which are at least partially displayed. For the final\r |
| 167 | row, the LineHeight and BaseLine may describe pixels which are\r |
| 168 | outside the limit specified by Height (unless\r |
| 169 | EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is specified) even though those\r |
| 170 | pixels were not drawn. The LineWidth may describe pixels which\r |
| 171 | are outside the limit specified by Width (unless\r |
| 172 | EFI_HII_OUT_FLAG_CLIP_CLEAN_X is specified) even though those\r |
| 173 | pixels were not drawn. If EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set,\r |
| 174 | then it modifies the behavior of EFI_HII_OUT_FLAG_CLIP so that\r |
| 175 | if a character????s right-most on pixel cannot fit, then it will\r |
| 176 | not be drawn at all. This flag requires that\r |
| 177 | EFI_HII_OUT_FLAG_CLIP be set. If EFI_HII_OUT_FLAG_CLIP_CLEAN_Y\r |
| 178 | is set, then it modifies the behavior of EFI_HII_OUT_FLAG_CLIP\r |
| 179 | so that if a row????s bottom-most pixel cannot fit, then it will\r |
| 180 | not be drawn at all. This flag requires that\r |
| 181 | EFI_HII_OUT_FLAG_CLIP be set. If EFI_HII_OUT_FLAG_WRAP is set,\r |
| 182 | then text will be wrapped at the right-most line-break\r |
| 183 | opportunity prior to a character whose right-most extent would\r |
| 184 | exceed Width. If no line-break opportunity can be found, then\r |
| 185 | the text will behave as if EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set.\r |
| 186 | This flag cannot be used with EFI_HII_OUT_FLAG_CLIP_CLEAN_X. If\r |
| 187 | EFI_HII_OUT_FLAG_TRANSPARENT is set, then BackgroundColor is\r |
| 188 | ignored and all ????off???? pixels in the character????s drawn\r |
| 189 | will use the pixel value from Blt. This flag cannot be used if\r |
| 190 | Blt is NULL upon entry. If EFI_HII_IGNORE_IF_NO_GLYPH is set,\r |
| 191 | then characters which have no glyphs are not drawn. Otherwise,\r |
| 192 | they are replaced with Unicode character 0xFFFD (REPLACEMENT\r |
| 193 | CHARACTER). If EFI_HII_IGNORE_LINE_BREAK is set, then explicit\r |
| 194 | line break characters will be ignored. If\r |
| 195 | EFI_HII_DIRECT_TO_SCREEN is set, then the string will be written\r |
| 196 | directly to the output device specified by Screen. Otherwise the\r |
| 197 | string will be rendered to the bitmap specified by Bitmap.\r |
| 198 | \r |
| 199 | @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r |
| 200 | \r |
| 201 | @param Flags Describes how the string is to be drawn.\r |
| 202 | \r |
| 203 | @param String Points to the null-terminated string to be\r |
| 204 | displayed.\r |
| 205 | \r |
| 206 | @param StringInfo Points to the string output information,\r |
| 207 | including the color and font. If NULL, then\r |
| 208 | the string will be output in the default\r |
| 209 | system font and color.\r |
| 210 | \r |
| 211 | @param Blt If this points to a non-NULL on entry, this points\r |
| 212 | to the image, which is Width pixels wide and\r |
| 213 | Height pixels high. The string will be drawn onto\r |
| 214 | this image and EFI_HII_OUT_FLAG_CLIP is implied.\r |
| 215 | If this points to a NULL on entry, then a buffer\r |
| 216 | will be allocated to hold the generated image and\r |
| 217 | the pointer updated on exit. It is the caller's\r |
| 218 | responsibility to free this buffer.\r |
| 219 | \r |
| 220 | @param BltX, BltY Specifies the offset from the left and top\r |
| 221 | edge of the image of the first character\r |
| 222 | cell in the image.\r |
| 223 | \r |
| 224 | @param RowInfoArray If this is non-NULL on entry, then on\r |
| 225 | exit, this will point to an allocated buffer\r |
| 226 | containing row information and\r |
| 227 | RowInfoArraySize will be updated to contain\r |
| 228 | the number of elements. This array describes\r |
| 229 | the characters which were at least partially\r |
| 230 | drawn and the heights of the rows. It is the\r |
| 231 | caller's responsibility to free this buffer.\r |
| 232 | \r |
| 233 | @param RowInfoArraySize If this is non-NULL on entry, then on\r |
| 234 | exit it contains the number of\r |
| 235 | elements in RowInfoArray.\r |
| 236 | \r |
| 237 | @param ColumnInfoArray If this is non-NULL, then on return it\r |
| 238 | will be filled with the horizontal\r |
| 239 | offset for each character in the\r |
| 240 | string on the row where it is\r |
| 241 | displayed. Non-printing characters\r |
| 242 | will have the offset ~0. The caller is\r |
| 243 | responsible to allocate a buffer large\r |
| 244 | enough so that there is one entry for\r |
| 245 | each character in the string, not\r |
| 246 | including the null-terminator. It is\r |
| 247 | possible when character display is\r |
| 248 | normalized that some character cells\r |
| 249 | overlap.\r |
| 250 | \r |
| 251 | @retval EFI_SUCCESS The string was successfully updated.\r |
| 252 | \r |
| 253 | @retval EFI_OUT_OF_RESOURCES Unable to allocate an output\r |
| 254 | buffer for RowInfoArray or Blt.\r |
| 255 | \r |
| 54cf8780 |
256 | @retval EFI_INVALID_PARAMETER The String or Blt.\r |
| 257 | @retval EFI_INVALID_PARAMETER Flags were invalid combination..\r |
| d1f95000 |
258 | \r |
| d1f95000 |
259 | **/\r |
| 260 | typedef\r |
| 261 | EFI_STATUS\r |
| 8b13229b |
262 | (EFIAPI *EFI_HII_STRING_TO_IMAGE)(\r |
| d1f95000 |
263 | IN CONST EFI_HII_FONT_PROTOCOL *This,\r |
| 7d582d6b |
264 | IN EFI_HII_OUT_FLAGS Flags,\r |
| d1f95000 |
265 | IN CONST EFI_STRING String,\r |
| 266 | IN CONST EFI_FONT_DISPLAY_INFO *StringInfo,\r |
| 267 | IN OUT EFI_IMAGE_OUTPUT **Blt,\r |
| 7d582d6b |
268 | IN UINTN BltX,\r |
| 269 | IN UINTN BltY,\r |
| d1f95000 |
270 | OUT EFI_HII_ROW_INFO **RowInfoArray OPTIONAL,\r |
| 271 | OUT UINTN *RowInfoArraySize OPTIONAL,\r |
| 272 | OUT UINTN *ColumnInfoArray OPTIONAL\r |
| 273 | );\r |
| 274 | \r |
| 275 | \r |
| 276 | \r |
| 277 | /**\r |
| 278 | \r |
| 279 | This function renders a string as a bitmap or to the screen\r |
| 280 | and can clip or wrap the string. The bitmap is either supplied\r |
| 281 | by the caller or else is allocated by the function. The\r |
| 282 | strings are drawn with the font, size and style specified and\r |
| 283 | can be drawn transparently or opaquely. The function can also\r |
| 284 | return information about each row and each character's\r |
| 285 | position on the row. If EFI_HII_OUT_FLAG_CLIP is set, then\r |
| 286 | text will be formatted only based on explicit line breaks and\r |
| 287 | all pixels which would lie outside the bounding box specified\r |
| 288 | by Width and Height are ignored. The information in the\r |
| 289 | RowInfoArray only describes characters which are at least\r |
| 290 | partially displayed. For the final row, the LineHeight and\r |
| 291 | BaseLine may describe pixels which are outside the limit\r |
| 292 | specified by Height (unless EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is\r |
| 293 | specified) even though those pixels were not drawn. If\r |
| 294 | EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set, then it modifies the\r |
| 295 | behavior of EFI_HII_OUT_FLAG_CLIP so that if a character????s\r |
| 296 | right-most on pixel cannot fit, then it will not be drawn at\r |
| 297 | all. This flag requires that EFI_HII_OUT_FLAG_CLIP be set. If\r |
| 298 | EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is set, then it modifies the\r |
| 299 | behavior of EFI_HII_OUT_FLAG_CLIP so that if a row????s bottom\r |
| 300 | most pixel cannot fit, then it will not be drawn at all. This\r |
| 301 | flag requires that EFI_HII_OUT_FLAG_CLIP be set. Draft for\r |
| 302 | Review HII Protocols Version 2.1 November 3, 2006 1285 If\r |
| 303 | EFI_HII_OUT_FLAG_WRAP is set, then text will be wrapped at the\r |
| 304 | right-most line-break opportunity prior to a character whose\r |
| 305 | right-most extent would exceed Width. If no line-break\r |
| 306 | opportunity can be found, then the text will behave as if\r |
| 307 | EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set. This flag cannot be used\r |
| 308 | with EFI_HII_OUT_FLAG_CLIP_CLEAN_X. If\r |
| 309 | EFI_HII_OUT_FLAG_TRANSPARENT is set, then BackgroundColor is\r |
| ac644614 |
310 | ignored and all off" pixels in the character's glyph will\r |
| d1f95000 |
311 | use the pixel value from Blt. This flag cannot be used if Blt\r |
| 312 | is NULL upon entry. If EFI_HII_IGNORE_IF_NO_GLYPH is set, then\r |
| 313 | characters which have no glyphs are not drawn. Otherwise, they\r |
| 314 | are replaced with Unicode character 0xFFFD (REPLACEMENT\r |
| 315 | CHARACTER). If EFI_HII_IGNORE_LINE_BREAK is set, then explicit\r |
| 316 | line break characters will be ignored. If\r |
| 317 | EFI_HII_DIRECT_TO_SCREEN is set, then the string will be\r |
| 318 | written directly to the output device specified by Screen.\r |
| 319 | Otherwise the string will be rendered to the bitmap specified\r |
| 320 | by Bitmap.\r |
| 321 | \r |
| 322 | \r |
| 323 | @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r |
| 324 | \r |
| 325 | @param Flags Describes how the string is to be drawn.\r |
| 326 | \r |
| 327 | @param PackageList The package list in the HII database to\r |
| 328 | search for the specified string.\r |
| 329 | \r |
| 330 | @param StringId The string's id, which is unique within\r |
| 331 | PackageList.\r |
| 332 | \r |
| 333 | @param Language Points to the language for the retrieved\r |
| 334 | string. If NULL, then the current system\r |
| 335 | language is used.\r |
| 336 | \r |
| 337 | @param StringInfo Points to the string output information,\r |
| 338 | including the color and font. If NULL, then\r |
| 339 | the string will be output in the default\r |
| 340 | system font and color.\r |
| 341 | \r |
| 342 | @param Blt If this points to a non-NULL on entry, this points\r |
| 343 | to the image, which is Width pixels wide and\r |
| 344 | Height pixels high. The string will be drawn onto\r |
| 345 | this image and EFI_HII_OUT_FLAG_CLIP is implied.\r |
| 346 | If this points to a NULL on entry, then a buffer\r |
| 347 | will be allocated to hold the generated image and\r |
| 348 | the pointer updated on exit. It is the caller's\r |
| 349 | responsibility to free this buffer.\r |
| 350 | \r |
| 351 | @param BltX, BltY Specifies the offset from the left and top\r |
| 352 | edge of the output image of the first\r |
| 353 | character cell in the image.\r |
| 354 | \r |
| 355 | @param RowInfoArray If this is non-NULL on entry, then on\r |
| 356 | exit, this will point to an allocated\r |
| 357 | buffer containing row information and\r |
| 358 | RowInfoArraySize will be updated to\r |
| 359 | contain the number of elements. This array\r |
| 360 | describes the characters which were at\r |
| 361 | least partially drawn and the heights of\r |
| 362 | the rows. It is the caller's\r |
| 363 | responsibility to free this buffer.\r |
| 364 | \r |
| 365 | @param RowInfoArraySize If this is non-NULL on entry, then on\r |
| 366 | exit it contains the number of\r |
| 367 | elements in RowInfoArray.\r |
| 368 | \r |
| 369 | @param ColumnInfoArray If non-NULL, on return it is filled\r |
| 370 | with the horizontal offset for each\r |
| 371 | character in the string on the row\r |
| 372 | where it is displayed. Non-printing\r |
| 373 | characters will have the offset ~0.\r |
| 374 | The caller is responsible to allocate\r |
| 375 | a buffer large enough so that there is\r |
| 376 | one entry for each character in the\r |
| 377 | string, not including the\r |
| 378 | null-terminator. It is possible when\r |
| 379 | character display is normalized that\r |
| 380 | some character cells overlap.\r |
| 381 | \r |
| 382 | \r |
| 383 | @retval EFI_SUCCESS The string was successfully updated.\r |
| 384 | \r |
| 385 | @retval EFI_OUT_OF_RESOURCES Unable to allocate an output\r |
| 386 | buffer for RowInfoArray or Blt.\r |
| 387 | \r |
| 388 | @retval EFI_INVALID_PARAMETER The String or Blt or Height or\r |
| 389 | Width was NULL.\r |
| 54cf8780 |
390 | @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r |
| 391 | @retval EFI_INVALID_PARAMETER Flags were invalid combination.\r |
| 392 | @retval EFI_NOT_FOUND The specified PackageList is not in the Database or the stringid is not \r |
| 393 | in the specified PackageList. \r |
| d1f95000 |
394 | \r |
| 395 | **/\r |
| 396 | typedef\r |
| 397 | EFI_STATUS\r |
| 8b13229b |
398 | (EFIAPI *EFI_HII_STRING_ID_TO_IMAGE)(\r |
| d1f95000 |
399 | IN CONST EFI_HII_FONT_PROTOCOL *This,\r |
| 7d582d6b |
400 | IN EFI_HII_OUT_FLAGS Flags,\r |
| 401 | IN EFI_HII_HANDLE PackageList,\r |
| 402 | IN EFI_STRING_ID StringId,\r |
| d1f95000 |
403 | IN CONST CHAR8 *Language,\r |
| 404 | IN CONST EFI_FONT_DISPLAY_INFO *StringInfo OPTIONAL,\r |
| 405 | IN OUT EFI_IMAGE_OUTPUT **Blt,\r |
| 7d582d6b |
406 | IN UINTN BltX,\r |
| 407 | IN UINTN BltY,\r |
| d1f95000 |
408 | OUT EFI_HII_ROW_INFO **RowInfoArray OPTIONAL,\r |
| 409 | OUT UINTN *RowInfoArraySize OPTIONAL,\r |
| 410 | OUT UINTN *ColumnInfoArray OPTIONAL\r |
| 411 | );\r |
| 412 | \r |
| 413 | \r |
| 414 | /**\r |
| 415 | \r |
| 416 | Convert the glyph for a single character into a bitmap.\r |
| 417 | \r |
| 418 | @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r |
| 419 | \r |
| 420 | @param Char Character to retrieve.\r |
| 421 | \r |
| 422 | @param StringInfo Points to the string font and color\r |
| 423 | information or NULL if the string should use\r |
| 424 | the default system font and color.\r |
| 425 | \r |
| 426 | @param Blt Thus must point to a NULL on entry. A buffer will\r |
| 427 | be allocated to hold the output and the pointer\r |
| 428 | updated on exit. It is the caller's responsibility\r |
| 429 | to free this buffer.\r |
| 430 | \r |
| 431 | @param Baseline Number of pixels from the bottom of the bitmap\r |
| 432 | to the baseline.\r |
| 433 | \r |
| 434 | \r |
| 435 | @retval EFI_SUCCESS Glyph bitmap created.\r |
| 436 | \r |
| 437 | @retval EFI_OUT_OF_RESOURCES Unable to allocate the output\r |
| 438 | buffer Blt.\r |
| 439 | \r |
| 440 | @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was\r |
| 441 | replaced with the glyph for\r |
| 442 | Unicode character 0xFFFD.\r |
| 443 | \r |
| 444 | @retval EFI_INVALID_PARAMETER Blt is NULL or Width is NULL or\r |
| 445 | Height is NULL\r |
| 446 | \r |
| 447 | \r |
| 448 | **/\r |
| 449 | typedef\r |
| 450 | EFI_STATUS\r |
| 8b13229b |
451 | (EFIAPI *EFI_HII_GET_GLYPH)(\r |
| d1f95000 |
452 | IN CONST EFI_HII_FONT_PROTOCOL *This,\r |
| 453 | IN CONST CHAR16 Char,\r |
| 454 | IN CONST EFI_FONT_DISPLAY_INFO *StringInfo,\r |
| 455 | OUT EFI_IMAGE_OUTPUT **Blt,\r |
| 456 | OUT UINTN *Baseline OPTIONAL\r |
| 457 | );\r |
| 458 | \r |
| 459 | /**\r |
| 460 | \r |
| 461 | This function iterates through fonts which match the specified\r |
| 462 | font, using the specified criteria. If String is non-NULL, then\r |
| 463 | all of the characters in the string must exist in order for a\r |
| 464 | candidate font to be returned.\r |
| 465 | \r |
| 466 | @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r |
| 467 | \r |
| 468 | @param FontHandle On entry, points to the font handle returned\r |
| 469 | by a previous call to GetFontInfo() or NULL\r |
| 470 | to start with the first font. On return,\r |
| 471 | points to the returned font handle or points\r |
| 472 | to NULL if there are no more matching fonts.\r |
| 473 | \r |
| 474 | @param StringInfoIn Upon entry, points to the font to return\r |
| 54cf8780 |
475 | information about. If NULL, then the information about the system default \r |
| 476 | font will be returned.\r |
| d1f95000 |
477 | \r |
| 478 | @param StringInfoOut Upon return, contains the matching\r |
| 479 | font's information. If NULL, then no\r |
| 480 | information is returned.\r |
| 481 | \r |
| 482 | @param String Points to the string which will be tested to\r |
| 483 | determine if all characters are available. If\r |
| 484 | NULL, then any font is acceptable.\r |
| 485 | \r |
| 486 | @retval EFI_SUCCESS Matching font returned successfully.\r |
| 487 | \r |
| 488 | @retval EFI_NOT_FOUND No matching font was found.\r |
| 489 | \r |
| 54cf8780 |
490 | @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.\r |
| 491 | \r |
| 492 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the request.\r |
| d1f95000 |
493 | \r |
| 494 | **/\r |
| 495 | typedef\r |
| 496 | EFI_STATUS\r |
| 8b13229b |
497 | (EFIAPI *EFI_HII_GET_FONT_INFO)(\r |
| d1f95000 |
498 | IN CONST EFI_HII_FONT_PROTOCOL *This,\r |
| 499 | IN OUT EFI_FONT_HANDLE *FontHandle,\r |
| 54cf8780 |
500 | IN CONST EFI_FONT_DISPLAY_INFO *StringInfoIn, OPTIONAL\r |
| 5a1fc221 |
501 | OUT EFI_FONT_DISPLAY_INFO **StringInfoOut,\r |
| 502 | IN CONST EFI_STRING String OPTIONAL\r |
| d1f95000 |
503 | );\r |
| 504 | \r |
| 505 | /**\r |
| 506 | \r |
| 507 | The protocol provides the service to retrieve the font\r |
| 508 | informations;\r |
| 509 | \r |
| 510 | @param StringToImage Render a string to a bitmap or to the\r |
| 511 | display.\r |
| 512 | \r |
| 513 | @param StringIdToImage Render a string to a bitmap or to the\r |
| 514 | display.\r |
| 515 | @param GetGlyph Return a specific glyph in a specific font.\r |
| 516 | \r |
| 517 | @param GetFontInfo Return font information for a specific\r |
| 518 | font.\r |
| 519 | \r |
| 520 | **/\r |
| 521 | struct _EFI_HII_FONT_PROTOCOL {\r |
| 522 | EFI_HII_STRING_TO_IMAGE StringToImage;\r |
| 523 | EFI_HII_STRING_ID_TO_IMAGE StringIdToImage;\r |
| 524 | EFI_HII_GET_GLYPH GetGlyph;\r |
| 525 | EFI_HII_GET_FONT_INFO GetFontInfo;\r |
| 526 | };\r |
| 527 | \r |
| 528 | extern EFI_GUID gEfiHiiFontProtocolGuid;\r |
| 529 | \r |
| 530 | \r |
| 531 | #endif\r |
| 532 | \r |
projects / mirror_edk2.git / blame