s&box docs
API ReferenceSandbox

PostProcessVolumeclass

A volume that defines a region in the scene where post processing effects will be applied.

object→VolumeComponent→PostProcessVolume
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public class Sandbox.PostProcessVolume : Sandbox.Volumes.VolumeComponent

Constructors1

Showing 1 constructors

Methods1

Showing 1 methods

public float GetWeight(Vector3 pos)PUBLIC

Get weight based on position within the volume. Nonpositive blend distances use the full blend weight for a hard edge; callers handle volume containment.

ParameterTypeDescription
posVector3—
Returns:float—

Properties4

Showing 4 properties

public float Sandbox.PostProcessVolume.BlendDistance { get; set; }PUBLICGETSET

Distance from the edge of the volume where blending starts. 0 means hard edge, higher values create softer transitions.

Returns:float—

public bool Sandbox.PostProcessVolume.EditorPreview { get; set; }PUBLICGETSET

Preview the post processing when this object is selected in the editor, or when the editor camera is inside the volume.

Returns:bool—

public int Sandbox.PostProcessVolume.Priority { get; set; }PUBLICGETSET

Higher priority volumes override lower priority ones. The default priority is 0.

Returns:int—

Related Guides

→Post Processing→PostProcessVolume

PostProcessSystem.ctor()

Previous Page

BlendDistance

Next Page

On this page

Constructorspublic PostProcessVolume()Methodspublic System.Single GetWeight(Vector3 pos)Propertiespublic System.Single Sandbox.PostProcessVolume.BlendDistance { get; set; }public System.Single Sandbox.PostProcessVolume.BlendWeight { get; set; }public System.Boolean Sandbox.PostProcessVolume.EditorPreview { get; set; }public System.Int32 Sandbox.PostProcessVolume.Priority { get; set; }Metadata