s&
About
The Project
info
About s&box
map
Roadmap
monitoring
Metrics
Engine startup and usage numbers
Updates
newspaper
Latest News
published_with_changes
Changes
Release-by-release changelog
Games
Browse Games
Discover Games
gamejams
Workshop
Playable
sports_esports
Games
Standalone games and gamemodes
Assets
landscape
Maps
view_in_ar
Models
texture
Materials
apparel
Clothing
apps
Everything
Every asset type in one list
Forum
Learn
Documentation
rocket_launch
Getting Started
docs
Documentation
api
API Reference
Resources
school
Tutorials
manage_search
Code Search
Get s&box
Sign in with Steam
Api
Components
BasePostProcess
chevron_left
Components
class
BasePostProcess
Constructors
lock
BasePostProcess
Fields
lock
Attributes
Properties
lock
Camera
data_object
IsCameraEffect
lock
TargetCamera
Methods
lock
Blit
lock
BlitSimple
lock
InsertCommandList
functions
Render
BasePostProcess
The base class for all post process effects.
class
Sandbox
.
account_tree
extends
Component
abstract
Sandbox.Engine
build
Constructors
1
BasePostProcess
(
)
crop_din
Fields
1
Attributes
RenderAttributes
The default attributes for this post process. This will be used by helper functions like Blit.
data_object
Properties
3
Camera
CameraComponent
The camera we're being applied to. This is only valid during the Render call.
IsCameraEffect
bool
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.
TargetCamera
SceneCamera
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.
functions
Methods
4
Blit
(
blit
,
debugName
)
Helper to do a blit with the current camera's post process
BlitSimple
(
shader
,
stage
,
order
,
debugName
)
Helper to do a blit with the current camera's post process
InsertCommandList
(
cl
,
stage
,
order
,
debugName
)
Helper to add a command list to the current camera's post process
Render
(
)
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.
Inheritance
Component
BasePostProcess
BasePostProcess<T>
AmbientOcclusion
BlitOverlay
Bloom
Blur
ChromaticAberration
ColorAdjustments
ColorGrading
DepthOfField
FilmGrain
Fog
Highlight
MotionBlur
Pixelate
Sharpen
Tonemapping
Vignette
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.