Struct fidl_fuchsia_ui_display_color::ConverterProxy

pub struct ConverterProxy { /* private fields */ }

Implementations

impl ConverterProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.ui.display.color/Converter.

pub fn take_event_stream(&self) -> ConverterEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn set_values( &self, properties: &ConversionProperties ) -> QueryResponseFut<i32>

Modifies the color of final display output of rendered content. The sole parameter is a table of |ConversionProperties|, which contains the parameters required to apply the color conversion formula to the display. Please see |ConversionProperties| defined above for more information.

All parameters in the properties table must be normal 32-bit floating point values. If any of the values do not meet this specification, the new color conversion values will not be applied and a value of ZX_ERR_INVALID_ARGS will be returned. Otherwise, the return value will be ZX_OK: https://en.wikipedia.org/wiki/Normal_number_%28computing%29. Once a value of ZX_OK has been returned to the client, the color conversion values are ready to be used in future render calls, including screenshots.

Values in |ConversionProperties| may also be left blank. The default values for each member, if left blank, are as follows: coefficients = [1, 0, 0, 0, 1, 0, 0, 0, 1] (i.e. the identity matrix) preoffsets = [0,0,0] postoffsets = [0,0,0] Thus, ColorConversion can be reset by passing in an empty table to this function.

Hardware that support color conversion generally accept a limited range of coefficient values. Coefficients in the range of [-2, 2] inclusive will be accepted by most hardware. The hardware driver will clamp values that are outside its acceptable range.

preoffsets, postoffsets: Clients are encouraged to produce color conversion values that do not depend on pre and post offsets since some hardware do not have support for that. For cases where pre and post offset values need to be used, the range should be limited to (-1, 1).

pub fn set_minimum_rgb(&self, minimum_rgb: u8) -> QueryResponseFut<bool>

Submits a minimum value that all channels of all pixels rendered to the display are clamped to. This can be used to mitigate the apparent effects of backlight bleeding on certain devices in low-light environments.

The valid range for a minimum value is [0, 255] (inclusive). For a new minimum value M, each color channel’s range will be limited to [M, 255].

Callers should wait for the acknowledgement to return before submitting another call to this function. The minimum_rgb clamping can be removed simply by submitting a value of 0.

Not all hardware supports this feature. So this function returns |true| if successfully applied and |false| if unsupported.

Trait Implementations

impl Clone for ConverterProxy

fn clone(&self) -> ConverterProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConverterProxyInterface for ConverterProxy

type SetValuesResponseFut = QueryResponseFut<i32>

fn set_values( &self, properties: &ConversionProperties ) -> Self::SetValuesResponseFut

type SetMinimumRgbResponseFut = QueryResponseFut<bool>

fn set_minimum_rgb(&self, minimum_rgb: u8) -> Self::SetMinimumRgbResponseFut

impl Debug for ConverterProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Proxy for ConverterProxy

type Protocol = ConverterMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.