[mirror_edk2.git] / MdePkg / Include / Protocol / HiiImage.h

/** @file\r
  The file provides services to access to images in the images database.\r
  \r
  Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef __HII_IMAGE_H__\r
#define __HII_IMAGE_H__\r
\r
#include <Protocol/GraphicsOutput.h>\r
\r
#define EFI_HII_IMAGE_PROTOCOL_GUID \\r
  { 0x31a6406a, 0x6bdf, 0x4e46, { 0xb2, 0xa2, 0xeb, 0xaa, 0x89, 0xc4, 0x9, 0x20 } }\r
\r
typedef struct _EFI_HII_IMAGE_PROTOCOL EFI_HII_IMAGE_PROTOCOL;\r
\r
\r
///\r
/// Flags in EFI_IMAGE_INPUT\r
/// \r
#define EFI_IMAGE_TRANSPARENT 0x00000001\r
\r
/**\r
   \r
  Definition of EFI_IMAGE_INPUT.\r
   \r
  @param Flags  Describe image characteristics. If\r
                EFI_IMAGE_TRANSPARENT is set, then the image was\r
                designed for transparent display.\r
\r
  @param Width  Image width, in pixels. \r
\r
  @param Height Image height, in pixels.\r
\r
  @param Bitmap A pointer to the actual bitmap, organized left-to-right,\r
                top-to-bottom. The size of the bitmap is\r
                Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL).\r
\r
   \r
**/\r
typedef struct _EFI_IMAGE_INPUT {\r
  UINT32                          Flags;\r
  UINT16                          Width;\r
  UINT16                          Height;\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL   *Bitmap;\r
} EFI_IMAGE_INPUT;\r
\r
\r
/**\r
\r
  This function adds the image Image to the group of images\r
  owned by PackageList, and returns a new image identifier\r
  (ImageId).\r
\r
  @param This        A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
  \r
  @param PackageList Handle of the package list where this image will be added.\r
\r
  @param ImageId     On return, contains the new image id, which is\r
                     unique within PackageList.\r
\r
  @param Image       Points to the image.\r
\r
  @retval EFI_SUCCESS             The new image was added\r
                                  successfully\r
  \r
  @retval EFI_OUT_OF_RESOURCES    Could not add the image.\r
  \r
  @retval EFI_INVALID_PARAMETER   Image is NULL or ImageId is\r
                                  NULL.\r
\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_NEW_IMAGE)(\r
  IN CONST  EFI_HII_IMAGE_PROTOCOL  *This,\r
  IN        EFI_HII_HANDLE          PackageList,\r
  OUT       EFI_IMAGE_ID            *ImageId,\r
  IN CONST  EFI_IMAGE_INPUT         *Image\r
);\r
\r
/**\r
\r
  This function retrieves the image specified by ImageId which\r
  is associated with the specified PackageList and copies it\r
  into the buffer specified by Image. If the image specified by\r
  ImageId is not present in the specified PackageList, then\r
  EFI_NOT_FOUND is returned. If the buffer specified by\r
  ImageSize is too small to hold the image, then\r
  EFI_BUFFER_TOO_SMALL will be returned. ImageSize will be\r
  updated to the size of buffer actually required to hold the\r
  image.\r
\r
  @param This         A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
  \r
  @param PackageList  The package list in the HII database to\r
                      search for the specified image.\r
  \r
  @param ImageId      The image's id, which is unique within\r
                      PackageList.\r
  \r
  @param Image        Points to the new image.\r
  \r
  @retval EFI_SUCCESS            The image was returned successfully.\r
\r
  @retval EFI_NOT_FOUND          The image specified by ImageId is not\r
                                 available. Or The specified PackageList is not in the database.\r
  \r
  @retval EFI_INVALID_PARAMETER  The Image or Langugae was NULL.\r
  @retval EFI_OUT_OF_RESOURCES   The bitmap could not be retrieved because there was not\r
                                 enough memory.\r
\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_GET_IMAGE)(\r
  IN CONST  EFI_HII_IMAGE_PROTOCOL  *This,\r
  IN        EFI_HII_HANDLE          PackageList,\r
  IN        EFI_IMAGE_ID            ImageId,\r
  OUT       EFI_IMAGE_INPUT         *Image\r
);\r
\r
/**\r
   \r
  This function updates the image specified by ImageId in the\r
  specified PackageListHandle to the image specified by Image.\r
\r
\r
  @param This         A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
\r
  @param PackageList  The package list containing the images.\r
\r
  @param ImageId      The image id, which is unique within PackageList.\r
\r
  @param Image        Points to the image.\r
\r
  @retval EFI_SUCCESS           The image was successfully updated.\r
  \r
  @retval EFI_NOT_FOUND         The image specified by ImageId is not in the database.\r
                                The specified PackageList is not in the database. \r
  \r
  @retval EFI_INVALID_PARAMETER The Image or Language was NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_SET_IMAGE)(\r
  IN CONST  EFI_HII_IMAGE_PROTOCOL  *This,\r
  IN        EFI_HII_HANDLE          PackageList,\r
  IN        EFI_IMAGE_ID            ImageId,\r
  IN CONST  EFI_IMAGE_INPUT         *Image\r
);\r
\r
\r
///\r
/// EFI_HII_DRAW_FLAGS describes how the image is to be drawn.\r
/// These flags are defined as EFI_HII_DRAW_FLAG_***\r
///\r
typedef UINT32  EFI_HII_DRAW_FLAGS;\r
\r
#define EFI_HII_DRAW_FLAG_CLIP          0x00000001\r
#define EFI_HII_DRAW_FLAG_TRANSPARENT   0x00000030\r
#define EFI_HII_DRAW_FLAG_DEFAULT       0x00000000\r
#define EFI_HII_DRAW_FLAG_FORCE_TRANS   0x00000010\r
#define EFI_HII_DRAW_FLAG_FORCE_OPAQUE  0x00000020\r
#define EFI_HII_DIRECT_TO_SCREEN        0x00000080\r
\r
/**\r
   \r
  Definition of EFI_IMAGE_OUTPUT.\r
   \r
  @param Width  Width of the output image.\r
\r
  @param Height Height of the output image.\r
\r
  @param Bitmap Points to the output bitmap.\r
\r
  @param Screen Points to the EFI_GRAPHICS_OUTPUT_PROTOCOL which\r
                describes the screen on which to draw the\r
                specified image.\r
\r
**/\r
typedef struct _EFI_IMAGE_OUTPUT {\r
  UINT16  Width;\r
  UINT16  Height;\r
  union {\r
    EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Bitmap;\r
    EFI_GRAPHICS_OUTPUT_PROTOCOL  *Screen;\r
  } Image;\r
} EFI_IMAGE_OUTPUT;\r
\r
\r
/**\r
   \r
  This function renders an image to a bitmap or the screen using\r
  the specified color and options. It draws the image on an\r
  existing bitmap, allocates a new bitmap or uses the screen. The\r
  images can be clipped. If EFI_HII_DRAW_FLAG_CLIP is set, then\r
  all pixels drawn outside the bounding box specified by Width and\r
  Height are ignored. If EFI_HII_DRAW_FLAG_TRANSPARENT is set,\r
  then all 'off' pixels in the images drawn will use the\r
  pixel value from Blt. This flag cannot be used if Blt is NULL\r
  upon entry. If EFI_HII_DIRECT_TO_SCREEN is set, then the image\r
  will be written directly to the output device specified by\r
  Screen. Otherwise the image will be rendered to the bitmap\r
  specified by Bitmap.\r
\r
\r
  @param This       A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
 \r
  @param Flags      Describes how the image is to be drawn.\r
                    EFI_HII_DRAW_FLAGS is defined in Related\r
                    Definitions, below.\r
  \r
  @param Image      Points to the image to be displayed. \r
  \r
  @param Blt        If this points to a non-NULL on entry, this points\r
                    to the image, which is Width pixels wide and\r
                    Height pixels high. The image will be drawn onto\r
                    this image and EFI_HII_DRAW_FLAG_CLIP is implied.\r
                    If this points to a NULL on entry, then a buffer\r
                    will be allocated to hold the generated image and\r
                    the pointer updated on exit. It is the caller's\r
                    responsibility to free this buffer.\r
\r
  @param BltX, BltY Specifies the offset from the left and top\r
                    edge of the image of the first pixel in\r
                    the image.\r
\r
  @retval EFI_SUCCESS           The image was successfully updated.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Unable to allocate an output\r
                                buffer for RowInfoArray or Blt.\r
\r
  @retval EFI_INVALID_PARAMETER The Image or Blt or Height or\r
                                Width was NULL.\r
\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_DRAW_IMAGE)(\r
  IN CONST  EFI_HII_IMAGE_PROTOCOL  *This,\r
  IN        EFI_HII_DRAW_FLAGS      Flags,\r
  IN CONST  EFI_IMAGE_INPUT         *Image,\r
  IN OUT    EFI_IMAGE_OUTPUT        **Blt,\r
  IN        UINTN                   BltX,\r
  IN        UINTN                   BltY\r
);\r
\r
/**\r
   \r
  This function renders an image as a bitmap or to the screen and\r
  can clip the image. The bitmap is either supplied by the caller\r
  or else is allocated by the function. The images can be drawn\r
  transparently or opaquely. If EFI_HII_DRAW_FLAG_CLIP is set,\r
  then all pixels drawn outside the bounding box specified by\r
  Width and Height are ignored. If EFI_HII_DRAW_FLAG_TRANSPARENT\r
  is set, then all "off" pixels in the character's glyph will\r
  use the pixel value from Blt. This flag cannot be used if Blt\r
  is NULL upon entry. If EFI_HII_DIRECT_TO_SCREEN is set, then\r
  the image will be written directly to the output device\r
  specified by Screen. Otherwise the image will be rendered to\r
  the bitmap specified by Bitmap.\r
  This function renders an image to a bitmap or the screen using\r
  the specified color and options. It draws the image on an\r
  existing bitmap, allocates a new bitmap or uses the screen. The\r
  images can be clipped. If EFI_HII_DRAW_FLAG_CLIP is set, then\r
  all pixels drawn outside the bounding box specified by Width and\r
  Height are ignored. The EFI_HII_DRAW_FLAG_TRANSPARENT flag\r
  determines whether the image will be drawn transparent or\r
  opaque. If EFI_HII_DRAW_FLAG_FORCE_TRANS is set, then the image\r
  will be drawn so that all 'off' pixels in the image will\r
  be drawn using the pixel value from Blt and all other pixels\r
  will be copied. If EFI_HII_DRAW_FLAG_FORCE_OPAQUE is set, then\r
  the image's pixels will be copied directly to the\r
  destination. If EFI_HII_DRAW_FLAG_DEFAULT is set, then the image\r
  will be drawn transparently or opaque, depending on the\r
  image's transparency setting (see EFI_IMAGE_TRANSPARENT).\r
  Images cannot be drawn transparently if Blt is NULL. If\r
  EFI_HII_DIRECT_TO_SCREEN is set, then the image will be written\r
  directly to the output device specified by Screen. Otherwise the\r
  image will be rendered to the bitmap specified by Bitmap.\r
\r
  @param This         A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
\r
  @param Flags        Describes how the image is to be drawn.\r
\r
  @param PackageList  The package list in the HII database to\r
                      search for the specified image.\r
\r
  @param ImageId      The image's id, which is unique within PackageList.\r
\r
  @param Blt          If this points to a non-NULL on entry, this points\r
                      to the image, which is Width pixels wide and\r
                      Height pixels high. The image will be drawn onto\r
                      this image and EFI_HII_DRAW_FLAG_CLIP is implied.\r
                      If this points to a NULL on entry, then a buffer\r
                      will be allocated to hold the generated image and\r
                      the pointer updated on exit. It is the caller's\r
                      responsibility to free this buffer.\r
\r
  @param BltX, BltY   Specifies the offset from the left and top\r
                      edge of the output image of the first\r
                      pixel in the image.\r
\r
  @retval EFI_SUCCESS           The image was successfully updated.\r
  \r
  @retval EFI_OUT_OF_RESOURCES  Unable to allocate an output\r
                                buffer for RowInfoArray or Blt.\r
  \r
  @retval EFI_NOT_FOUND         The image specified by ImageId is not in the database. \r
                                Or The specified PackageList is not in the database.                            \r
  \r
  @retval EFI_INVALID_PARAMETER The Blt was NULL.    \r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_DRAW_IMAGE_ID)(\r
IN CONST  EFI_HII_IMAGE_PROTOCOL  *This,\r
IN        EFI_HII_DRAW_FLAGS      Flags,\r
IN        EFI_HII_HANDLE          PackageList,\r
IN        EFI_IMAGE_ID            ImageId,\r
IN OUT    EFI_IMAGE_OUTPUT        **Blt,\r
IN        UINTN                   BltX,\r
IN        UINTN                   BltY\r
);\r
\r
\r
///\r
/// Services to access to images in the images database.\r
///\r
struct _EFI_HII_IMAGE_PROTOCOL {\r
  EFI_HII_NEW_IMAGE     NewImage;\r
  EFI_HII_GET_IMAGE     GetImage;\r
  EFI_HII_SET_IMAGE     SetImage;\r
  EFI_HII_DRAW_IMAGE    DrawImage;\r
  EFI_HII_DRAW_IMAGE_ID DrawImageId;\r
};\r
\r
extern EFI_GUID gEfiHiiImageProtocolGuid;\r
\r
#endif\r
\r
\r
Commit	Line	Data
d1f95000	1	/** @file\r
	2	The file provides services to access to images in the images database.\r
	3	\r
8ba83963	4	Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
9df063a0	5	This program and the accompanying materials \r
d1f95000	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
d1f95000	13	**/\r
	14	\r
	15	#ifndef __HII_IMAGE_H__\r
	16	#define __HII_IMAGE_H__\r
	17	\r
