4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The file provides services to retrieve font information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{ 0xe9ca4775, 0x8657, 0x47fc, { 0x97, 0xe7, 0x7e, 0xd6, 0x5a, 0x8, 0x43, 0x24 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_HII_FONT_PROTOCOL EFI_HII_FONT_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_HII_OUT_FLAGS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Definition of EFI_HII_ROW_INFO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The index of the first character in the string which is displayed on the line.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The index of the last character in the string which is displayed on the line.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If this is the same as StartIndex, then no characters are displayed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN LineHeight; ///< The height of the line, in pixels.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN LineWidth; ///< The width of the text on the line, in pixels.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of pixels above the bottom of the row of the font baseline or 0 if none.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Font info flag. All flags (FONT, SIZE, STYLE, and COLOR) are defined.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// They are defined as EFI_FONT_INFO_***
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_FONT_INFO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 FontSize; ///< character cell height in pixels
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Describes font output-related information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This structure is used for describing the way in which a string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync should be rendered in a particular font. FontInfo specifies the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync basic font information and ForegroundColor and BackgroundColor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specify the color in which they should be displayed. The flags
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in FontInfoMask describe where the system default should be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supplied instead of the specified information. The flags also
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync describe what options can be used to make a match between the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync font requested and the font available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function renders a string to a bitmap or the screen using
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the specified font, color and options. It either draws the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string and glyphs on an existing bitmap, allocates a new bitmap,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or uses the screen. The strings can be clipped or wrapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Optionally, the function also returns the information about each
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync row and the character position on that row. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_CLIP is set, then text will be formatted only
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync based on explicit line breaks and all pixels which would lie
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync outside the bounding box specified by Width and Height are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ignored. The information in the RowInfoArray only describes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync characters which are at least partially displayed. For the final
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync row, the LineHeight and BaseLine may describe pixels that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync outside the limit specified by Height (unless
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is specified) even though those
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pixels were not drawn. The LineWidth may describe pixels which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are outside the limit specified by Width (unless
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_CLIP_CLEAN_X is specified) even though those
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pixels were not drawn. If EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then it modifies the behavior of EFI_HII_OUT_FLAG_CLIP so that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if a character's right-most on pixel cannot fit, then it will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not be drawn at all. This flag requires that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_CLIP be set. If EFI_HII_OUT_FLAG_CLIP_CLEAN_Y
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is set, then it modifies the behavior of EFI_HII_OUT_FLAG_CLIP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync so that if a row's bottom-most pixel cannot fit, then it will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not be drawn at all. This flag requires that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_CLIP be set. If EFI_HII_OUT_FLAG_WRAP is set,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then text will be wrapped at the right-most line-break
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync opportunity prior to a character whose right-most extent would
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exceed Width. If no line-break opportunity can be found, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the text will behave as if EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This flag cannot be used with EFI_HII_OUT_FLAG_CLIP_CLEAN_X. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_TRANSPARENT is set, then BackgroundColor is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ignored and all 'off' pixels in the character's drawn
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will use the pixel value from Blt. This flag cannot be used if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Blt is NULL upon entry. If EFI_HII_IGNORE_IF_NO_GLYPH is set,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then characters which have no glyphs are not drawn. Otherwise,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync they are replaced with Unicode character code 0xFFFD (REPLACEMENT
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHARACTER). If EFI_HII_IGNORE_LINE_BREAK is set, then explicit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync line break characters will be ignored. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_DIRECT_TO_SCREEN is set, then the string will be written
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync directly to the output device specified by Screen. Otherwise the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string will be rendered to the bitmap specified by Bitmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Flags Describes how the string is to be drawn.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param String Points to the null-terminated string to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringInfo Points to the string output information,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync including the color and font. If NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the string will be output in the default
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system font and color.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Blt If this points to a non-NULL on entry, this points
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the image, which is Width pixels wide and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Height pixels high. The string will be drawn onto
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this image and EFI_HII_OUT_FLAG_CLIP is implied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this points to a NULL on entry, then a buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be allocated to hold the generated image and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the pointer updated on exit. It is the caller's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BltX, BltY Specifies the offset from the left and top
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync edge of the image of the first character
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cell in the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RowInfoArray If this is non-NULL on entry, then on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exit, this will point to an allocated buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync containing row information and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RowInfoArraySize will be updated to contain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the number of elements. This array describes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the characters that were at least partially
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync drawn and the heights of the rows. It is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync caller's responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RowInfoArraySize If this is non-NULL on entry, then on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exit it contains the number of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync elements in RowInfoArray.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ColumnInfoArray If this is non-NULL, then on return it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be filled with the horizontal
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync offset for each character in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string on the row where it is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync displayed. Non-printing characters
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will have the offset ~0. The caller is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync responsible for allocating a buffer large
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync enough so that there is one entry for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync each character in the string, not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync including the null-terminator. It is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync possible when character display is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync normalized that some character cells
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The string was successfully updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for RowInfoArray or Blt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The String or Blt was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Flags were invalid combination.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function renders a string as a bitmap or to the screen
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and can clip or wrap the string. The bitmap is either supplied
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the caller or allocated by the function. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync strings are drawn with the font, size and style specified and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync can be drawn transparently or opaquely. The function can also
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return information about each row and each character's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync position on the row. If EFI_HII_OUT_FLAG_CLIP is set, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync text will be formatted based only on explicit line breaks, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all pixels that would lie outside the bounding box specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by Width and Height are ignored. The information in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RowInfoArray only describes characters which are at least
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync partially displayed. For the final row, the LineHeight and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseLine may describe pixels which are outside the limit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Height (unless EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified) even though those pixels were not drawn. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set, then it modifies the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync behavior of EFI_HII_OUT_FLAG_CLIP so that if a character's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync right-most on pixel cannot fit, then it will not be drawn at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all. This flag requires that EFI_HII_OUT_FLAG_CLIP be set. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is set, then it modifies the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync behavior of EFI_HII_OUT_FLAG_CLIP so that if a row's bottom
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync most pixel cannot fit, then it will not be drawn at all. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync flag requires that EFI_HII_OUT_FLAG_CLIP be set. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_WRAP is set, then text will be wrapped at the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync right-most line-break opportunity prior to a character whose
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync right-most extent would exceed Width. If no line-break
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync opportunity can be found, then the text will behave as if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set. This flag cannot be used
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with EFI_HII_OUT_FLAG_CLIP_CLEAN_X. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_TRANSPARENT is set, then BackgroundColor is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ignored and all off" pixels in the character's glyph will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync use the pixel value from Blt. This flag cannot be used if Blt
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is NULL upon entry. If EFI_HII_IGNORE_IF_NO_GLYPH is set, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync characters which have no glyphs are not drawn. Otherwise, they
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are replaced with Unicode character code 0xFFFD (REPLACEMENT
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHARACTER). If EFI_HII_IGNORE_LINE_BREAK is set, then explicit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync line break characters will be ignored. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_DIRECT_TO_SCREEN is set, then the string will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync written directly to the output device specified by Screen.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Otherwise the string will be rendered to the bitmap specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Flags Describes how the string is to be drawn.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The package list in the HII database to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync search for the specified string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringId The string's id, which is unique within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Language Points to the language for the retrieved
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string. If NULL, then the current system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync language is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringInfo Points to the string output information,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync including the color and font. If NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the string will be output in the default
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system font and color.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Blt If this points to a non-NULL on entry, this points
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the image, which is Width pixels wide and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Height pixels high. The string will be drawn onto
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this image and EFI_HII_OUT_FLAG_CLIP is implied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this points to a NULL on entry, then a buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be allocated to hold the generated image and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the pointer updated on exit. It is the caller's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BltX, BltY Specifies the offset from the left and top
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync edge of the output image of the first
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync character cell in the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RowInfoArray If this is non-NULL on entry, then on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exit, this will point to an allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer containing row information and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RowInfoArraySize will be updated to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contain the number of elements. This array
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync describes the characters which were at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync least partially drawn and the heights of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the rows. It is the caller's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RowInfoArraySize If this is non-NULL on entry, then on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exit it contains the number of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync elements in RowInfoArray.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ColumnInfoArray If non-NULL, on return it is filled
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the horizontal offset for each
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync character in the string on the row
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync where it is displayed. Non-printing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync characters will have the offset ~0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The caller is responsible to allocate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a buffer large enough so that there is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync one entry for each character in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string, not including the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync null-terminator. It is possible when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync character display is normalized that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync some character cells overlap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The string was successfully updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate an output
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer for RowInfoArray or Blt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The String, or Blt, or Height, or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Width was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Flags were invalid combination.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified PackageList is not in the Database,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or the stringid is not in the specified PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_FONT_DISPLAY_INFO *StringInfo OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert the glyph for a single character into a bitmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Char The character to retrieve.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringInfo Points to the string font and color
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information or NULL if the string should use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the default system font and color.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Blt This must point to a NULL on entry. A buffer will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be allocated to hold the output and the pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync updated on exit. It is the caller's responsibility
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Baseline The number of pixels from the bottom of the bitmap
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the baseline.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The glyph bitmap created.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync replaced with the glyph for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Unicode character code 0xFFFD.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Blt is NULL, or Width is NULL, or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Height is NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function iterates through fonts which match the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync font, using the specified criteria. If String is non-NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all of the characters in the string must exist in order for a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync candidate font to be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FontHandle On entry, points to the font handle returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by a previous call to GetFontInfo() or NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to start with the first font. On return,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync points to the returned font handle or points
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to NULL if there are no more matching fonts.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringInfoIn Upon entry, points to the font to return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information about. If NULL, then the information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync about the system default font will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringInfoOut Upon return, contains the matching
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync font's information. If NULL, then no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param String Points to the string which will be tested to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync determine if all characters are available. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL, then any font is acceptable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Matching font returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No matching font was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_FONT_DISPLAY_INFO *StringInfoIn, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The protocol provides the service to retrieve the font informations.