iPXE
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
GraphicsOutput.h File Reference

Graphics Output Protocol from the UEFI 2.0 specification. More...

Go to the source code of this file.

Data Structures

struct  EFI_PIXEL_BITMASK
 
struct  EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
 
struct  EFI_GRAPHICS_OUTPUT_BLT_PIXEL
 
union  EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION
 
struct  EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
 
struct  _EFI_GRAPHICS_OUTPUT_PROTOCOL
 Provides a basic abstraction to set video modes and copy pixels to and from the graphics controller's frame buffer. More...
 

Macros

#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID
 

Typedefs

typedef struct _EFI_GRAPHICS_OUTPUT_PROTOCOL EFI_GRAPHICS_OUTPUT_PROTOCOL
 
typedef EFI_STATUS(EFIAPIEFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE) (IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This, IN UINT32 ModeNumber, OUT UINTN *SizeOfInfo, OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info)
 Returns information for an available graphics mode that the graphics device and the set of active video output devices supports. More...
 
typedef EFI_STATUS(EFIAPIEFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE) (IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This, IN UINT32 ModeNumber)
 Set the video device into the specified mode and clears the visible portions of the output display to black. More...
 
typedef EFI_STATUS(EFIAPIEFI_GRAPHICS_OUTPUT_PROTOCOL_BLT) (IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This, IN 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 OPTIONAL)
 Blt a rectangle of pixels on the graphics screen. More...
 

Enumerations

enum  EFI_GRAPHICS_PIXEL_FORMAT {
  PixelRedGreenBlueReserved8BitPerColor, PixelBlueGreenRedReserved8BitPerColor, PixelBitMask, PixelBltOnly,
  PixelFormatMax
}
 
enum  EFI_GRAPHICS_OUTPUT_BLT_OPERATION {
  EfiBltVideoFill, EfiBltVideoToBltBuffer, EfiBltBufferToVideo, EfiBltVideoToVideo,
  EfiGraphicsOutputBltOperationMax
}
 actions for BltOperations More...
 

Functions

 FILE_LICENCE (BSD3)
 

Variables

EFI_GUID gEfiGraphicsOutputProtocolGuid
 

Detailed Description

Graphics Output Protocol from the UEFI 2.0 specification.

Abstraction of a very simple graphics device.

Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.
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.

Definition in file GraphicsOutput.h.

Macro Definition Documentation

◆ EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID

#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID
Value:
{ \
0x9042a9de, 0x23dc, 0x4a38, {0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a } \
}

Definition at line 22 of file GraphicsOutput.h.

Typedef Documentation

◆ EFI_GRAPHICS_OUTPUT_PROTOCOL

Definition at line 27 of file GraphicsOutput.h.

◆ EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE

typedef EFI_STATUS(EFIAPI * EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE) (IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This, IN UINT32 ModeNumber, OUT UINTN *SizeOfInfo, OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info)

Returns information for an available graphics mode that the graphics device and the set of active video output devices supports.

Parameters
ThisThe EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
ModeNumberThe mode number to return information on.
SizeOfInfoA pointer to the size, in bytes, of the Info buffer.
InfoA pointer to callee allocated buffer that returns information about ModeNumber.
Return values
EFI_SUCCESSValid mode information was returned.
EFI_DEVICE_ERRORA hardware error occurred trying to retrieve the video mode.
EFI_INVALID_PARAMETERModeNumber is not valid.

Definition at line 113 of file GraphicsOutput.h.

◆ EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE

typedef EFI_STATUS(EFIAPI * EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE) (IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This, IN UINT32 ModeNumber)

Set the video device into the specified mode and clears the visible portions of the output display to black.

Parameters
ThisThe EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
ModeNumberAbstraction that defines the current video mode.
Return values
EFI_SUCCESSThe graphics mode specified by ModeNumber was selected.
EFI_DEVICE_ERRORThe device had an error and could not complete the request.
EFI_UNSUPPORTEDModeNumber is not supported by this device.

Definition at line 134 of file GraphicsOutput.h.

◆ EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT

typedef EFI_STATUS(EFIAPI * EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT) (IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This, IN 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 OPTIONAL)

Blt a rectangle of pixels on the graphics screen.

Blt stands for BLock Transfer.

Parameters
ThisProtocol instance pointer.
BltBufferThe data to transfer to the graphics screen. Size is at least Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL).
BltOperationThe operation to perform when copying BltBuffer on to the graphics screen.
SourceXThe X coordinate of source for the BltOperation.
SourceYThe Y coordinate of source for the BltOperation.
DestinationXThe X coordinate of destination for the BltOperation.
DestinationYThe Y coordinate of destination for the BltOperation.
WidthThe width of a rectangle in the blt rectangle in pixels.
HeightThe height of a rectangle in the blt rectangle in pixels.
DeltaNot used for EfiBltVideoFill or the EfiBltVideoToVideo operation. If a Delta of zero is used, the entire BltBuffer is being operated on. If a subrectangle of the BltBuffer is being used then Delta represents the number of bytes in a row of the BltBuffer.
Return values
EFI_SUCCESSBltBuffer was drawn to the graphics screen.
EFI_INVALID_PARAMETERBltOperation is not valid.
EFI_DEVICE_ERRORThe device had an error and could not complete the request.