8ba83963 RN	18	#include <Protocol/GraphicsOutput.h>\r
8ba83963 RN	19	\r
d1f95000	20	#define EFI_HII_IMAGE_PROTOCOL_GUID \\r
	21	{ 0x31a6406a, 0x6bdf, 0x4e46, { 0xb2, 0xa2, 0xeb, 0xaa, 0x89, 0xc4, 0x9, 0x20 } }\r
	22	\r
	23	typedef struct _EFI_HII_IMAGE_PROTOCOL EFI_HII_IMAGE_PROTOCOL;\r
	24	\r
	25	\r
99e8ed21	26	///\r
	27	/// Flags in EFI_IMAGE_INPUT\r
	28	/// \r
d1f95000	29	#define EFI_IMAGE_TRANSPARENT 0x00000001\r
	30	\r
	31	/**\r
	32	\r
	33	Definition of EFI_IMAGE_INPUT.\r
	34	\r
	35	@param Flags Describe image characteristics. If\r
	36	EFI_IMAGE_TRANSPARENT is set, then the image was\r
	37	designed for transparent display.\r
	38	\r
	39	@param Width Image width, in pixels. \r
	40	\r
	41	@param Height Image height, in pixels.\r
	42	\r
11ca63ec	43	@param Bitmap A pointer to the actual bitmap, organized left-to-right,\r
d1f95000	44	top-to-bottom. The size of the bitmap is\r
	45	WidthHeightsizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL).\r
	46	\r
	47	\r
	48	**/\r
	49	typedef struct _EFI_IMAGE_INPUT {\r
7d582d6b	50	UINT32 Flags;\r
	51	UINT16 Width;\r
	52	UINT16 Height;\r
54cf8780	53	EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Bitmap;\r
d1f95000	54	} EFI_IMAGE_INPUT;\r
	55	\r
	56	\r
	57	/**\r
	58	\r
	59	This function adds the image Image to the group of images\r
	60	owned by PackageList, and returns a new image identifier\r
	61	(ImageId).\r
	62	\r
4ca9b6c4 LG	63	@param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
	64	\r
	65	@param PackageList Handle of the package list where this image will be added.\r
d1f95000	66	\r
4ca9b6c4 LG	67	@param ImageId On return, contains the new image id, which is\r
4ca9b6c4 LG	68	unique within PackageList.\r
d1f95000	69	\r
4ca9b6c4	70	@param Image Points to the image.\r
d1f95000	71	\r
	72	@retval EFI_SUCCESS The new image was added\r
	73	successfully\r
	74	\r
	75	@retval EFI_OUT_OF_RESOURCES Could not add the image.\r
	76	\r
	77	@retval EFI_INVALID_PARAMETER Image is NULL or ImageId is\r
	78	NULL.\r
	79	\r
	80	\r
	81	**/\r
	82	typedef\r
	83	EFI_STATUS\r
