Intel Extensible Firmware Interface - Manual (Page 322)

Extensible Firmware Interface Specification
10-28 12/01/02 Version 1.10
EFI_UGA_DRAW_PROTOCOL.GetMode()
Summary
Return the current frame buffer geometry and display refresh rate.
Prototype
typedef
EFI_STATUS
(EFIAPI *EFI_UGA_DRAW_PROTOCOL_GET_MODE) (
IN EFI_UGA_DRAW_PROTOCOL *This,
OUT UINT32 *HorizontalResolution,
OUT UINT32 *VerticalResolution,
OUT UINT32 *ColorDepth,
OUT UINT32 *RefreshRate
);
Parameters
This The EFI_UGA_DRAW_PROTOCOL instance. Type
EFI_UGA_DRAW_PROTOCOL is defined in Section 10.5.
HorizontalResolution The size of video screen in pixels in the X dimension.
VerticalResolution The size of video screen in pixels in the Y dimension.
ColorDepth Number of bits per pixel, currently defined to be 32.
RefreshRate The refresh rate of the monitor in Hertz.
Description
The GetMode() function returns information about the current mode. All UGA devices must
support an 800 x 600 x 32-bit per pixel x 60 Hz mode of operation. A UGA device may support an
arbitrary number of modes in addition to the required mode.
Status Codes Returned
EFI_SUCCESS Valid mode information was returned.
EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the video mode.
EFI_INVALID_PARAMETER HorizontalResolution , or
VerticalResolution , or RefreshRate , is NULL .