fuchsia.ui.brightness

PROTOCOLS

Control

Defined in fuchsia.ui.brightness/brightness.fidl

Control provides an interface to manage the brightness component.

SetAutoBrightness

Turns the auto-brightness mode on. SetManualBrightness will turn it off.

Request

NameType

WatchAutoBrightness

Requests the current auto-brightness mode. This call implements the Hanging Get protocol.

Request

NameType

Response

NameType
enabled bool

SetManualBrightness

Turns auto-brightness mode off. Used by e.g. Settings to set manual brightness using a slider Value is in the range 0.0 to 1.0 representing min to max and will be clamped if out of range.

Request

NameType
value brightness

WatchCurrentBrightness

Gets the current brightness in the range 0.0 to 1.0. This result is valid for both manual and auto-brightness modes and is typically used to show the current brightness on a slider. This call implements the Hanging Get protocol.

Request

NameType

Response

NameType
value brightness

SetAutoBrightnessAdjustment

Sets the brightness adjustment. This will change the brightness curve by the factor of the adjustment. The adjustment is in the range of -1.0 to 1.0.

Request

NameType
adjustment float32

WatchAutoBrightnessAdjustment

Gets the current auto brightness adjustment. This call implements the Hanging Get protocol.

Request

NameType

Response

NameType
adjustment float32

SetBrightnessTable

Sets the brightness curve as a set of points. This will override the built-in brightness curve. The default brightness curve will be used if the table is empty. The connection will be closed if table errors are detected.

Request

NameType
table BrightnessTable

ColorAdjustmentHandler

Defined in fuchsia.ui.brightness/color_adjustment.fidl

Handler implemented by the owner of the presentation. The UI component that controls brightness and screen tint uses this protocol to request changes to the screen's color adjustment matrix.

SetColorAdjustment

Called when the color adjustment has changed.

Request

NameType
color_adjustment ColorAdjustmentTable

STRUCTS

SomeLongAnonymousPrefix2

generated

anonymous struct

NameTypeDescriptionDefault
enabled bool No default

SomeLongAnonymousPrefix3

generated

anonymous struct

NameTypeDescriptionDefault
value brightness No default

SomeLongAnonymousPrefix5

generated

anonymous struct

NameTypeDescriptionDefault
value brightness No default

SomeLongAnonymousPrefix6

generated

anonymous struct

NameTypeDescriptionDefault
adjustment float32 No default

SomeLongAnonymousPrefix8

generated

anonymous struct

NameTypeDescriptionDefault
adjustment float32 No default

SomeLongAnonymousPrefix9

generated

anonymous struct

NameTypeDescriptionDefault
table BrightnessTable No default

BrightnessPoint

Defined in fuchsia.ui.brightness/brightness.fidl

A tuple representing a point on the auto-brightness curve Ambient_lux and nits must be positive values.

NameTypeDescriptionDefault
ambient_lux float32 No default
display_nits float32 No default

BrightnessTable

Defined in fuchsia.ui.brightness/brightness.fidl

A set of points defining the auto-brightness curve. The ambient_lux values must be monotonically increasing.

NameTypeDescriptionDefault
points vector<BrightnessPoint>[50] No default

SomeLongAnonymousPrefix10

generated

anonymous struct

NameTypeDescriptionDefault
color_adjustment ColorAdjustmentTable No default

TABLES

ColorAdjustmentTable

Defined in fuchsia.ui.brightness/color_adjustment.fidl

The table for screen color tint adjustments.

OrdinalNameTypeDescription
1 matrix float32[9]

3x3 Matrix in row-major form which will be used by root presenter to apply color adjustment. This field may be omitted to disable color adjustment.

TYPE ALIASES

NameValueDescription
brightness float32

A normalized relative brightness adjustment in the range 0.0 (off/minimum) to 1.0 (maximum).