Postprocess controller: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(Cleanup, added new keyvalues and input.)
Line 1: Line 1:
{{l4d series point|postprocess_controller}}
{{base point multi|postprocess_controller|game1=Portal 2|game2=Alien Swarm|game3=Left 4 Dead 2|game4=Left 4 Dead}}


==Entity Description==
==Entity Description==
[[File:postprocess_controller.png|left|link=]]
An entity that controls the postprocess settings in the map: film grain, vignette, and local contrast. [[color_correction|Color correction]] is controlled by [[color_correction_(entity)|another entity]]. It may be necessary to have at least one <code>[[fog_volume]]</code> in the map in order for a master <code>postprocess_controller</code> to take effect.
An entity that controls the postprocess settings in the map: film grain, vignette, and local contrast. [[color_correction|Color correction]] is controlled by [[color_correction_(entity)|another entity]]. It may be necessary to have at least one <code>[[fog_volume]]</code> in the map in order for a master <code>postprocess_controller</code> to take effect.
{{clr}}


==Official Campaign Settings==
== Keyvalues ==
The following table shows the post-process settings for each map in the official campaigns.
{{KV|Fade-in time|float}}
{{todo|Tabulate post-process settings from official maps for devs to reference.}}
{{KV|Local contrast strength [-1..x]|float}}
{{KV|Local contrast edge strength [0..1]|float}}
{{KV|Vignette start distance [0..1]|float}}
{{KV|Vignette end distance [0..x]|float}}
{{KV|Vignette blur strength [0..1]|float}}
{{KV|Fade to black strength [0..1]|float}}
{{KV|Film grain strength [0..x]|float|since=L4D2}}
{{KV|Top-of-screen vignette strength [0..1]|float|since=L4D2}}
{{KV|Depth-blur focal plane distance [0..1]|float|since=AS}}
{{KV|Depth-blur effect strength [0..x]|float|since=AS}}
{{KV|Full-screen blur strength [0..1]|float|since=AS}}


==Keyvalues==
{{KV Targetname}}
*{{KV Targetname}}
*{{ScrollBox|title=localcontraststrength|
;  Local contrast strength [-1..x] <[[float]]>
}}
*{{ScrollBox|title=localcontrastedgestrength|
;  Local contrast edge strength [0..1] <[[float]]>
}}
*{{ScrollBox|title=vignettestart|
;  Vignette start distance [0..1] <[[float]]>
}}
*{{ScrollBox|title=vignetteend|
;  Vignette end distance [0..x] <[[float]]>
}}
*{{ScrollBox|title=vignetteblurstrength|
;  Vignette blur strength [0..1] <[[float]]>
}}
*{{ScrollBox|title=grainstrength|
;  Film grain strength [0..1] <[[float]]>
}}
*{{ScrollBox|title=topvignettestrength|
;  Top-of-screen vignette strength [0..1] <[[float]]>
}}
*{{ScrollBox|title=fadetime|
;  Fade-in time <[[float]]>
:Measured in seconds
}}


==Inputs==
== Flags ==
* 1 : Master (Has priority if multiple postprocess_controllers exist)
 