8b13229b	84	(EFIAPI *EFI_HII_NEW_IMAGE)(\r
d1f95000	85	IN CONST EFI_HII_IMAGE_PROTOCOL *This,\r
7d582d6b	86	IN EFI_HII_HANDLE PackageList,\r
d1f95000	87	OUT EFI_IMAGE_ID *ImageId,\r
	88	IN CONST EFI_IMAGE_INPUT *Image\r
	89	);\r
	90	\r
	91	/**\r
	92	\r
	93	This function retrieves the image specified by ImageId which\r
	94	is associated with the specified PackageList and copies it\r
	95	into the buffer specified by Image. If the image specified by\r
	96	ImageId is not present in the specified PackageList, then\r
	97	EFI_NOT_FOUND is returned. If the buffer specified by\r
	98	ImageSize is too small to hold the image, then\r
	99	EFI_BUFFER_TOO_SMALL will be returned. ImageSize will be\r
	100	updated to the size of buffer actually required to hold the\r
	101	image.\r
	102	\r
4ca9b6c4	103	@param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
d1f95000	104	\r
	105	@param PackageList The package list in the HII database to\r
	106	search for the specified image.\r
	107	\r
4ca9b6c4 LG	108	@param ImageId The image's id, which is unique within\r
4ca9b6c4 LG	109	PackageList.\r
d1f95000	110	\r
4ca9b6c4	111	@param Image Points to the new image.\r
d1f95000	112	\r
4ca9b6c4 LG	113	@retval EFI_SUCCESS The image was returned successfully.\r
	114	\r
	115	@retval EFI_NOT_FOUND The image specified by ImageId is not\r
	116	available. Or The specified PackageList is not in the database.\r
d1f95000	117	\r
4ca9b6c4	118	@retval EFI_INVALID_PARAMETER The Image or Langugae was NULL.\r
54cf8780	119	@retval EFI_OUT_OF_RESOURCES The bitmap could not be retrieved because there was not\r
4ca9b6c4	120	enough memory.\r
d1f95000	121	\r
	122	\r
	123	**/\r
	124	typedef\r
	125	EFI_STATUS\r
