BasePostProcessclass

The base class for all post process effects.

object→Component→BasePostProcess
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public abstract class Sandbox.BasePostProcess : Sandbox.Component

Constructors1

Showing 1 constructors

Methods4

Showing 4 methods

protected void Blit(Sandbox.BasePostProcess.BlitMode blit, string debugName)PROTECTED

Helper to do a blit with the current camera's post process

ParameterTypeDescription
blitBlitMode—
debugNamestring—
Returns:void—

protected void BlitSimple(Sandbox.Material shader, Sandbox.Rendering.Stage stage, int order, string debugName)PROTECTED

Helper to do a blit with the current camera's post process

ParameterTypeDescription
shaderMaterial—
stageStage—
orderint—
debugNamestring—
Returns:void—

protected void InsertCommandList(Sandbox.Rendering.CommandList cl, Sandbox.Rendering.Stage stage, int order, string debugName)PROTECTED

Helper to add a command list to the current camera's post process

ParameterTypeDescription
clCommandList—
stageStage—
orderint—
debugNamestring—
Returns:void—

public virtual void Render()PUBLICVIRTUAL

Build command lists, or apply settings to TargetCamera when IsCameraEffect is true. Called on the main thread with the camera's weighted effect instances available through GetWeighted.

Returns:void—

Properties3

Showing 3 properties

public virtual bool Sandbox.BasePostProcess.IsCameraEffect { get; set; }PUBLICVIRTUALGETSET

Build this effect when preparing a render camera, instead of building command lists at the end of the update. Camera effects can supply settings through TargetCamera and use scene-wide defaults outside cameras and volumes. This declaration must be the same for every instance of an effect type.

Returns:bool—

protected Sandbox.SceneCamera Sandbox.BasePostProcess.TargetCamera { get; set; }PROTECTEDGETSET

The render camera receiving this effect's settings. Only available during Render for camera effects. This may be an editor viewport or capture rather than Camera.SceneCamera.

Returns:SceneCamera—

On this page