Struct VignetteSettings

Namespace: ValveResourceFormat.Renderer.SceneEnvironment
Assembly: Renderer.dll

Vignette that darkens the screen outside of a rounded shape around its center.

public readonly struct VignetteSettings

Properties

Center

Gets the center of the vignette in screen space, from -1 to 1.

public Vector2 Center { get; init; }

Property Value

Vector2

Exponent

Gets the exponent of the norm the distance from the center is measured in.

public float Exponent { get; }

Property Value

float

Feather

Gets the distance over which the darkening fades in.

public float Feather { get; init; }

Property Value

float

Radius

Gets the distance from the center at which the darkening starts.

public float Radius { get; init; }

Property Value

float

Roundness

Gets how round the shape is: 0 is closest to a rectangle, 1 is an ellipse.

public float Roundness { get; init; }

Property Value

float

Scale

Gets the multiplier of the fully vignetted area. Meaningful only for a negative VignetteSettings.Strength.

public float Scale { get; }

Property Value

float

Strength

Gets the darkening strength. Only negative values, which darken, are applied.

public float Strength { get; init; }

Property Value

float

Tint

Gets the color the darkened area is tinted with.

public Vector3 Tint { get; init; }

Property Value

Vector3

Methods

Blend(float, in VignetteSettings, in VignetteSettings)

Linearly interpolates between two vignette settings.

public static VignetteSettings Blend(float weight, in VignetteSettings a, in VignetteSettings b)

Parameters

weight float

Blend factor in the range [0, 1]; 0 returns a, 1 returns b.

a VignetteSettings

The first (start) vignette settings.

b VignetteSettings

The second (end) vignette settings.

Returns

VignetteSettings

ParseFromKVObject(KVObject)

Parses a VignetteSettings from a KV object.

public static VignetteSettings ParseFromKVObject(KVObject data)

Parameters

data KVObject

Returns

VignetteSettings

See Also

PostProcessingVignetteParameters_t