1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
/** @file
Library for performing video blt operations
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef __BLT_LIB__
#define __BLT_LIB__
#include <Protocol/GraphicsOutput.h>
/**
Configure the BltLib for a frame-buffer
@param[in] FrameBuffer Pointer to the start of the frame buffer
@param[in] FrameBufferInfo Describes the frame buffer characteristics
@retval EFI_INVALID_PARAMETER - Invalid parameter passed in
@retval EFI_SUCCESS - Blt operation success
**/
EFI_STATUS
EFIAPI
BltLibConfigure (
IN VOID *FrameBuffer,
IN EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *FrameBufferInfo
);
/**
Performs a UEFI Graphics Output Protocol Blt operation.
@param[in,out] BltBuffer - The data to transfer to screen
@param[in] BltOperation - The operation to perform
@param[in] SourceX - The X coordinate of the source for BltOperation
@param[in] SourceY - The Y coordinate of the source for BltOperation
@param[in] DestinationX - The X coordinate of the destination for BltOperation
@param[in] DestinationY - The Y coordinate of the destination for BltOperation
@param[in] Width - The width of a rectangle in the blt rectangle in pixels
@param[in] Height - The height of a rectangle in the blt rectangle in pixels
@param[in] Delta - Not used for EfiBltVideoFill and EfiBltVideoToVideo operation.
If a Delta of 0 is used, the entire BltBuffer will be operated on.
If a subrectangle of the BltBuffer is used, then Delta represents
the number of bytes in a row of the BltBuffer.
@retval EFI_DEVICE_ERROR - A hardware error occured
@retval EFI_INVALID_PARAMETER - Invalid parameter passed in
@retval EFI_SUCCESS - Blt operation success
**/
EFI_STATUS
EFIAPI
BltLibGopBlt (
IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
IN UINTN SourceX,
IN UINTN SourceY,
IN UINTN DestinationX,
IN UINTN DestinationY,
IN UINTN Width,
IN UINTN Height,
IN UINTN Delta
);
/**
Performs a UEFI Graphics Output Protocol Blt Video Fill.
@param[in] Color Color to fill the region with
@param[in] DestinationX X location to start fill operation
@param[in] DestinationY Y location to start fill operation
@param[in] Width Width (in pixels) to fill
@param[in] Height Height to fill
@retval EFI_DEVICE_ERROR - A hardware error occured
@retval EFI_INVALID_PARAMETER - Invalid parameter passed in
@retval EFI_SUCCESS - Blt operation success
**/
EFI_STATUS
EFIAPI
BltLibVideoFill (
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Color,
IN UINTN DestinationX,
IN UINTN DestinationY,
IN UINTN Width,
IN UINTN Height
);
/**
Performs a UEFI Graphics Output Protocol Blt Video to Buffer operation.
@param[out] BltBuffer Output buffer for pixel color data
@param[in] SourceX X location within video
@param[in] SourceY Y location within video
@param[in] Width Width (in pixels)
@param[in] Height Height
@retval EFI_DEVICE_ERROR - A hardware error occured
@retval EFI_INVALID_PARAMETER - Invalid parameter passed in
@retval EFI_SUCCESS - Blt operation success
**/
EFI_STATUS
EFIAPI
BltLibVideoToBltBuffer (
OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer,
IN UINTN SourceX,
IN UINTN SourceY,
IN UINTN Width,
IN UINTN Height
);
/**
Performs a UEFI Graphics Output Protocol Blt Video to Buffer operation
with extended parameters.
@param[out] BltBuffer Output buffer for pixel color data
@param[in] SourceX X location within video
@param[in] SourceY Y location within video
@param[in] DestinationX X location within BltBuffer
@param[in] DestinationY Y location within BltBuffer
@param[in] Width Width (in pixels)
@param[in] Height Height
@param[in] Delta Number of bytes in a row of BltBuffer
@retval EFI_DEVICE_ERROR - A hardware error occured
@retval EFI_INVALID_PARAMETER - Invalid parameter passed in
@retval EFI_SUCCESS - Blt operation success
**/
EFI_STATUS
EFIAPI
BltLibVideoToBltBufferEx (
OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer,
IN UINTN SourceX,
IN UINTN SourceY,
IN UINTN DestinationX,
IN UINTN DestinationY,
IN UINTN Width,
IN UINTN Height,
IN UINTN Delta
);
/**
Performs a UEFI Graphics Output Protocol Blt Buffer to Video operation.
@param[in] BltBuffer Output buffer for pixel color data
@param[in] DestinationX X location within video
@param[in] DestinationY Y location within video
@param[in] Width Width (in pixels)
@param[in] Height Height
@retval EFI_DEVICE_ERROR - A hardware error occured
@retval EFI_INVALID_PARAMETER - Invalid parameter passed in
@retval EFI_SUCCESS - Blt operation success
**/
EFI_STATUS
EFIAPI
BltLibBufferToVideo (
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer,
IN UINTN DestinationX,
IN UINTN DestinationY,
IN UINTN Width,
IN UINTN Height
);
/**
Performs a UEFI Graphics Output Protocol Blt Buffer to Video operation
with extended parameters.
@param[in] BltBuffer Output buffer for pixel color data
@param[in] SourceX X location within BltBuffer
@param[in] SourceY Y location within BltBuffer
@param[in] DestinationX X location within video
@param[in] DestinationY Y location within video
@param[in] Width Width (in pixels)
@param[in] Height Height
@param[in] Delta Number of bytes in a row of BltBuffer
@retval EFI_DEVICE_ERROR - A hardware error occured
@retval EFI_INVALID_PARAMETER - Invalid parameter passed in
@retval EFI_SUCCESS - Blt operation success
**/
EFI_STATUS
EFIAPI
BltLibBufferToVideoEx (
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer,
IN UINTN SourceX,
IN UINTN SourceY,
IN UINTN DestinationX,
IN UINTN DestinationY,
IN UINTN Width,
IN UINTN Height,
IN UINTN Delta
);
/**
Performs a UEFI Graphics Output Protocol Blt Video to Video operation
@param[in] SourceX X location within video
@param[in] SourceY Y location within video
@param[in] DestinationX X location within video
@param[in] DestinationY Y location within video
@param[in] Width Width (in pixels)
@param[in] Height Height
@retval EFI_DEVICE_ERROR - A hardware error occured
@retval EFI_INVALID_PARAMETER - Invalid parameter passed in
@retval EFI_SUCCESS - Blt operation success
**/
EFI_STATUS
EFIAPI
BltLibVideoToVideo (
IN UINTN SourceX,
IN UINTN SourceY,
IN UINTN DestinationX,
IN UINTN DestinationY,
IN UINTN Width,
IN UINTN Height
);
/**
Returns the sizes related to the video device
@param[out] Width Width (in pixels)
@param[out] Height Height (in pixels)
@retval EFI_INVALID_PARAMETER - Invalid parameter passed in
@retval EFI_SUCCESS - The sizes were returned
**/
EFI_STATUS
EFIAPI
BltLibGetSizes (
OUT UINTN *Width, OPTIONAL
OUT UINTN *Height OPTIONAL
);
#endif
|