8b13229b	126	(EFIAPI *EFI_HII_GET_IMAGE)(\r
d1f95000	127	IN CONST EFI_HII_IMAGE_PROTOCOL *This,\r
7d582d6b	128	IN EFI_HII_HANDLE PackageList,\r
7d582d6b	129	IN EFI_IMAGE_ID ImageId,\r
54cf8780	130	OUT EFI_IMAGE_INPUT *Image\r
d1f95000	131	);\r
	132	\r
	133	/**\r
	134	\r
	135	This function updates the image specified by ImageId in the\r
	136	specified PackageListHandle to the image specified by Image.\r
	137	\r
	138	\r
4ca9b6c4	139	@param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
d1f95000	140	\r
	141	@param PackageList The package list containing the images.\r
	142	\r
4ca9b6c4	143	@param ImageId The image id, which is unique within PackageList.\r
d1f95000	144	\r
4ca9b6c4	145	@param Image Points to the image.\r
d1f95000	146	\r
4ca9b6c4	147	@retval EFI_SUCCESS The image was successfully updated.\r
d1f95000	148	\r
4ca9b6c4 LG	149	@retval EFI_NOT_FOUND The image specified by ImageId is not in the database.\r
4ca9b6c4 LG	150	The specified PackageList is not in the database. \r
d1f95000	151	\r
4ca9b6c4	152	@retval EFI_INVALID_PARAMETER The Image or Language was NULL.\r
d1f95000	153	\r
	154	**/\r
	155	typedef\r
	156	EFI_STATUS\r
