fuchsia.ui.display.singleton

Added: 12

PROTOCOLS

DisplayPower

Defined in fuchsia.ui.display.singleton/power.fidl

Controls the power state of the default display device.

Added: HEAD

SetDisplayPower

Set the power state of the default connected display device to power_on.

When successfull, the connected display is turned on or off. Once the display device is turned off, fuchsia.hardware.display/Coordinator clients will not receive OnVsync events anymore until the display device is turned on again.

Fails with ZX_ERR_NOT_SUPPORTED if the connected display fails to turn on/off.

All display devices are turned on by default.

Request

NameType
power_on bool

Response

NameType
payload DisplayPower_SetDisplayPower_Result

Info

Defined in fuchsia.ui.display.singleton/info.fidl

Get information about Scenic's primary display.

GetMetrics

Request

<EMPTY>

Response

NameType
info Metrics

STRUCTS

DisplayPower_SetDisplayPower_Response

Defined in fuchsia.ui.display.singleton/power.fidl

<EMPTY>

TABLES

Metrics

Defined in fuchsia.ui.display.singleton/info.fidl

Describes the physical display, and how to map between physical and logical pixels.

OrdinalFieldTypeDescription
extent_in_px fuchsia.math/SizeU

Same meaning as horizontal_resolution and vertical_resolution in fuchsia.hardware.display.Mode. Given in physical pixels.

extent_in_mm fuchsia.math/SizeU

Same meaning as horizontal_size_mm and vertical_size_mm in fuchsia.hardware.display.Info.

recommended_device_pixel_ratio fuchsia.math/VecF

The number of physical pixels per "logical" pixel, for example as in fuchsia.ui.composition.LayoutInfo.logical_size. It provides an indication of the size of image buffers that should be allocated. This value would typically be used by a component near the root of the scene graph to set a scale for the rest of the scene beneath.

maximum_refresh_rate_in_millihertz uint32

The maximum mumber of images transmitted to the display in 1000 seconds. This is the display's maximum vertical refresh rate, in millihertz (0.001 Hz).

Added: 16

UNIONS

DisplayPower_SetDisplayPower_Result strict

Defined in fuchsia.ui.display.singleton/power.fidl

OrdinalVariantTypeDescription
response DisplayPower_SetDisplayPower_Response
err zx/Status