== Inputs ==
{{IO|SetLocalContrastStrength|Set the local contrast strength.|param=float}}
{{IO|SetLocalContrastEdgeStrength|Set the local contrast strength at the edge of the screen (controlled by vignette).|param=float}}
{{IO|SetVignetteStart|Set the vignette start distance (from screen center).|param=float}}
{{IO|SetVignetteEnd|Set the vignette end distance.|param=float}}
{{IO|SetVignetteBlurStrength|Set the strength of the desaturated blur on the vignette.|param=float}}
{{IO|SetFadeToBlackStrength|Set the fadeout strength.|param=float}}
{{IO|SetDepthBlurFocalDistance|Set the focal distance of the depth blur effect (in the range [0,1]).|param=float|since=AS}}
{{IO|SetDepthBlurStrength|Set the depth blur effect strength.|param=float|since=AS}}
{{IO|SetScreenBlurStrength|Set the screen blur effect strength.|param=float|since=AS}}
{{IO|SetFilmGrainStrength|Set the film grain effect strength.|param=float|since=AS}}
{{IO|SetFadeTime|Set the fade time between post process settings.|param=float|since=AS}}
{{I Targetname}}
{{I Targetname}}
{{ScrollBox|title=PostProcess|
; <code>SetLocalContrastStrength <[[float]]></code>
: Set the local contrast strength.
; <code>SetLocalContrastEdgeStrength <[[float]]></code>
: Set the local contrast strength at the edge of the screen (controlled by vignette).
; <code>SetVignetteStart <[[float]]></code>
: Set the vignette start distance (from screen center).
; <code>SetVignetteEnd <[[float]]></code>
: Set the vignette end distance.
; <code>SetVignetteBlurStrength <[[float]]></code>
:Set the strength of the desaturated blur on the vignette.
; <code>SetFadeToBlackStrength <[[float]]></code>
:Set the fadeout strength.
}}


==Outputs==
== Outputs ==
{{O Targetname}}
{{O Targetname}}


Revision as of 23:28, 10 June 2011

Template:Base point multi

Entity Description

Postprocess controller.png

An entity that controls the postprocess settings in the map: film grain, vignette, and local contrast. Color correction is controlled by another entity. It may be necessary to have at least one fog_volume in the map in order for a master postprocess_controller to take effect.

Keyvalues

Fade-in time ([todo internal name (i)]) <float>
Local contrast strength [-1..x] ([todo internal name (i)]) <float>
Local contrast edge strength [0..1] ([todo internal name (i)]) <float>
Vignette start distance [0..1] ([todo internal name (i)]) <float>
Vignette end distance [0..x] ([todo internal name (i)]) <float>
Vignette blur strength [0..1] ([todo internal name (i)]) <float>
Fade to black strength [0..1] ([todo internal name (i)]) <float>
Film grain strength [0..x] ([todo internal name (i)]) <float> (in all games since Left 4 Dead 2)
Top-of-screen vignette strength [0..1] ([todo internal name (i)]) <float> (in all games since Left 4 Dead 2)
Depth-blur focal plane distance [0..1] ([todo internal name (i)]) <float> (in all games since Alien Swarm)
Depth-blur effect strength [0..x] ([todo internal name (i)]) <float> (in all games since Alien Swarm)
Full-screen blur strength [0..1] ([todo internal name (i)]) <float> (in all games since Alien Swarm)


Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Flags

  • 1 : Master (Has priority if multiple postprocess_controllers exist)

Inputs

SetLocalContrastStrength <floatRedirectInput/float>
Set the local contrast strength.
SetLocalContrastEdgeStrength <floatRedirectInput/float>
Set the local contrast strength at the edge of the screen (controlled by vignette).
SetVignetteStart <floatRedirectInput/float>
Set the vignette start distance (from screen center).
SetVignetteEnd <floatRedirectInput/float>
Set the vignette end distance.
SetVignetteBlurStrength <floatRedirectInput/float>
Set the strength of the desaturated blur on the vignette.
SetFadeToBlackStrength <floatRedirectInput/float>
Set the fadeout strength.
SetDepthBlurFocalDistance <floatRedirectInput/float> (in all games since Alien Swarm)
Set the focal distance of the depth blur effect (in the range [0,1]).
SetDepthBlurStrength <floatRedirectInput/float> (in all games since Alien Swarm)
Set the depth blur effect strength.
SetScreenBlurStrength <floatRedirectInput/float> (in all games since Alien Swarm)
Set the screen blur effect strength.
SetFilmGrainStrength <floatRedirectInput/float> (in all games since Alien Swarm)
Set the film grain effect strength.
SetFadeTime <floatRedirectInput/float> (in all games since Alien Swarm)
Set the fade time between post process settings.


Outputs

See also

External links

Art Direction, Part 1: Filmic Effects - Valve blog regarding film effects in Left 4 Dead

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Postprocess_controller&oldid=152656"