diff options
Diffstat (limited to 'MdePkg/Include/Protocol/HiiFont.h')
| -rw-r--r-- | MdePkg/Include/Protocol/HiiFont.h | 47 |
1 files changed, 22 insertions, 25 deletions
diff --git a/MdePkg/Include/Protocol/HiiFont.h b/MdePkg/Include/Protocol/HiiFont.h index b94073449611b..c229e394423d9 100644 --- a/MdePkg/Include/Protocol/HiiFont.h +++ b/MdePkg/Include/Protocol/HiiFont.h @@ -1,14 +1,11 @@ /** @file The file provides services to retrieve font information. - -Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> -This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. -The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent + + @par Revision Reference: + This Protocol was introduced in UEFI Specification 2.1. **/ @@ -27,7 +24,7 @@ typedef VOID *EFI_FONT_HANDLE; /// /// EFI_HII_OUT_FLAGS. -/// +/// typedef UINT32 EFI_HII_OUT_FLAGS; #define EFI_HII_OUT_FLAG_CLIP 0x00000001 @@ -49,12 +46,12 @@ typedef struct _EFI_HII_ROW_INFO { UINTN StartIndex; /// /// The index of the last character in the string which is displayed on the line. - /// If this is the same as StartIndex, then no characters are displayed. + /// If this is the same as StartIndex, then no characters are displayed. /// UINTN EndIndex; UINTN LineHeight; ///< The height of the line, in pixels. UINTN LineWidth; ///< The width of the text on the line, in pixels. - + /// /// The font baseline offset in pixels from the bottom of the row, or 0 if none. /// @@ -80,7 +77,7 @@ typedef UINT32 EFI_FONT_INFO_MASK; // // EFI_FONT_INFO -// +// typedef struct { EFI_HII_FONT_STYLE FontStyle; UINT16 FontSize; ///< character cell height in pixels @@ -103,7 +100,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO { EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor; EFI_GRAPHICS_OUTPUT_BLT_PIXEL BackgroundColor; EFI_FONT_INFO_MASK FontInfoMask; - EFI_FONT_INFO FontInfo; + EFI_FONT_INFO FontInfo; } EFI_FONT_DISPLAY_INFO; /** @@ -155,7 +152,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO { @param Flags Describes how the string is to be drawn. - @param String Points to the null-terminated string to be + @param String Points to the null-terminated string to be @param StringInfo Points to the string output information, including the color and font. If NULL, then @@ -203,9 +200,9 @@ typedef struct _EFI_FONT_DISPLAY_INFO { overlap. @retval EFI_SUCCESS The string was successfully updated. - + @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for RowInfoArray or Blt. - + @retval EFI_INVALID_PARAMETER The String or Blt was NULL. @retval EFI_INVALID_PARAMETER Flags were invalid combination. @@ -276,7 +273,7 @@ EFI_STATUS @param Flags Describes how the string is to be drawn. - @param PackageList + @param PackageList The package list in the HII database to search for the specified string. @@ -342,8 +339,8 @@ EFI_STATUS Width was NULL. @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL. @retval EFI_INVALID_PARAMETER Flags were invalid combination. - @retval EFI_NOT_FOUND The specified PackageList is not in the Database, - or the stringid is not in the specified PackageList. + @retval EFI_NOT_FOUND The specified PackageList is not in the Database, + or the stringid is not in the specified PackageList. **/ typedef @@ -424,26 +421,26 @@ EFI_STATUS to NULL if there are no more matching fonts. @param StringInfoIn Upon entry, points to the font to return - information about. If NULL, then the information + information about. If NULL, then the information about the system default font will be returned. @param StringInfoOut Upon return, contains the matching font's information. If NULL, then no information is returned. This buffer is allocated with a call to the Boot Service AllocatePool(). - It is the caller's responsibility to call the Boot + It is the caller's responsibility to call the Boot Service FreePool() when the caller no longer requires the contents of StringInfoOut. @param String Points to the string which will be tested to determine if all characters are available. If NULL, then any font is acceptable. - + @retval EFI_SUCCESS Matching font returned successfully. - + @retval EFI_NOT_FOUND No matching font was found. @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the request. - + **/ typedef EFI_STATUS |