#include "HiiDatabase.h"

Functions
EFI_STATUS EFIAPI	HiiNewImageEx (IN CONST EFI_HII_IMAGE_EX_PROTOCOL This, IN EFI_HII_HANDLE PackageList, OUT EFI_IMAGE_ID ImageId, IN CONST EFI_IMAGE_INPUT *Image)

EFI_STATUS EFIAPI	HiiGetImageEx (IN CONST EFI_HII_IMAGE_EX_PROTOCOL This, IN EFI_HII_HANDLE PackageList, IN EFI_IMAGE_ID ImageId, OUT EFI_IMAGE_INPUT Image)

EFI_STATUS EFIAPI	HiiSetImageEx (IN CONST EFI_HII_IMAGE_EX_PROTOCOL This, IN EFI_HII_HANDLE PackageList, IN EFI_IMAGE_ID ImageId, IN CONST EFI_IMAGE_INPUT Image)

EFI_STATUS EFIAPI	HiiDrawImageEx (IN CONST EFI_HII_IMAGE_EX_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)

EFI_STATUS EFIAPI	HiiDrawImageIdEx (IN CONST EFI_HII_IMAGE_EX_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)

EFI_HII_IMAGE_DECODER_PROTOCOL *	LocateHiiImageDecoder (UINT8 BlockType)

EFI_STATUS EFIAPI	HiiGetImageInfo (IN CONST EFI_HII_IMAGE_EX_PROTOCOL This, IN EFI_HII_HANDLE PackageList, IN EFI_IMAGE_ID ImageId, OUT EFI_IMAGE_OUTPUT Image)

Detailed Description

Implementation for EFI_HII_IMAGE_EX_PROTOCOL.

Copyright (c) 2016, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file ImageEx.c.

Function Documentation

◆ HiiDrawImageEx()

EFI_STATUS EFIAPI HiiDrawImageEx	(	IN CONST EFI_HII_IMAGE_EX_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
	)

Renders an image to a bitmap or to the display.

The prototype of this extension function is the same with EFI_HII_IMAGE_PROTOCOL.DrawImage(). This protocol invokes EFI_HII_IMAGE_PROTOCOL.DrawImage() implicitly.

Parameters

This	A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.
Flags	Describes how the image is to be drawn.
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	Specifies the offset from the left and top edge of the output image of the first pixel in the image.
BltY	Specifies the offset from the left and top edge of the output image of the first pixel in the image.

Return values

EFI_SUCCESS	The image was successfully drawn.
EFI_OUT_OF_RESOURCES	Unable to allocate an output buffer for Blt.
EFI_INVALID_PARAMETER	The Image or Blt was NULL.

Definition at line 147 of file ImageEx.c.

◆ HiiDrawImageIdEx()

EFI_STATUS EFIAPI HiiDrawImageIdEx	(	IN CONST EFI_HII_IMAGE_EX_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
	)

Renders an image to a bitmap or the screen containing the contents of the specified image.

This function is similar to EFI_HII_IMAGE_PROTOCOL.DrawImageId(). The difference is that this function will locate all EFI_HII_IMAGE_DECODER_PROTOCOL instances installed in the system if the decoder of the certain image type is not supported by the EFI_HII_IMAGE_EX_PROTOCOL. The function will attempt to decode the image to the EFI_IMAGE_INPUT using the first EFI_HII_IMAGE_DECODER_PROTOCOL instance that supports the requested image type.

Parameters

This	A pointer to the EFI_HII_IMAGE_EX_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	Specifies the offset from the left and top edge of the output image of the first pixel in the image.
BltY	Specifies the offset from the left and top edge of the output image of the first pixel in the image.

Return values

EFI_SUCCESS	The image was successfully drawn.
EFI_OUT_OF_RESOURCES	Unable to allocate an output buffer for Blt.
EFI_INVALID_PARAMETER	The Blt was NULL or ImageId was 0.
EFI_NOT_FOUND	The image specified by ImageId is not in the database. The specified PackageList is not in the database.

Definition at line 200 of file ImageEx.c.

◆ HiiGetImageEx()

EFI_STATUS EFIAPI HiiGetImageEx	(	IN CONST EFI_HII_IMAGE_EX_PROTOCOL *	This,
		IN EFI_HII_HANDLE	PackageList,
		IN EFI_IMAGE_ID	ImageId,
		OUT EFI_IMAGE_INPUT *	Image
	)

Return the information about the image, associated with the package list. The prototype of this extension function is the same with EFI_HII_IMAGE_PROTOCOL.GetImage().

