Share via

Class OutlineSettings

  • Article

Global settings for outline rendering.

class Microsoft::Azure::RemoteRendering::OutlineSettings final

Properties

Color

The color of the outlines.

auto GetColor() const noexcept -> Microsoft::Azure::RemoteRendering::Color4Ub;
auto SetColor(Microsoft::Azure::RemoteRendering::Color4Ub const& value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

MaskOffset

Applies a horizontal/vertical offset to the mask transform. This offset is applied at the very end in screen-space, where the screen range is mapped to [0..1].

This parameter is ignored if no OutlineSettings.MaskTexture is set.

auto GetMaskOffset() const noexcept -> Microsoft::Azure::RemoteRendering::Float2;
auto SetMaskOffset(Microsoft::Azure::RemoteRendering::Float2 const& value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

MaskRotationAngle

Defines the mask's rotation angle in degree.

This parameter is ignored if no OutlineSettings.MaskTexture is set.

auto GetMaskRotationAngle() const noexcept -> float;
auto SetMaskRotationAngle(float value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

MaskRotationCenter

Defines a the relative rotation center that is used to rotate the texture. The default is (0.5; 0.5), which is the center of the texture.

This parameter is ignored if no OutlineSettings.MaskTexture is set.

auto GetMaskRotationCenter() const noexcept -> Microsoft::Azure::RemoteRendering::Float2;
auto SetMaskRotationCenter(Microsoft::Azure::RemoteRendering::Float2 const& value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

MaskRotationSpeed

Defines the mask's rotation speed, measured in degree per second.

This parameter is ignored if no OutlineSettings.MaskTexture is set.

auto GetMaskRotationSpeed() const noexcept -> float;
auto SetMaskRotationSpeed(float value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

MaskScale

Applies additional scaling (horizontal and vertically) to the mask texture. A scaling of (1;1) displays the texture in actual pixel size.

This parameter is ignored if no OutlineSettings.MaskTexture is set.

auto GetMaskScale() const noexcept -> Microsoft::Azure::RemoteRendering::Float2;
auto SetMaskScale(Microsoft::Azure::RemoteRendering::Float2 const& value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

MaskScaleToFit

If enabled, the mask will be scaled so that it fits the viewport size rather than texture pixel size. The scaling factors OutlineSettings.MaskScale will be applied on top.

This parameter is ignored if no OutlineSettings.MaskTexture is set.

auto GetMaskScaleToFit() const noexcept -> bool;
auto SetMaskScaleToFit(bool value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

MaskScrollSpeed

Defines a scroll speed for OutlineSettings.MaskOffset. The final offset used for rendering is computed as FinalOffset = MaskOffset + MaskScrollSpeed * globalTimeInSeconds.

This parameter is ignored if no OutlineSettings.MaskTexture is set.

auto GetMaskScrollSpeed() const noexcept -> Microsoft::Azure::RemoteRendering::Float2;
auto SetMaskScrollSpeed(Microsoft::Azure::RemoteRendering::Float2 const& value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

MaskTexture

The outline color can be masked by the color of a screen-aligned texture. By default, no mask is set. A texture can be loaded through . This must be a 2d texture.

auto GetMaskTexture() const noexcept -> ApiHandle<Microsoft::Azure::RemoteRendering::Texture>;
auto SetMaskTexture(ApiHandle<Microsoft::Azure::RemoteRendering::Texture> const& value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

See also

PulseIntensity

The intensity with which the outline pulses.

This value must be in (0..1) range with 0=no pulsing effect and 1=full amplitude.

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

auto GetPulseIntensity() const noexcept -> float;
auto SetPulseIntensity(float value) noexcept -> Microsoft::Azure::RemoteRendering::Status;

PulseRateHz

The rate (in Hz) at which the outline intensity oscillates.

A Result.InvalidParam error occurs if the value is negative, NaN or infinite.

auto GetPulseRateHz() const noexcept -> float;
auto SetPulseRateHz(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