Env dof controller: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (the l4d series have this entity, too)
No edit summary
Line 1: Line 1:
{{base point multi|env_dof_controller|game1=Portal 2|game2=Alien Swarm|game3=Left 4 Dead 2|game4=Left 4 Dead}}
[[File:env_dof_controller.png|left|link=]]


== Entity description ==
{{base point|env_dof_controller|engine=Source|since=Left 4 Dead}} It controls the [[W:depth of field|depth of field]] settings for all players.{{clr}}
[[File:env_dof_controller.png|left|link=]]
An entity that controls the [[depth of field]] settings for the player. Depth of field simulates camera blur of out-of-focus regions of the scene.
{{clr}}


== Keyvalues ==
== Keyvalues ==

Revision as of 04:39, 15 June 2011

Env dof controller.png

Template:Base point It controls the depth of field settings for all players.

Keyvalues

Enabled ([todo internal name (i)]) <boolean>
Whether the effect should be active
Near blur depth ([todo internal name (i)]) <float>
Distance that the blurriness is at its peak near the viewpoint.
Near focus depth ([todo internal name (i)]) <float>
Distance that the focus is in full effect near the viewpoint.
Near blur radius ([todo internal name (i)]) <float>
Radius (in pixels) to blur the surrounding pixels.
Far blur depth ([todo internal name (i)]) <float>
Distance where blurriness is at its peak far from the viewpoint.
Far focus depth ([todo internal name (i)]) <float>
Distance that the focus is in full effect far from the viewpoint.
Far blur radius ([todo internal name (i)]) <float>
Radius (in pixels) to blur the surrounding pixels.
Focus target ([todo internal name (i)]) <string>
Entity to use as a focal point.
Focus target range ([todo internal name (i)]) <float>
Distance behind the focal plane to remain in focus.
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

Inputs

SetNearBlurDepth <floatRedirectInput/float>
Set the distance in front of the focus region at which the scene will be completely blurred using the near blur radius. Must be smaller than NearFocusDepth.
SetNearFocusDepth <floatRedirectInput/float>
The area between the near focus and far focus distances is perfectly in focus. Must be smaller than FarFocusDepth.
SetFarFocusDepth <floatRedirectInput/float>
The area between the near focus and far focus distances is perfectly in focus. Must be smaller than FarBlurDepth.
SetFarBlurDepth <floatRedirectInput/float>
Set the distance beyond the focus region at which the scene will be completely blurred using the far blur radius. Must be larger than FarFocusDepth.
SetNearBlurRadius <floatRedirectInput/float>
Set the blur radius (in pixels) to use at the near blur distance. Set to 0 to disable near blur.
SetFarBlurRadius <floatRedirectInput/float>
Set the blur radius (in pixels) to use at the far blur distance. Set to 0 to disable far blur.
SetFocusTarget <stringRedirectInput/string>
Set the focal target for the effect.
SetFocusTargetRange <floatRedirectInput/float>
Set the distance behind the focal point that will remain in focus.


Outputs