8b13229b	157	(EFIAPI *EFI_HII_SET_IMAGE)(\r
d1f95000	158	IN CONST EFI_HII_IMAGE_PROTOCOL *This,\r
7d582d6b	159	IN EFI_HII_HANDLE PackageList,\r
	160	IN EFI_IMAGE_ID ImageId,\r
	161	IN CONST EFI_IMAGE_INPUT *Image\r
d1f95000	162	);\r
	163	\r
	164	\r
992f22b9 LG	165	///\r
	166	/// EFI_HII_DRAW_FLAGS describes how the image is to be drawn.\r
	167	/// These flags are defined as EFI_HII_DRAW_FLAG_***\r
	168	///\r
d1f95000	169	typedef UINT32 EFI_HII_DRAW_FLAGS;\r
	170	\r
	171	#define EFI_HII_DRAW_FLAG_CLIP 0x00000001\r
	172	#define EFI_HII_DRAW_FLAG_TRANSPARENT 0x00000030\r
	173	#define EFI_HII_DRAW_FLAG_DEFAULT 0x00000000\r
54cf8780	174	#define EFI_HII_DRAW_FLAG_FORCE_TRANS 0x00000010\r
54cf8780	175	#define EFI_HII_DRAW_FLAG_FORCE_OPAQUE 0x00000020\r
d1f95000	176	#define EFI_HII_DIRECT_TO_SCREEN 0x00000080\r
d1f95000	177	\r
d1f95000	178	/**\r
	179	\r
	180	Definition of EFI_IMAGE_OUTPUT.\r
	181	\r
	182	@param Width Width of the output image.\r
	183	\r
	184	@param Height Height of the output image.\r
	185	\r
	186	@param Bitmap Points to the output bitmap.\r
	187	\r
	188	@param Screen Points to the EFI_GRAPHICS_OUTPUT_PROTOCOL which\r
	189	describes the screen on which to draw the\r
	190	specified image.\r
	191	\r
	192	**/\r
	193	typedef struct _EFI_IMAGE_OUTPUT {\r
	194	UINT16 Width;\r
	195	UINT16 Height;\r
	196	union {\r
	197	EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Bitmap;\r
	198	EFI_GRAPHICS_OUTPUT_PROTOCOL *Screen;\r
	199	} Image;\r
	200	} EFI_IMAGE_OUTPUT;\r
	201	\r
	202	\r
	203	/**\r
	204	\r
	205	This function renders an image to a bitmap or the screen using\r
	206	the specified color and options. It draws the image on an\r
	207	existing bitmap, allocates a new bitmap or uses the screen. The\r
	208	images can be clipped. If EFI_HII_DRAW_FLAG_CLIP is set, then\r
	209	all pixels drawn outside the bounding box specified by Width and\r
	210	Height are ignored. If EFI_HII_DRAW_FLAG_TRANSPARENT is set,\r
4ca9b6c4	211	then all 'off' pixels in the images drawn will use the\r
d1f95000	212	pixel value from Blt. This flag cannot be used if Blt is NULL\r
	213	upon entry. If EFI_HII_DIRECT_TO_SCREEN is set, then the image\r
	214	will be written directly to the output device specified by\r
	215	Screen. Otherwise the image will be rendered to the bitmap\r
	216	specified by Bitmap.\r
	217	\r
	218	\r
4ca9b6c4 LG	219	@param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
	220	\r
	221	@param Flags Describes how the image is to be drawn.\r
	222	EFI_HII_DRAW_FLAGS is defined in Related\r
	223	Definitions, below.\r
d1f95000	224	\r
4ca9b6c4	225	@param Image Points to the image to be displayed. \r
d1f95000	226	\r
4ca9b6c4 LG	227	@param Blt If this points to a non-NULL on entry, this points\r
	228	to the image, which is Width pixels wide and\r
	229	Height pixels high. The image will be drawn onto\r
	230	this image and EFI_HII_DRAW_FLAG_CLIP is implied.\r
	231	If this points to a NULL on entry, then a buffer\r
	232	will be allocated to hold the generated image and\r
	233	the pointer updated on exit. It is the caller's\r
	234	responsibility to free this buffer.\r
d1f95000	235	\r
4ca9b6c4 LG	236	@param BltX, BltY Specifies the offset from the left and top\r
	237	edge of the image of the first pixel in\r
	238	the image.\r
d1f95000	239	\r
4ca9b6c4	240	@retval EFI_SUCCESS The image was successfully updated.\r
d1f95000	241	\r
	242	@retval EFI_OUT_OF_RESOURCES Unable to allocate an output\r
	243	buffer for RowInfoArray or Blt.\r
	244	\r
	245	@retval EFI_INVALID_PARAMETER The Image or Blt or Height or\r
	246	Width was NULL.\r
	247	\r
	248	\r
	249	**/\r
	250	typedef\r
	251	EFI_STATUS\r
