/** @file\r
The file provides services to access to images in the images database.\r
- \r
- Copyright (c) 2006 - 2008, Intel Corporation\r
- All rights reserved. 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
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+ @par Revision Reference:\r
+ This Protocol was introduced in UEFI Specification 2.1.\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
+///\r
+/// Flags in EFI_IMAGE_INPUT\r
+///\r
#define EFI_IMAGE_TRANSPARENT 0x00000001\r
\r
/**\r
- \r
+\r
Definition of EFI_IMAGE_INPUT.\r
- \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
+ @param Width Image width, in pixels.\r
\r
@param Height Image height, in pixels.\r
\r
- @param Bitmap The actual bitmap, organized left-to-right,\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
**/\r
typedef struct _EFI_IMAGE_INPUT {\r
UINT32 Flags;\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 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
\r
@retval EFI_SUCCESS The new image was added\r
successfully\r
- \r
+\r
@retval EFI_OUT_OF_RESOURCES Could not add the image.\r
- \r
+\r
@retval EFI_INVALID_PARAMETER Image is NULL or ImageId is\r
NULL.\r
\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 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
+\r
@param ImageId The image's id, which is unique within\r
PackageList.\r
- \r
+\r
@param Image Points to the new image.\r
- \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
+\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
- \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
+ @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r
\r
@param PackageList The package list containing the images.\r
\r
@param Image Points to the image.\r
\r
@retval EFI_SUCCESS The image was successfully updated.\r
- \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
+ The specified PackageList is not in the database.\r
+\r
@retval EFI_INVALID_PARAMETER The Image or Language was NULL.\r
\r
**/\r
);\r
\r
\r
-//\r
-// EFI_HII_DRAW_FLAGS\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_FORCE_OPAQUE 0x00000020\r
#define EFI_HII_DIRECT_TO_SCREEN 0x00000080\r
\r
-\r
/**\r
- \r
+\r
Definition of EFI_IMAGE_OUTPUT.\r
- \r
+\r
@param Width Width of the output image.\r
\r
@param Height Height of the output image.\r
\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
specified by Bitmap.\r
\r
\r
- @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \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
+\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
);\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
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
+ @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
pixel in the image.\r
\r
@retval EFI_SUCCESS The image was successfully updated.\r
- \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
+ @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
);\r
\r
\r
-/**\r
- @par Protocol Description: \r
- Services to access to images in the images database.\r
-\r
- @param NewImage Add a new image.\r
-\r
- @param GetImage Retrieve an image and related font\r
- information.\r
-\r
- @param SetImage Change an image.\r
- \r
- @param DrawImage Renders an image to a bitmap or to the display.\r
- \r
- @param DrawImageId Render an image to a bitmap or the screen containing \r
- the contents of the specified image.\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
projects / mirror_edk2.git / blobdiff