Struct BloomSettings

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

Bloom effect parameters including threshold, intensity, and per-mip blur settings.

public readonly struct BloomSettings

Constructors

BloomSettings()

Initializes bloom settings with the default per-mip weights and tints.

public BloomSettings()

Fields

NumBlurBuffers

Number of bloom blur buffers (1/2 through 1/32 resolution).

public const int NumBlurBuffers = 5

Field Value

int

Properties

AddBloomStrength

Gets the additive bloom strength.

public float AddBloomStrength { get; init; }

Property Value

float

BlendMode

Gets the compositing blend mode used to apply bloom.

public BloomBlendType BlendMode { get; init; }

Property Value

BloomBlendType

BloomStartValue

Gets the minimum luminance value that begins contributing to bloom.

public float BloomStartValue { get; init; }

Property Value

float

BloomStrength

Gets the effective bloom strength for the current BloomSettings.BlendMode.

public float BloomStrength { get; }

Property Value

float

BloomThreshold

Gets the luminance threshold above which pixels contribute to bloom.

public float BloomThreshold { get; init; }

Property Value

float

BloomThresholdWidth

Gets the width of the soft threshold knee for bloom.

public float BloomThresholdWidth { get; init; }

Property Value

float

BlurBloomStrength

Gets the blur-blend bloom strength.

public float BlurBloomStrength { get; init; }

Property Value

float

BlurTint

Gets the per-mip color tints for the five blur buffers.

public BloomSettings.BlurTints BlurTint { get; init; }

Property Value

BloomSettings.BlurTints

BlurWeight

Gets the per-mip blur weights for the five blur buffers (1/2 through 1/32 resolution).

public BloomSettings.BlurWeights BlurWeight { get; init; }

Property Value

BloomSettings.BlurWeights

ScreenBloomStrength

Gets the screen-blend bloom strength.

public float ScreenBloomStrength { get; init; }

Property Value

float

SkyboxBloomStrength

Gets the strength multiplier applied to skybox pixels in bloom.

public float SkyboxBloomStrength { get; init; }

Property Value

float

Methods

Blend(float, in BloomSettings, in BloomSettings)

Linearly interpolates between two bloom settings. The three mode strengths blend independently, which is also how the composite shader weighs the modes against each other.

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

Parameters

weight float

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

a BloomSettings

The first (start) bloom settings.

b BloomSettings

The second (end) bloom settings.

Returns

BloomSettings

ParseFromKVObject(KVObject)

Parses a BloomSettings from a KV object.

public static BloomSettings ParseFromKVObject(KVObject data)

Parameters

data KVObject

Returns

BloomSettings

See Also

PostProcessingBloomParameters_t