8b13229b	252	(EFIAPI *EFI_HII_DRAW_IMAGE)(\r
d1f95000	253	IN CONST EFI_HII_IMAGE_PROTOCOL *This,\r
7d582d6b	254	IN EFI_HII_DRAW_FLAGS Flags,\r
7d582d6b	255	IN CONST EFI_IMAGE_INPUT *Image,\r
d1f95000	256	IN OUT EFI_IMAGE_OUTPUT **Blt,\r
7d582d6b	257	IN UINTN BltX,\r
7d582d6b	258	IN UINTN BltY\r
d1f95000	259	);\r
	260	\r
	261	/**\r
	262	\r
	263	This function renders an image as a bitmap or to the screen and\r
	264	can clip the image. The bitmap is either supplied by the caller\r
	265	or else is allocated by the function. The images can be drawn\r
	266	transparently or opaquely. If EFI_HII_DRAW_FLAG_CLIP is set,\r
	267	then all pixels drawn outside the bounding box specified by\r
	268	Width and Height are ignored. If EFI_HII_DRAW_FLAG_TRANSPARENT\r
	269	is set, then all "off" pixels in the character's glyph will\r
	270	use the pixel value from Blt. This flag cannot be used if Blt\r
	271	is NULL upon entry. If EFI_HII_DIRECT_TO_SCREEN is set, then\r
	272	the image will be written directly to the output device\r
	273	specified by Screen. Otherwise the image will be rendered to\r
	274	the bitmap specified by Bitmap.\r
	275	This function renders an image to a bitmap or the screen using\r
	276	the specified color and options. It draws the image on an\r
	277	existing bitmap, allocates a new bitmap or uses the screen. The\r
	278	images can be clipped. If EFI_HII_DRAW_FLAG_CLIP is set, then\r
	279	all pixels drawn outside the bounding box specified by Width and\r
	280	Height are ignored. The EFI_HII_DRAW_FLAG_TRANSPARENT flag\r
	281	determines whether the image will be drawn transparent or\r
	282	opaque. If EFI_HII_DRAW_FLAG_FORCE_TRANS is set, then the image\r
4ca9b6c4	283	will be drawn so that all 'off' pixels in the image will\r
d1f95000	284	be drawn using the pixel value from Blt and all other pixels\r
d1f95000	285	will be copied. If EFI_HII_DRAW_FLAG_FORCE_OPAQUE is set, then\r
4ca9b6c4	286	the image's pixels will be copied directly to the\r
d1f95000	287	destination. If EFI_HII_DRAW_FLAG_DEFAULT is set, then the image\r
d1f95000	288	will be drawn transparently or opaque, depending on the\r
4ca9b6c4	289	image's transparency setting (see EFI_IMAGE_TRANSPARENT).\r
d1f95000	290	Images cannot be drawn transparently if Blt is NULL. If\r
	291	EFI_HII_DIRECT_TO_SCREEN is set, then the image will be written\r
	292	directly to the output device specified by Screen. Otherwise the\r
	293	image will be rendered to the bitmap specified by Bitmap.\r
	294	\r
4ca9b6c4	295	@param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
d1f95000	296	\r
4ca9b6c4	297	@param Flags Describes how the image is to be drawn.\r
d1f95000	298	\r
	299	@param PackageList The package list in the HII database to\r
	300	search for the specified image.\r
	301	\r
4ca9b6c4	302	@param ImageId The image's id, which is unique within PackageList.\r
d1f95000	303	\r
4ca9b6c4 LG	304	@param Blt If this points to a non-NULL on entry, this points\r
	305	to the image, which is Width pixels wide and\r
	306	Height pixels high. The image will be drawn onto\r
	307	this image and EFI_HII_DRAW_FLAG_CLIP is implied.\r
	308	If this points to a NULL on entry, then a buffer\r
	309	will be allocated to hold the generated image and\r
	310	the pointer updated on exit. It is the caller's\r
	311	responsibility to free this buffer.\r
d1f95000	312	\r
	313	@param BltX, BltY Specifies the offset from the left and top\r
	314	edge of the output image of the first\r
	315	pixel in the image.\r
	316	\r
4ca9b6c4	317	@retval EFI_SUCCESS The image was successfully updated.\r
d1f95000	318	\r
	319	@retval EFI_OUT_OF_RESOURCES Unable to allocate an output\r
	320	buffer for RowInfoArray or Blt.\r
	321	\r
4ca9b6c4 LG	322	@retval EFI_NOT_FOUND The image specified by ImageId is not in the database. \r
	323	Or The specified PackageList is not in the database. \r
	324	\r
	325	@retval EFI_INVALID_PARAMETER The Blt was NULL. \r
d1f95000	326	\r
	327	**/\r
	328	typedef\r
	329	EFI_STATUS\r