This function is similar to EFI_HII_IMAGE_PROTOCOL.GetImage().The difference is that this function will locate all EFI_HII_IMAGE_DECODER_PROTOCOL instances installed in the system if the decoder of the certain image type is not supported by the EFI_HII_IMAGE_EX_PROTOCOL. The function will attempt to decode the image to the EFI_IMAGE_INPUT using the first EFI_HII_IMAGE_DECODER_PROTOCOL instance that supports the requested image type.

Parameters

This	A pointer to the EFI_HII_IMAGE_EX_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 image.

Return values

EFI_SUCCESS	The new image was returned successfully.
EFI_NOT_FOUND	The image specified by ImageId is not available. The specified PackageList is not in the Database.
EFI_INVALID_PARAMETER	Image was NULL or ImageId was 0.
EFI_OUT_OF_RESOURCES	The bitmap could not be retrieved because there was not enough memory.

Definition at line 70 of file ImageEx.c.

◆ HiiGetImageInfo()

EFI_STATUS EFIAPI HiiGetImageInfo	(	IN CONST EFI_HII_IMAGE_EX_PROTOCOL *	This,
		IN EFI_HII_HANDLE	PackageList,
		IN EFI_IMAGE_ID	ImageId,
		OUT EFI_IMAGE_OUTPUT *	Image
	)

This function returns the image information to EFI_IMAGE_OUTPUT. Only the width and height are returned to the EFI_IMAGE_OUTPUT instead of decoding the image to the buffer. This function is used to get the geometry of the image. This function will try to locate all of the EFI_HII_IMAGE_DECODER_PROTOCOL installed on the system if the decoder of image type is not supported by the EFI_HII_IMAGE_EX_PROTOCOL.

Parameters

This	A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.
PackageList	Handle of the package list where this image will be searched.
ImageId	The image's id, which is unique within PackageList.
Image	Points to the image.

Return values

EFI_SUCCESS	The new image was returned successfully.
EFI_NOT_FOUND	The image specified by ImageId is not in the database. The specified PackageList is not in the database.
EFI_BUFFER_TOO_SMALL	The buffer specified by ImageSize is too small to hold the image.
EFI_INVALID_PARAMETER	The Image was NULL or the ImageId was 0.
EFI_OUT_OF_RESOURCES	The bitmap could not be retrieved because there was not enough memory.

Definition at line 326 of file ImageEx.c.

◆ HiiNewImageEx()

EFI_STATUS EFIAPI HiiNewImageEx	(	IN CONST EFI_HII_IMAGE_EX_PROTOCOL *	This,
		IN EFI_HII_HANDLE	PackageList,
		OUT EFI_IMAGE_ID *	ImageId,
		IN CONST EFI_IMAGE_INPUT *	Image
	)

The prototype of this extension function is the same with EFI_HII_IMAGE_PROTOCOL.NewImage(). This protocol invokes EFI_HII_IMAGE_PROTOCOL.NewImage() implicitly.

Parameters

This	A pointer to the EFI_HII_IMAGE_EX_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.

Return values

EFI_SUCCESS	The new image was added successfully.
EFI_NOT_FOUND	The PackageList could not be found.
EFI_OUT_OF_RESOURCES	Could not add the image due to lack of resources.
EFI_INVALID_PARAMETER	Image is NULL or ImageId is NULL.

Definition at line 30 of file ImageEx.c.

◆ HiiSetImageEx()

EFI_STATUS EFIAPI HiiSetImageEx	(	IN CONST EFI_HII_IMAGE_EX_PROTOCOL *	This,
		IN EFI_HII_HANDLE	PackageList,
		IN EFI_IMAGE_ID	ImageId,
		IN CONST EFI_IMAGE_INPUT *	Image
	)

Change the information about the image.

Same with EFI_HII_IMAGE_PROTOCOL.SetImage(),this protocol invokes EFI_HII_IMAGE_PROTOCOL.SetImage()implicitly.

Parameters

This	A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.
PackageList	The package list containing the images.
ImageId	The image's id, which is unique within PackageList.
Image	Points to the image.

Return values

EFI_SUCCESS	The new 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 was NULL, the ImageId was 0 or the Image->Bitmap was NULL.

Definition at line 104 of file ImageEx.c.

◆ LocateHiiImageDecoder()

EFI_HII_IMAGE_DECODER_PROTOCOL * LocateHiiImageDecoder ( UINT8 BlockType )

Return the first HII image decoder instance which supports the DecoderName.

Parameters

BlockType The image block type.

Return values

Pointer to the HII image decoder instance.

Definition at line 247 of file ImageEx.c.

Functions

Detailed Description

Function Documentation

◆ HiiDrawImageEx()

◆ HiiDrawImageIdEx()

◆ HiiGetImageEx()

◆ HiiGetImageInfo()

◆ HiiNewImageEx()

◆ HiiSetImageEx()

◆ LocateHiiImageDecoder()