class BacklightInterface

Defined at line 15 of file ../../src/graphics/display/lib/api-protocols/cpp/backlight-interface.h

The methods in the [`fuchsia.hardware.backlight/Device`] FIDL interface.

Public Methods

void BacklightInterface ()

Defined at line 17 of file ../../src/graphics/display/lib/api-protocols/cpp/backlight-interface.h

void BacklightInterface (const BacklightInterface & )

Defined at line 19 of file ../../src/graphics/display/lib/api-protocols/cpp/backlight-interface.h

void BacklightInterface (BacklightInterface && )

Defined at line 20 of file ../../src/graphics/display/lib/api-protocols/cpp/backlight-interface.h

zx::result<float> GetMaxBrightnessNits ()

Retrieves the maximum device brightness, if known.

If successful, the returned value is guaranteed to be positive.

Errors with ZX_ERR_NOT_SUPPORTED if the driver does not provide

guarantees around the amount of light emitted.

zx::result<BacklightState> GetBacklightState ()

Retrieves the device state.

If successful, the returned value is guaranteed to be valid.

zx::result<> SetBacklightState (const BacklightState & state)

Sets the device state.

`Backlight::brightness_nits` has precedence over

`Backlight::brightness_fraction`. More precisley, if

`Backlight::brightness_nits` is populated (not nullopt), the backlight

brightness is derived from it, and `Backlight::brightness_fraction` is

ignored.

Errors if ZX_ERR_NOT_SUPPORTED if `Backlight::brightness_nits` is populated

and the driver does not support absolute brightness.

BacklightInterface & operator= (const BacklightInterface & )

Defined at line 21 of file ../../src/graphics/display/lib/api-protocols/cpp/backlight-interface.h

BacklightInterface & operator= (BacklightInterface && )

Defined at line 22 of file ../../src/graphics/display/lib/api-protocols/cpp/backlight-interface.h

Protected Methods

void ~BacklightInterface ()

Destruction via base class pointer is not supported intentionally.

Instances are not expected to be owned by pointers to base classes.

Defined at line 52 of file ../../src/graphics/display/lib/api-protocols/cpp/backlight-interface.h