Share via


OutlineSettings Class

Definition

Global settings for outline rendering.

public ref class OutlineSettings
public class OutlineSettings
type OutlineSettings = class
Public Class OutlineSettings
Inheritance
OutlineSettings

Properties

Color

The color of the outlines.

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].

MaskRotationAngle

Defines the mask's rotation angle in degree.

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.

MaskRotationSpeed

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

MaskScale

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

MaskScaleToFit

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

MaskScrollSpeed

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

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.

PulseIntensity

The intensity with which the outline pulses.

PulseRateHz

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

Valid

Whether this object is still valid.

Applies to

See also