projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 30fdf114 LG |
1 | /** @file\r |
| 2 | UGA Draw protocol from the EFI 1.1 specification.\r | |
| 3 | \r | |
| 4 | Abstraction of a very simple graphics device.\r | |
| 5 | \r | |
| 40d841f6 | 6 | Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r |
| 30fdf114 LG |
7 | \r |
| 8 | This program and the accompanying materials are licensed and made available\r | |
| 9 | under the terms and conditions of the BSD License which accompanies this\r | |
| 10 | distribution. The full text of the license may be found at:\r | |
| 11 | http://opensource.org/licenses/bsd-license.php\r | |
| 12 | \r | |
| 13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 15 | \r | |
| 16 | File name: UgaDraw.h\r | |
| 17 | \r | |
| 18 | **/\r | |
| 19 | \r | |
| 20 | #ifndef __UGA_DRAW_H__\r | |
| 21 | #define __UGA_DRAW_H__\r | |
| 22 | \r | |
| 23 | #define EFI_UGA_DRAW_PROTOCOL_GUID \\r | |
| 24 | { \\r | |
| 25 | 0x982c298b, 0xf4fa, 0x41cb, {0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 } \\r | |
| 26 | }\r | |
| 27 | \r | |
| 28 | typedef struct _EFI_UGA_DRAW_PROTOCOL EFI_UGA_DRAW_PROTOCOL;\r | |
| 29 | \r | |
| 30 | /**\r | |
| 31 | Return the current video mode information.\r | |
| 32 | \r | |
| 33 | @param This Protocol instance pointer.\r | |
| 34 | @param HorizontalResolution Current video horizontal resolution in pixels\r | |
| 35 | @param VerticalResolution Current video vertical resolution in pixels\r | |
| 36 | @param ColorDepth Current video color depth in bits per pixel\r | |
| 37 | @param RefreshRate Current video refresh rate in Hz.\r | |
| 38 | \r | |
| 39 | @retval EFI_SUCCESS Mode information returned.\r | |
| 40 | @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r | |
| 41 | @retval EFI_INVALID_PARAMETER One of the input args was NULL.\r | |
| 42 | \r | |
| 43 | **/\r | |
| 44 | typedef\r | |
| 45 | EFI_STATUS\r | |
| 46 | (EFIAPI *EFI_UGA_DRAW_PROTOCOL_GET_MODE) (\r | |
| 47 | IN EFI_UGA_DRAW_PROTOCOL *This,\r | |
| 48 | OUT UINT32 *HorizontalResolution,\r | |
| 49 | OUT UINT32 *VerticalResolution,\r | |
| 50 | OUT UINT32 *ColorDepth,\r | |
| 51 | OUT UINT32 *RefreshRate\r | |
| 52 | )\r | |
| 53 | ;\r | |
| 54 | \r | |
| 55 | /**\r | |
| 56 | Return the current video mode information.\r | |
| 57 | \r | |
| 58 | @param This Protocol instance pointer.\r | |
| 59 | @param HorizontalResolution Current video horizontal resolution in pixels\r | |
| 60 | @param VerticalResolution Current video vertical resolution in pixels\r | |
| 61 | @param ColorDepth Current video color depth in bits per pixel\r | |
| 62 | @param RefreshRate Current video refresh rate in Hz.\r | |
| 63 | \r | |
| 64 | @retval EFI_SUCCESS Mode information returned.\r | |
| 65 | @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r | |
| 66 | \r | |
| 67 | **/\r | |
| 68 | typedef\r | |
| 69 | EFI_STATUS\r | |
| 70 | (EFIAPI *EFI_UGA_DRAW_PROTOCOL_SET_MODE) (\r | |
| 71 | IN EFI_UGA_DRAW_PROTOCOL *This,\r | |
| 72 | IN UINT32 HorizontalResolution,\r | |
| 73 | IN UINT32 VerticalResolution,\r | |
| 74 | IN UINT32 ColorDepth,\r | |
| 75 | IN UINT32 RefreshRate\r | |
| 76 | )\r | |
| 77 | ;\r | |
| 78 | \r | |
| 79 | typedef struct {\r | |
| 80 | UINT8 Blue;\r | |
| 81 | UINT8 Green;\r | |
| 82 | UINT8 Red;\r | |
| 83 | UINT8 Reserved;\r | |
| 84 | } EFI_UGA_PIXEL;\r | |
| 85 | \r | |
| 86 | typedef union {\r | |
| 87 | EFI_UGA_PIXEL Pixel;\r | |
| 88 | UINT32 Raw;\r | |
| 89 | } EFI_UGA_PIXEL_UNION;\r | |
| 90 | \r | |
| 91 | typedef enum {\r | |
| 92 | EfiUgaVideoFill,\r | |
| 93 | EfiUgaVideoToBltBuffer,\r | |
| 94 | EfiUgaBltBufferToVideo,\r | |
| 95 | EfiUgaVideoToVideo,\r | |
| 96 | EfiUgaBltMax\r | |
| 97 | } EFI_UGA_BLT_OPERATION;\r | |
| 98 | \r | |
| 99 | /**\r | |
| 100 | Type specifying a pointer to a function to perform an UGA Blt operation.\r | |
| 101 | \r | |
| 102 | The following table defines actions for BltOperations:\r | |
| 103 | \r | |
| 104 | <B>EfiUgaVideoFill</B> - Write data from the BltBuffer pixel (SourceX, SourceY) \r | |
| 105 | directly to every pixel of the video display rectangle \r | |
| 106 | (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). \r | |
| 107 | Only one pixel will be used from the BltBuffer. Delta is NOT used.\r | |
| 108 | \r | |
| 109 | <B>EfiUgaVideoToBltBuffer</B> - Read data from the video display rectangle \r | |
| 110 | (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in \r | |
| 111 | the BltBuffer rectangle (DestinationX, DestinationY ) \r | |
| 112 | (DestinationX + Width, DestinationY + Height). If DestinationX or \r | |
| 113 | DestinationY is not zero then Delta must be set to the length in bytes \r | |
| 114 | of a row in the BltBuffer.\r | |
| 115 | \r | |
| 116 | <B>EfiUgaBltBufferToVideo</B> - Write data from the BltBuffer rectangle \r | |
| 117 | (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the \r | |
| 118 | video display rectangle (DestinationX, DestinationY) \r | |
| 119 | (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is \r | |
| 120 | not zero then Delta must be set to the length in bytes of a row in the \r | |
| 121 | BltBuffer.\r | |
| 122 | \r | |
| 123 | <B>EfiUgaVideoToVideo</B> - Copy from the video display rectangle (SourceX, SourceY)\r | |
| 124 | (SourceX + Width, SourceY + Height) .to the video display rectangle \r | |
| 125 | (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). \r | |
| 126 | The BltBuffer and Delta are not used in this mode.\r | |
| 127 | \r | |
| 128 | \r | |
| 129 | @param[in] This - Protocol instance pointer.\r | |
| 130 | @param[in] BltBuffer - Buffer containing data to blit into video buffer. This \r | |
| 131 | buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)\r | |
| 132 | @param[in] BltOperation - Operation to perform on BlitBuffer and video memory\r | |
| 133 | @param[in] SourceX - X coordinate of source for the BltBuffer.\r | |
| 134 | @param[in] SourceY - Y coordinate of source for the BltBuffer.\r | |
| 135 | @param[in] DestinationX - X coordinate of destination for the BltBuffer.\r | |
| 136 | @param[in] DestinationY - Y coordinate of destination for the BltBuffer.\r | |
| 137 | @param[in] Width - Width of rectangle in BltBuffer in pixels.\r | |
| 138 | @param[in] Height - Hight of rectangle in BltBuffer in pixels.\r | |
| 139 | @param[in] Delta - OPTIONAL\r | |
| 140 | \r | |
| 141 | @retval EFI_SUCCESS - The Blt operation completed.\r | |
| 142 | @retval EFI_INVALID_PARAMETER - BltOperation is not valid.\r | |
| 143 | @retval EFI_DEVICE_ERROR - A hardware error occured writting to the video buffer.\r | |
| 144 | \r | |
| 145 | --*/\r | |
| 146 | typedef\r | |
| 147 | EFI_STATUS\r | |
| 148 | (EFIAPI *EFI_UGA_DRAW_PROTOCOL_BLT) (\r | |
| 149 | IN EFI_UGA_DRAW_PROTOCOL * This,\r | |
| 150 | IN EFI_UGA_PIXEL * BltBuffer, OPTIONAL\r | |
| 151 | IN EFI_UGA_BLT_OPERATION BltOperation,\r | |
| 152 | IN UINTN SourceX,\r | |
| 153 | IN UINTN SourceY,\r | |
| 154 | IN UINTN DestinationX,\r | |
| 155 | IN UINTN DestinationY,\r | |
| 156 | IN UINTN Width,\r | |
| 157 | IN UINTN Height,\r | |
| 158 | IN UINTN Delta OPTIONAL\r | |
| 159 | );\r | |
| 160 | \r | |
| 161 | struct _EFI_UGA_DRAW_PROTOCOL {\r | |
| 162 | EFI_UGA_DRAW_PROTOCOL_GET_MODE GetMode;\r | |
| 163 | EFI_UGA_DRAW_PROTOCOL_SET_MODE SetMode;\r | |
| 164 | EFI_UGA_DRAW_PROTOCOL_BLT Blt;\r | |
| 165 | };\r | |
| 166 | \r | |
| 167 | extern EFI_GUID gEfiUgaDrawProtocolGuid;\r | |
| 168 | \r | |
| 169 | #endif\r |