Partilhar via


Class ShellRenderingSettings

Global settings for objects rendered using the hierarchical override shell effect.

class Microsoft::Azure::RemoteRendering::ShellRenderingSettings final

Properties

Desaturation

Amount of color de-saturation to apply to the shell-rendered objects. Ranges from 0 (original color) to 1 (gray scale).

A Result.InvalidParam error occurs if a value outside the [0;1] range is passed in.

auto GetDesaturation() const noexcept -> float;
auto SetDesaturation(float value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

Opacity

The opacity of shell-rendered geometry. Ranges from 0 (invisible) to 1 (fully opaque).

A Result.InvalidParam error occurs if a value outside the [0;1] range is passed in.

auto GetOpacity() const noexcept -> float;
auto SetOpacity(float value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

Valid

Whether this object is still valid.

An object is invalid if it has been destroyed or if the connection has been lost. It is an error to call any other function on an invalid object.

auto GetValid() const noexcept -> bool;

See also