Definition at line 219 of file GraphicsOutput.h.

Enumeration Type Documentation

◆ EFI_GRAPHICS_PIXEL_FORMAT

Enumerator
PixelRedGreenBlueReserved8BitPerColor 

A pixel is 32-bits and byte zero represents red, byte one represents green, byte two represents blue, and byte three is reserved.

This is the definition for the physical frame buffer. The byte values for the red, green, and blue components represent the color intensity. This color intensity value range from a minimum intensity of 0 to maximum intensity of 255.

PixelBlueGreenRedReserved8BitPerColor 

A pixel is 32-bits and byte zero represents blue, byte one represents green, byte two represents red, and byte three is reserved.

This is the definition for the physical frame buffer. The byte values for the red, green, and blue components represent the color intensity. This color intensity value range from a minimum intensity of 0 to maximum intensity of 255.

PixelBitMask 

The Pixel definition of the physical frame buffer.

PixelBltOnly 

This mode does not support a physical frame buffer.

PixelFormatMax 

Valid EFI_GRAPHICS_PIXEL_FORMAT enum values are less than this value.

Definition at line 36 of file GraphicsOutput.h.

36  {
37  ///
38  /// A pixel is 32-bits and byte zero represents red, byte one represents green,
39  /// byte two represents blue, and byte three is reserved. This is the definition
40  /// for the physical frame buffer. The byte values for the red, green, and blue
41  /// components represent the color intensity. This color intensity value range
42  /// from a minimum intensity of 0 to maximum intensity of 255.
43  ///
45  ///
46  /// A pixel is 32-bits and byte zero represents blue, byte one represents green,
47  /// byte two represents red, and byte three is reserved. This is the definition
48  /// for the physical frame buffer. The byte values for the red, green, and blue
49  /// components represent the color intensity. This color intensity value range
50  /// from a minimum intensity of 0 to maximum intensity of 255.
51  ///
53  ///
54  /// The Pixel definition of the physical frame buffer.
55  ///
57  ///
58  /// This mode does not support a physical frame buffer.
59  ///
61  ///
62  /// Valid EFI_GRAPHICS_PIXEL_FORMAT enum values are less than this value.
63  ///
The Pixel definition of the physical frame buffer.
A pixel is 32-bits and byte zero represents blue, byte one represents green, byte two represents red,...
Valid EFI_GRAPHICS_PIXEL_FORMAT enum values are less than this value.
A pixel is 32-bits and byte zero represents red, byte one represents green, byte two represents blue,...
EFI_GRAPHICS_PIXEL_FORMAT
This mode does not support a physical frame buffer.

◆ EFI_GRAPHICS_OUTPUT_BLT_OPERATION

actions for BltOperations

Enumerator
EfiBltVideoFill 

Write data from the BltBuffer pixel (0, 0) directly to every pixel of the video display rectangle (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).

Only one pixel will be used from the BltBuffer. Delta is NOT used.

EfiBltVideoToBltBuffer 

Read data from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in the BltBuffer rectangle (DestinationX, DestinationY ) (DestinationX + Width, DestinationY + Height).

If DestinationX or DestinationY is not zero then Delta must be set to the length in bytes of a row in the BltBuffer.

EfiBltBufferToVideo 

Write data from the BltBuffer rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the video display rectangle (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).

If SourceX or SourceY is not zero then Delta must be set to the length in bytes of a row in the BltBuffer.

EfiBltVideoToVideo 

Copy from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) to the video display rectangle (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).

The BltBuffer and Delta are not used in this mode.

EfiGraphicsOutputBltOperationMax 

Definition at line 154 of file GraphicsOutput.h.

154  {
155  ///
156  /// Write data from the BltBuffer pixel (0, 0)
157  /// directly to every pixel of the video display rectangle
158  /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
159  /// Only one pixel will be used from the BltBuffer. Delta is NOT used.
160  ///
162 
163  ///
164  /// Read data from the video display rectangle
165  /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
166  /// the BltBuffer rectangle (DestinationX, DestinationY )
167  /// (DestinationX + Width, DestinationY + Height). If DestinationX or
168  /// DestinationY is not zero then Delta must be set to the length in bytes
169  /// of a row in the BltBuffer.
170  ///
172 
173  ///
174  /// Write data from the BltBuffer rectangle
175  /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
176  /// video display rectangle (DestinationX, DestinationY)
177  /// (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
178  /// not zero then Delta must be set to the length in bytes of a row in the
179  /// BltBuffer.
180  ///
182 
183  ///
184  /// Copy from the video display rectangle (SourceX, SourceY)
185  /// (SourceX + Width, SourceY + Height) to the video display rectangle
186  /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
187  /// The BltBuffer and Delta are not used in this mode.
188  ///
190 
Write data from the BltBuffer pixel (0, 0) directly to every pixel of the video display rectangle (De...
Write data from the BltBuffer rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) direct...
Read data from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) and...
Copy from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) to the v...
EFI_GRAPHICS_OUTPUT_BLT_OPERATION
actions for BltOperations

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD3  )

Variable Documentation

◆ gEfiGraphicsOutputProtocolGuid

EFI_GUID gEfiGraphicsOutputProtocolGuid