MdePkg/HiiImage.h: Include GraphicsOutput.h

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

diff --git a/MdePkg/Include/Protocol/HiiImage.h b/MdePkg/Include/Protocol/HiiImage.h
index 0cc6445d779dc4ede658efbc08660ebe7513ef37..1d42bfa71e4c97db47583b123ba485149c0d0f57 100644 (file)
--- a/MdePkg/Include/Protocol/HiiImage.h
+++ b/MdePkg/Include/Protocol/HiiImage.h
@@ -1,8 +1,8 @@
 /** @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
+  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
@@ -15,6 +15,8 @@
 #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
@@ -38,7 +40,7 @@ typedef struct _EFI_HII_IMAGE_PROTOCOL EFI_HII_IMAGE_PROTOCOL;
 \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
@@ -160,9 +162,10 @@ EFI_STATUS
 );\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
@@ -172,7 +175,6 @@ typedef UINT32  EFI_HII_DRAW_FLAGS;
 #define EFI_HII_DRAW_FLAG_FORCE_OPAQUE  0x00000020\r
 #define EFI_HII_DIRECT_TO_SCREEN        0x00000080\r
 \r
-\r
 /**\r
    \r
   Definition of EFI_IMAGE_OUTPUT.\r
@@ -336,23 +338,9 @@ IN        UINTN                   BltY
 );\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