2 UGA Draw protocol from the EFI 1.1 specification.
4 Abstraction of a very simple graphics device.
6 Copyright (c) 2006, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef __UGA_DRAW_H__
18 #define __UGA_DRAW_H__
20 #define EFI_UGA_DRAW_PROTOCOL_GUID \
22 0x982c298b, 0xf4fa, 0x41cb, {0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 } \
25 typedef struct _EFI_UGA_DRAW_PROTOCOL EFI_UGA_DRAW_PROTOCOL
;
28 Return the current video mode information.
30 @param This Protocol instance pointer.
31 @param HorizontalResolution Current video horizontal resolution in pixels
32 @param VerticalResolution Current video vertical resolution in pixels
33 @param ColorDepth Current video color depth in bits per pixel
34 @param RefreshRate Current video refresh rate in Hz.
36 @retval EFI_SUCCESS Mode information returned.
37 @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
38 @retval EFI_INVALID_PARAMETER One of the input args was NULL.
43 (EFIAPI
*EFI_UGA_DRAW_PROTOCOL_GET_MODE
) (
44 IN EFI_UGA_DRAW_PROTOCOL
*This
,
45 OUT UINT32
*HorizontalResolution
,
46 OUT UINT32
*VerticalResolution
,
47 OUT UINT32
*ColorDepth
,
48 OUT UINT32
*RefreshRate
53 Set the current video mode information.
55 @param This Protocol instance pointer.
56 @param HorizontalResolution Current video horizontal resolution in pixels
57 @param VerticalResolution Current video vertical resolution in pixels
58 @param ColorDepth Current video color depth in bits per pixel
59 @param RefreshRate Current video refresh rate in Hz.
61 @retval EFI_SUCCESS Mode information returned.
62 @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
67 (EFIAPI
*EFI_UGA_DRAW_PROTOCOL_SET_MODE
) (
68 IN EFI_UGA_DRAW_PROTOCOL
*This
,
69 IN UINT32 HorizontalResolution
,
70 IN UINT32 VerticalResolution
,
86 } EFI_UGA_PIXEL_UNION
;
90 EfiUgaVideoToBltBuffer
,
91 EfiUgaBltBufferToVideo
,
94 } EFI_UGA_BLT_OPERATION
;
97 Type specifying a pointer to a function to perform an UGA Blt operation.
99 The following table defines actions for BltOperations:
101 <B>EfiUgaVideoFill</B> - Write data from the BltBuffer pixel (SourceX, SourceY)
102 directly to every pixel of the video display rectangle
103 (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
104 Only one pixel will be used from the BltBuffer. Delta is NOT used.
106 <B>EfiUgaVideoToBltBuffer</B> - Read data from the video display rectangle
107 (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
108 the BltBuffer rectangle (DestinationX, DestinationY )
109 (DestinationX + Width, DestinationY + Height). If DestinationX or
110 DestinationY is not zero then Delta must be set to the length in bytes
111 of a row in the BltBuffer.
113 <B>EfiUgaBltBufferToVideo</B> - Write data from the BltBuffer rectangle
114 (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
115 video display rectangle (DestinationX, DestinationY)
116 (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
117 not zero then Delta must be set to the length in bytes of a row in the
120 <B>EfiUgaVideoToVideo</B> - Copy from the video display rectangle (SourceX, SourceY)
121 (SourceX + Width, SourceY + Height) .to the video display rectangle
122 (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
123 The BltBuffer and Delta are not used in this mode.
126 @param[in] This - Protocol instance pointer.
127 @param[in] BltBuffer - Buffer containing data to blit into video buffer. This
128 buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)
129 @param[in] BltOperation - Operation to perform on BlitBuffer and video memory
130 @param[in] SourceX - X coordinate of source for the BltBuffer.
131 @param[in] SourceY - Y coordinate of source for the BltBuffer.
132 @param[in] DestinationX - X coordinate of destination for the BltBuffer.
133 @param[in] DestinationY - Y coordinate of destination for the BltBuffer.
134 @param[in] Width - Width of rectangle in BltBuffer in pixels.
135 @param[in] Height - Hight of rectangle in BltBuffer in pixels.
136 @param[in] Delta - OPTIONAL
138 @retval EFI_SUCCESS - The Blt operation completed.
139 @retval EFI_INVALID_PARAMETER - BltOperation is not valid.
140 @retval EFI_DEVICE_ERROR - A hardware error occured writting to the video buffer.
145 (EFIAPI
*EFI_UGA_DRAW_PROTOCOL_BLT
) (
146 IN EFI_UGA_DRAW_PROTOCOL
* This
,
147 IN EFI_UGA_PIXEL
* BltBuffer
, OPTIONAL
148 IN EFI_UGA_BLT_OPERATION BltOperation
,
151 IN UINTN DestinationX
,
152 IN UINTN DestinationY
,
155 IN UINTN Delta OPTIONAL
158 struct _EFI_UGA_DRAW_PROTOCOL
{
159 EFI_UGA_DRAW_PROTOCOL_GET_MODE GetMode
;
160 EFI_UGA_DRAW_PROTOCOL_SET_MODE SetMode
;
161 EFI_UGA_DRAW_PROTOCOL_BLT Blt
;
164 extern EFI_GUID gEfiUgaDrawProtocolGuid
;