8b13229b	330	(EFIAPI *EFI_HII_DRAW_IMAGE_ID)(\r
d1f95000	331	IN CONST EFI_HII_IMAGE_PROTOCOL *This,\r
7d582d6b	332	IN EFI_HII_DRAW_FLAGS Flags,\r
	333	IN EFI_HII_HANDLE PackageList,\r
	334	IN EFI_IMAGE_ID ImageId,\r
d1f95000	335	IN OUT EFI_IMAGE_OUTPUT **Blt,\r
7d582d6b	336	IN UINTN BltX,\r
7d582d6b	337	IN UINTN BltY\r
d1f95000	338	);\r
	339	\r
	340	\r
44717a39	341	///\r
	342	/// Services to access to images in the images database.\r
	343	///\r
d1f95000	344	struct _EFI_HII_IMAGE_PROTOCOL {\r
	345	EFI_HII_NEW_IMAGE NewImage;\r
	346	EFI_HII_GET_IMAGE GetImage;\r
	347	EFI_HII_SET_IMAGE SetImage;\r
	348	EFI_HII_DRAW_IMAGE DrawImage;\r
	349	EFI_HII_DRAW_IMAGE_ID DrawImageId;\r
	350	};\r
	351	\r
	352	extern EFI_GUID gEfiHiiImageProtocolGuid;\r
	353	\r
	354	#endif\r
	355	\r
7d582d6b	356	\r