Edit

Share via

EFI_DISPLAY_POWER_STATE

  • Article

This enumeration represents the charging state of the display and backlight. This enumeration is a parameter of the EFI_DISPLAY_POWER_PROTOCOL.GetDisplayPowerState and EFI_DISPLAY_POWER_PROTOCOL.SetDisplayPowerState functions.

Syntax

typedef enum _EFI_DISPLAY_POWER_STATE {  
    EfiDisplayPowerStateUnknown = 0,  
    EfiDisplayPowerStateOff,  
    EfiDisplayPowerStateMaximum,  
} EFI_DISPLAY_POWER_STATE;

Elements

EfiDisplayPowerStateUnknown
The power state is not initialized. This value can only be used for variable initialization; it cannot be passed to or returned by any EFI_DISPLAY_POWER_PROTOCOL function.

EfiDisplayPowerStateOff
When used with EFI_DISPLAY_POWER_PROTOCOL.GetDisplayPowerState, indicates that power to the display and backlight are turned off. When used with EFI_DISPLAY_POWER_PROTOCOL.SetDisplayPowerState, turns off power to the display and backlight.

EfiDisplayPowerStateMaximum
When used with EFI_DISPLAY_POWER_PROTOCOL.GetDisplayPowerState, indicates that the display and backlight have full power. When used with EFI_DISPLAY_POWER_PROTOCOL.SetDisplayPowerState, turns on full power to the display and backlight.

Requirements

Header: User generated

EFI_DISPLAY_POWER_PROTOCOL