iPXE
Data Structures | Defines | Typedefs | Functions | Variables
HiiImage.h File Reference

The file provides services to access to images in the images database. More...

#include <ipxe/efi/Protocol/GraphicsOutput.h>

Go to the source code of this file.

Data Structures

struct  _EFI_IMAGE_INPUT
 Definition of EFI_IMAGE_INPUT. More...
struct  _EFI_IMAGE_OUTPUT
 Definition of EFI_IMAGE_OUTPUT. More...
struct  _EFI_HII_IMAGE_PROTOCOL
 Services to access to images in the images database. More...

Defines

#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.
#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

Typedefs

typedef struct
_EFI_HII_IMAGE_PROTOCOL 
EFI_HII_IMAGE_PROTOCOL
typedef struct _EFI_IMAGE_INPUT EFI_IMAGE_INPUT
 Definition of EFI_IMAGE_INPUT.
typedef EFI_STATUS(EFIAPIEFI_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).
typedef EFI_STATUS(EFIAPIEFI_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.
typedef EFI_STATUS(EFIAPIEFI_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.
typedef UINT32 EFI_HII_DRAW_FLAGS
 EFI_HII_DRAW_FLAGS describes how the image is to be drawn.
typedef struct _EFI_IMAGE_OUTPUT EFI_IMAGE_OUTPUT
 Definition of EFI_IMAGE_OUTPUT.
typedef EFI_STATUS(EFIAPIEFI_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.
typedef EFI_STATUS(EFIAPIEFI_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.

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiHiiImageProtocolGuid

Detailed Description

The file provides services to access to images in the images database.

Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which 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.

Definition in file HiiImage.h.


Define Documentation

#define EFI_HII_IMAGE_PROTOCOL_GUID   { 0x31a6406a, 0x6bdf, 0x4e46, { 0xb2, 0xa2, 0xeb, 0xaa, 0x89, 0xc4, 0x9, 0x20 } }

Definition at line 22 of file HiiImage.h.

#define EFI_IMAGE_TRANSPARENT   0x00000001

Flags in EFI_IMAGE_INPUT.

Definition at line 31 of file HiiImage.h.

#define EFI_HII_DRAW_FLAG_CLIP   0x00000001

Definition at line 173 of file HiiImage.h.

#define EFI_HII_DRAW_FLAG_TRANSPARENT   0x00000030

Definition at line 174 of file HiiImage.h.

#define EFI_HII_DRAW_FLAG_DEFAULT   0x00000000

Definition at line 175 of file HiiImage.h.

#define EFI_HII_DRAW_FLAG_FORCE_TRANS   0x00000010

Definition at line 176 of file HiiImage.h.

#define EFI_HII_DRAW_FLAG_FORCE_OPAQUE   0x00000020

Definition at line 177 of file HiiImage.h.

#define EFI_HII_DIRECT_TO_SCREEN   0x00000080

Definition at line 178 of file HiiImage.h.


Typedef Documentation

Definition at line 25 of file HiiImage.h.

Definition of EFI_IMAGE_INPUT.

Parameters:
FlagsDescribe image characteristics. If EFI_IMAGE_TRANSPARENT is set, then the image was designed for transparent display.
WidthImage width, in pixels.
HeightImage height, in pixels.
BitmapA 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).

This function adds the image Image to the group of images owned by PackageList, and returns a new image identifier (ImageId).

Parameters:
ThisA pointer to the EFI_HII_IMAGE_PROTOCOL instance.
PackageListHandle of the package list where this image will be added.
ImageIdOn return, contains the new image id, which is unique within PackageList.
ImagePoints to the image.
Return values:
EFI_SUCCESSThe new image was added successfully
EFI_OUT_OF_RESOURCESCould not add the image.
EFI_INVALID_PARAMETERImage is NULL or ImageId is NULL.

Definition at line 86 of file HiiImage.h.

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.

Parameters:
ThisA pointer to the EFI_HII_IMAGE_PROTOCOL instance.
PackageListThe package list in the HII database to search for the specified image.
ImageIdThe image's id, which is unique within PackageList.
ImagePoints to the new image.
Return values:
EFI_SUCCESSThe image was returned successfully.
EFI_NOT_FOUNDThe image specified by ImageId is not available. Or The specified PackageList is not in the database.
EFI_INVALID_PARAMETERThe Image or Langugae was NULL.
EFI_OUT_OF_RESOURCESThe bitmap could not be retrieved because there was not enough memory.

Definition at line 128 of file HiiImage.h.

This function updates the image specified by ImageId in the specified PackageListHandle to the image specified by Image.

Parameters:
ThisA pointer to the EFI_HII_IMAGE_PROTOCOL instance.
PackageListThe package list containing the images.
ImageIdThe image id, which is unique within PackageList.
ImagePoints to the image.
Return values:
EFI_SUCCESSThe image was successfully updated.
EFI_NOT_FOUNDThe image specified by ImageId is not in the database. The specified PackageList is not in the database.
EFI_INVALID_PARAMETERThe Image or Language was NULL.

Definition at line 159 of file HiiImage.h.

EFI_HII_DRAW_FLAGS describes how the image is to be drawn.

These flags are defined as EFI_HII_DRAW_FLAG_***

Definition at line 171 of file HiiImage.h.

Definition of EFI_IMAGE_OUTPUT.

Parameters:
WidthWidth of the output image.
HeightHeight of the output image.
BitmapPoints to the output bitmap.
ScreenPoints to the EFI_GRAPHICS_OUTPUT_PROTOCOL which describes the screen on which to draw the specified image.

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.

Parameters:
ThisA pointer to the EFI_HII_IMAGE_PROTOCOL instance.
FlagsDescribes how the image is to be drawn. EFI_HII_DRAW_FLAGS is defined in Related Definitions, below.
ImagePoints to the image to be displayed.
BltIf 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,BltYSpecifies the offset from the left and top edge of the image of the first pixel in the image.
Return values:
EFI_SUCCESSThe image was successfully updated.
EFI_OUT_OF_RESOURCESUnable to allocate an output buffer for RowInfoArray or Blt.
EFI_INVALID_PARAMETERThe Image or Blt or Height or Width was NULL.

Definition at line 254 of file HiiImage.h.

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.

Parameters:
ThisA pointer to the EFI_HII_IMAGE_PROTOCOL instance.
FlagsDescribes how the image is to be drawn.
PackageListThe package list in the HII database to search for the specified image.
ImageIdThe image's id, which is unique within PackageList.
BltIf 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,BltYSpecifies the offset from the left and top edge of the output image of the first pixel in the image.
Return values:
EFI_SUCCESSThe image was successfully updated.
EFI_OUT_OF_RESOURCESUnable to allocate an output buffer for RowInfoArray or Blt.
EFI_NOT_FOUNDThe image specified by ImageId is not in the database. Or The specified PackageList is not in the database.
EFI_INVALID_PARAMETERThe Blt was NULL.

Definition at line 332 of file HiiImage.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation