Add additional comments for structure definition.

[mirror_edk2.git] / MdeModulePkg / Include / Guid / Bmp.h

/** @file\r
  This file defines header data structures for BMP file and default\r
  FFS GUID Filename for BMP logo file. \r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\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
\r
**/\r
\r
#ifndef __BMP_GUID_H__\r
#define __BMP_GUID_H__\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  UINT8   Blue;\r
  UINT8   Green;\r
  UINT8   Red;\r
  UINT8   Reserved;\r
} BMP_COLOR_MAP;\r
\r
typedef struct {\r
  CHAR8         CharB;\r
  CHAR8         CharM;\r
  UINT32        Size;\r
  UINT16        Reserved[2];\r
  UINT32        ImageOffset;\r
  UINT32        HeaderSize;\r
  UINT32        PixelWidth;\r
  UINT32        PixelHeight;\r
  UINT16        Planes;          /// Must be 1\r
  UINT16        BitPerPixel;     /// 1, 4, 8, or 24\r
  UINT32        CompressionType;\r
  UINT32        ImageSize;       /// Compressed image size in bytes\r
  UINT32        XPixelsPerMeter;\r
  UINT32        YPixelsPerMeter;\r
  UINT32        NumberOfColors;\r
  UINT32        ImportantColors;\r
} BMP_IMAGE_HEADER;\r
\r
#pragma pack()\r
\r
#define EFI_DEFAULT_BMP_LOGO_GUID \\r
  {0x7BB28B99,0x61BB,0x11d5,{0x9A,0x5D,0x00,0x90,0x27,0x3F,0xC1,0x4D}}\r
\r
extern EFI_GUID gEfiDefaultBmpLogoGuid;\r
\r
#endif\r