SetupDesignGuide.pdf - Firmware Encoding Index

Setup Design Guide
DRAFT
7.1.5 EFI_HII_PROTOCOL.GetGlyph()
Summary
Translates a Unicode character into the corresponding font glyph.
Prototype
EFI_STATUS
(EFIAPI *EFI_HII_GET_GLYPH) (
IN EFI_HII_PROTOCOL *This,
IN CHAR16 *Source,
IN OUT UINT16
*Index,
OUT UINT8 *GlyphBuffer,
OUT UINT16 *BitWidth,
IN OUT UINT32
*InternalStatus
);
Parameters
This
Source
Index
GlyphBuffer
BitWidth
InternalStatus
A pointer to the EFI_HII_PROTOCOL instance.
A pointer to a Unicode string.
On input, the offset into the string to fetch the character from. On
successful completion, the index is updated to the first character past
the character(s) making up the just extracted glyph.
Pointer to an array where the glyphs corresponding to the characters
in the Source may be stored. GlyphBuffer is assumed to be wide
enough to accept a wide glyph character.
If EFI_SUCCESS was returned, the UINT16 pointed to by this
value is filled with the length of the glyph in pixels. Unchanged if
the call was unsuccessful.
To save the time required to read the string from the beginning on
each glyph extraction (to ensure that e.g. the narrow versus wide
glyph mode is correct), this value is updated each time the function is
called with status local to the call. The cell pointed to by this
parameter must be initialized to 0 prior to invoking the call the first
time for any string.
Description
The data returned is the format required for input to the UGA BLT routines.
Status Codes Returned
EFI_SUCCESS
It worked.
EFI_NOT_FOUND
A glyph for a character was not found.
56