MdePkg/Include/Protocol/GraphicsOutput.h File Reference


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

Defines

#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_GRAPHICS_OUTPUT_PROTOCOL 
EFI_GRAPHICS_OUTPUT_PROTOCOL
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)
typedef EFI_STATUS(EFIAPI * EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE )(IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This, IN UINT32 ModeNumber)
typedef EFI_STATUS(EFIAPI * EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT )(IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, 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)

Enumerations

enum  EFI_GRAPHICS_PIXEL_FORMAT {
  PixelRedGreenBlueReserved8BitPerColor, PixelBlueGreenRedReserved8BitPerColor, PixelBitMask, PixelBltOnly,
  PixelFormatMax
}
enum  EFI_GRAPHICS_OUTPUT_BLT_OPERATION {
  EfiBltVideoFill, EfiBltVideoToBltBuffer, EfiBltBufferToVideo, EfiBltVideoToVideo,
  EfiGraphicsOutputBltOperationMax
}

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.


Define Documentation

#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID

Value:

{ \
    0x9042a9de, 0x23dc, 0x4a38, {0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a } \
  }


Typedef Documentation

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

Blt a rectangle of pixels on the graphics screen. Blt stands for BLock Transfer.

Parameters:
This Protocol instance pointer.
BltBuffer The data to transfer to the graphics screen. Size is at least Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL).
BltOperation The operation to perform when copying BltBuffer on to the graphics screen.
SourceX The X coordinate of source for the BltOperation.
SourceY The Y coordinate of source for the BltOperation.
DestinationX The X coordinate of destination for the BltOperation.
DestinationY The Y coordinate of destination for the BltOperation.
Width The width of a rectangle in the blt rectangle in pixels.
Height The height of a rectangle in the blt rectangle in pixels.
Delta Not 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_SUCCESS BltBuffer was drawn to the graphics screen.
EFI_INVALID_PARAMETER BltOperation is not valid.
EFI_DEVICE_ERROR The device had an error and could not complete the request.

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:
This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
ModeNumber The mode number to return information on.
SizeOfInfo A pointer to the size, in bytes, of the Info buffer.
Info A pointer to callee allocated buffer that returns information about ModeNumber.
Return values:
EFI_SUCCESS Valid mode information was returned.
EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the video mode.
EFI_INVALID_PARAMETER ModeNumber is not valid.

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:
This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
ModeNumber Abstraction that defines the current video mode.
Return values:
EFI_SUCCESS The graphics mode specified by ModeNumber was selected.
EFI_DEVICE_ERROR The device had an error and could not complete the request.
EFI_UNSUPPORTED ModeNumber is not supported by this device.


Enumeration Type Documentation

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 

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.


Variable Documentation


Generated on Wed Sep 23 16:24:23 2015 for MdePkg[ALL] by  doxygen 1.5.7.1