|
MdePkg[all]
1.08
|
|
MdePkg[all]
1.08
|
Data Structures | |
| struct | _EFI_IMAGE_INPUT |
| struct | _EFI_IMAGE_OUTPUT |
| struct | _EFI_HII_IMAGE_PROTOCOL |
Macros | |
| #define | EFI_HII_IMAGE_PROTOCOL_GUID { 0x31a6406a, 0x6bdf, 0x4e46, { 0xb2, 0xa2, 0xeb, 0xaa, 0x89, 0xc4, 0x9, 0x20 } } |
| #define | EFI_IMAGE_TRANSPARENT 0x00000001 |
| #define | EFI_HII_DRAW_FLAG_CLIP 0x00000001 |
| #define | EFI_HII_DRAW_FLAG_TRANSPARENT 0x00000030 |
| #define | EFI_HII_DRAW_FLAG_DEFAULT 0x00000000 |
| #define | EFI_HII_DRAW_FLAG_FORCE_TRANS 0x00000010 |
| #define | EFI_HII_DRAW_FLAG_FORCE_OPAQUE 0x00000020 |
| #define | EFI_HII_DIRECT_TO_SCREEN 0x00000080 |
Variables | |
| EFI_GUID | gEfiHiiImageProtocolGuid |
The file provides services to access to images in the images database.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
| #define EFI_HII_DIRECT_TO_SCREEN 0x00000080 |
| #define EFI_HII_DRAW_FLAG_CLIP 0x00000001 |
| #define EFI_HII_DRAW_FLAG_DEFAULT 0x00000000 |
| #define EFI_HII_DRAW_FLAG_FORCE_OPAQUE 0x00000020 |
| #define EFI_HII_DRAW_FLAG_FORCE_TRANS 0x00000010 |
| #define EFI_HII_DRAW_FLAG_TRANSPARENT 0x00000030 |
| #define EFI_HII_IMAGE_PROTOCOL_GUID { 0x31a6406a, 0x6bdf, 0x4e46, { 0xb2, 0xa2, 0xeb, 0xaa, 0x89, 0xc4, 0x9, 0x20 } } |
| #define EFI_IMAGE_TRANSPARENT 0x00000001 |
Flags in EFI_IMAGE_INPUT
| typedef UINT32 EFI_HII_DRAW_FLAGS |
EFI_HII_DRAW_FLAGS describes how the image is to be drawn. These flags are defined as EFI_HII_DRAW_FLAG_***
| typedef EFI_STATUS(EFIAPI * EFI_HII_DRAW_IMAGE)(IN CONST EFI_HII_IMAGE_PROTOCOL *This, IN EFI_HII_DRAW_FLAGS Flags, IN CONST EFI_IMAGE_INPUT *Image, IN OUT EFI_IMAGE_OUTPUT **Blt, IN UINTN BltX, IN UINTN BltY) |
This function renders an image to a bitmap or the screen using the specified color and options. It draws the image on an existing bitmap, allocates a new bitmap or uses the screen. The images can be clipped. If EFI_HII_DRAW_FLAG_CLIP is set, then all pixels drawn outside the bounding box specified by Width and Height are ignored. If EFI_HII_DRAW_FLAG_TRANSPARENT is set, then all 'off' pixels in the images drawn will use the pixel value from Blt. This flag cannot be used if Blt is NULL upon entry. If EFI_HII_DIRECT_TO_SCREEN is set, then the image will be written directly to the output device specified by Screen. Otherwise the image will be rendered to the bitmap specified by Bitmap.
| This | A pointer to the EFI_HII_IMAGE_PROTOCOL instance. |
| Flags | Describes how the image is to be drawn. EFI_HII_DRAW_FLAGS is defined in Related Definitions, below. |
| Image | Points to the image to be displayed. |
| Blt | If this points to a non-NULL on entry, this points to the image, which is Width pixels wide and Height pixels high. The image will be drawn onto this image and EFI_HII_DRAW_FLAG_CLIP is implied. If this points to a NULL on entry, then a buffer will be allocated to hold the generated image and the pointer updated on exit. It is the caller's responsibility to free this buffer. |
| BltX,BltY | Specifies the offset from the left and top edge of the image of the first pixel in the image. |
| EFI_SUCCESS | The image was successfully updated. |
| EFI_OUT_OF_RESOURCES | Unable to allocate an output buffer for RowInfoArray or Blt. |
| EFI_INVALID_PARAMETER | The Image or Blt or Height or Width was NULL. |
| typedef EFI_STATUS(EFIAPI * EFI_HII_DRAW_IMAGE_ID)(IN CONST EFI_HII_IMAGE_PROTOCOL *This, IN EFI_HII_DRAW_FLAGS Flags, IN EFI_HII_HANDLE PackageList, IN EFI_IMAGE_ID ImageId, IN OUT EFI_IMAGE_OUTPUT **Blt, IN UINTN BltX, IN UINTN BltY) |
This function renders an image as a bitmap or to the screen and can clip the image. The bitmap is either supplied by the caller or else is allocated by the function. The images can be drawn transparently or opaquely. If EFI_HII_DRAW_FLAG_CLIP is set, then all pixels drawn outside the bounding box specified by Width and Height are ignored. If EFI_HII_DRAW_FLAG_TRANSPARENT is set, then all "off" pixels in the character's glyph will use the pixel value from Blt. This flag cannot be used if Blt is NULL upon entry. If EFI_HII_DIRECT_TO_SCREEN is set, then the image will be written directly to the output device specified by Screen. Otherwise the image will be rendered to the bitmap specified by Bitmap. This function renders an image to a bitmap or the screen using the specified color and options. It draws the image on an existing bitmap, allocates a new bitmap or uses the screen. The images can be clipped. If EFI_HII_DRAW_FLAG_CLIP is set, then all pixels drawn outside the bounding box specified by Width and Height are ignored. The EFI_HII_DRAW_FLAG_TRANSPARENT flag determines whether the image will be drawn transparent or opaque. If EFI_HII_DRAW_FLAG_FORCE_TRANS is set, then the image will be drawn so that all 'off' pixels in the image will be drawn using the pixel value from Blt and all other pixels will be copied. If EFI_HII_DRAW_FLAG_FORCE_OPAQUE is set, then the image's pixels will be copied directly to the destination. If EFI_HII_DRAW_FLAG_DEFAULT is set, then the image will be drawn transparently or opaque, depending on the image's transparency setting (see EFI_IMAGE_TRANSPARENT). Images cannot be drawn transparently if Blt is NULL. If EFI_HII_DIRECT_TO_SCREEN is set, then the image will be written directly to the output device specified by Screen. Otherwise the image will be rendered to the bitmap specified by Bitmap.
| This | A pointer to the EFI_HII_IMAGE_PROTOCOL instance. |
| Flags | Describes how the image is to be drawn. |
| PackageList | The package list in the HII database to search for the specified image. |
| ImageId | The image's id, which is unique within PackageList. |
| Blt | If this points to a non-NULL on entry, this points to the image, which is Width pixels wide and Height pixels high. The image will be drawn onto this image and EFI_HII_DRAW_FLAG_CLIP is implied. If this points to a NULL on entry, then a buffer will be allocated to hold the generated image and the pointer updated on exit. It is the caller's responsibility to free this buffer. |
| BltX,BltY | Specifies the offset from the left and top edge of the output image of the first pixel in the image. |
| EFI_SUCCESS | The image was successfully updated. |
| EFI_OUT_OF_RESOURCES | Unable to allocate an output buffer for RowInfoArray or Blt. |
| EFI_NOT_FOUND | The image specified by ImageId is not in the database. Or The specified PackageList is not in the database. |
| EFI_INVALID_PARAMETER | The Blt was NULL. |
| typedef EFI_STATUS(EFIAPI * EFI_HII_GET_IMAGE)(IN CONST EFI_HII_IMAGE_PROTOCOL *This, IN EFI_HII_HANDLE PackageList, IN EFI_IMAGE_ID ImageId, OUT EFI_IMAGE_INPUT *Image) |
This function retrieves the image specified by ImageId which is associated with the specified PackageList and copies it into the buffer specified by Image. If the image specified by ImageId is not present in the specified PackageList, then EFI_NOT_FOUND is returned. If the buffer specified by ImageSize is too small to hold the image, then EFI_BUFFER_TOO_SMALL will be returned. ImageSize will be updated to the size of buffer actually required to hold the image.
| This | A pointer to the EFI_HII_IMAGE_PROTOCOL instance. |
| PackageList | The package list in the HII database to search for the specified image. |
| ImageId | The image's id, which is unique within PackageList. |
| Image | Points to the new image. |
| EFI_SUCCESS | The image was returned successfully. |
| EFI_NOT_FOUND | The image specified by ImageId is not available. Or The specified PackageList is not in the database. |
| EFI_INVALID_PARAMETER | The Image or Langugae was NULL. |
| EFI_OUT_OF_RESOURCES | The bitmap could not be retrieved because there was not enough memory. |
| typedef struct _EFI_HII_IMAGE_PROTOCOL EFI_HII_IMAGE_PROTOCOL |
| typedef EFI_STATUS(EFIAPI * EFI_HII_NEW_IMAGE)(IN CONST EFI_HII_IMAGE_PROTOCOL *This, IN EFI_HII_HANDLE PackageList, OUT EFI_IMAGE_ID *ImageId, IN CONST EFI_IMAGE_INPUT *Image) |
This function adds the image Image to the group of images owned by PackageList, and returns a new image identifier (ImageId).
| This | A pointer to the EFI_HII_IMAGE_PROTOCOL instance. |
| PackageList | Handle of the package list where this image will be added. |
| ImageId | On return, contains the new image id, which is unique within PackageList. |
| Image | Points to the image. |
| EFI_SUCCESS | The new image was added successfully |
| EFI_OUT_OF_RESOURCES | Could not add the image. |
| EFI_INVALID_PARAMETER | Image is NULL or ImageId is NULL. |
| typedef EFI_STATUS(EFIAPI * EFI_HII_SET_IMAGE)(IN CONST EFI_HII_IMAGE_PROTOCOL *This, IN EFI_HII_HANDLE PackageList, IN EFI_IMAGE_ID ImageId, IN CONST EFI_IMAGE_INPUT *Image) |
This function updates the image specified by ImageId in the specified PackageListHandle to the image specified by Image.
| This | A pointer to the EFI_HII_IMAGE_PROTOCOL instance. |
| PackageList | The package list containing the images. |
| ImageId | The image id, which is unique within PackageList. |
| Image | Points to the image. |
| EFI_SUCCESS | The image was successfully updated. |
| EFI_NOT_FOUND | The image specified by ImageId is not in the database. The specified PackageList is not in the database. |
| EFI_INVALID_PARAMETER | The Image or Language was NULL. |
| typedef struct _EFI_IMAGE_INPUT EFI_IMAGE_INPUT |
Definition of EFI_IMAGE_INPUT.
| Flags | Describe image characteristics. If EFI_IMAGE_TRANSPARENT is set, then the image was designed for transparent display. |
| Width | Image width, in pixels. |
| Height | Image height, in pixels. |
| Bitmap | A pointer to the actual bitmap, organized left-to-right, top-to-bottom. The size of the bitmap is Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL). |
| typedef struct _EFI_IMAGE_OUTPUT EFI_IMAGE_OUTPUT |
Definition of EFI_IMAGE_OUTPUT.
| Width | Width of the output image. |
| Height | Height of the output image. |
| Bitmap | Points to the output bitmap. |
| Screen | Points to the EFI_GRAPHICS_OUTPUT_PROTOCOL which describes the screen on which to draw the specified image. |
| EFI_GUID gEfiHiiImageProtocolGuid |
1.8.6 
