Google is committed to advancing racial equity for Black communities. See how.

fuchsia.hardware.backlight

PROTOCOLS

Device

Defined in fuchsia.hardware.backlight/backlight.fidl

GetMaxAbsoluteBrightness

Gets the maximum supported backlight brightness in nits, if known. Otherwise returns error ZX_ERR_NOT_SUPPORTED.

Request

NameType

Response

NameType
result Device_GetMaxAbsoluteBrightness_Result

GetNormalizedBrightnessScale

Gets the current normalized brightness scale as a percentage value in [0.0, 1.0].

Request

NameType

Response

NameType
result Device_GetNormalizedBrightnessScale_Result

GetStateAbsolute

Gets the current backlight brightness in nits

Request

NameType

Response

NameType
result Device_GetStateAbsolute_Result

GetStateNormalized

Gets the current backlight brightness as a percentage value between 0.0 and 1.0

Request

NameType

Response

NameType
result Device_GetStateNormalized_Result

SetNormalizedBrightnessScale

Scales the maximum normalized brightness by a percentage value in [0.0, 1.0], if supported. Otherwise returns error ZX_ERR_NOT_SUPPORTED. Values passed to SetStateNormalized will correspond to a maximum brightness of scale * GetMaxAbsoluteBrightness(). Calling this may change the current absolute brightness.

Request

NameType
scale float64

Response

NameType
result Device_SetNormalizedBrightnessScale_Result

SetStateAbsolute

Sets the current backlight brightness in nits. Not affected by the scale set by SetNormalizedBrightnessScale.

Request

NameType
state State

Response

NameType
result Device_SetStateAbsolute_Result

SetStateNormalized

Sets the current backlight brightness as a percentage value between 0.0 and 1.0

Request

NameType
state State

Response

NameType
result Device_SetStateNormalized_Result

STRUCTS

Device_GetMaxAbsoluteBrightness_Response

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescriptionDefault
max_brightness float64 No default

Device_GetNormalizedBrightnessScale_Response

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescriptionDefault
scale float64 No default

Device_GetStateAbsolute_Response

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescriptionDefault
state State No default

Device_GetStateNormalized_Response

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescriptionDefault
state State No default

Device_SetNormalizedBrightnessScale_Response

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescriptionDefault

Device_SetStateAbsolute_Response

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescriptionDefault

Device_SetStateNormalized_Response

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescriptionDefault

State

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescriptionDefault
backlight_on bool No default
brightness float64

brightness can either be:

  1. The unitless brightness value on a linear scale where 0.0 is the minimum brightness and 1.0 is the maximum brightness - represents the current / desired brightness as a percentage within the supported range. Used by the GetStateNormalized / SetStateNormalized calls. The maximum brightness that can be set using SetStateNormalized is GetBrightnessScale() * GetMaxAbsoluteBrightness().
  2. Absolute brightness in nits. Used by the GetStateAbsolute / SetStateAbsolute calls.
No default

UNIONS

Device_GetMaxAbsoluteBrightness_Result

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescription
response Device_GetMaxAbsoluteBrightness_Response
err zx/status

Device_GetNormalizedBrightnessScale_Result

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescription
response Device_GetNormalizedBrightnessScale_Response
err zx/status

Device_GetStateAbsolute_Result

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescription
response Device_GetStateAbsolute_Response
err zx/status

Device_GetStateNormalized_Result

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescription
response Device_GetStateNormalized_Response
err zx/status

Device_SetNormalizedBrightnessScale_Result

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescription
response Device_SetNormalizedBrightnessScale_Response
err zx/status

Device_SetStateAbsolute_Result

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescription
response Device_SetStateAbsolute_Response
err zx/status

Device_SetStateNormalized_Result

Defined in fuchsia.hardware.backlight/backlight.fidl

NameTypeDescription
response Device_SetStateNormalized_Response
err zx/status