Env dof controller: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(-added class hierarchy, cleanup)
Line 1: Line 1:
{{lang|Env dof controller}}
{{lang|Env dof controller}}
[[File:env_dof_controller.png|left|link=]]{{base point|env_dof_controller|engine=Source|since=Left 4 Dead}} This entity controls the [[W:depth of field|depth of field]] settings for all players.
{{CD|CEnvDOFController|file1=env_dof_controller.cpp}}
 
[[File:env_dof_controller.png|left|link=]]{{entity|type=e0|env_dof_controller|since=Left 4 Dead}} This entity controls the [[W:depth of field|depth of field]] settings for all players.
{{code class|CEnvDOFController|env_dof_controller.cpp}}


{{clr}}
{{clr}}


==Keyvalues==
==Keyvalues==
{{KV|Enabled (enabled)|since=AS|boolean|Whether the effect should begin active. If it starts inactive, it must be enabled with <code>SetNearBlurRadius</code> or <code>SetFarBlurRadius</code>.}}
{{KV|Enabled|intn=enabled|since=AS|boolean|Whether the effect should begin active. If it starts inactive, it must be enabled with <code>SetNearBlurRadius</code> or <code>SetFarBlurRadius</code>.}}
{{KV|Near blur depth (near_blur)|since=AS|float|Distance that the blurriness is at its peak near the viewpoint.}}
{{KV|Near blur depth|intn=near_blur|since=AS|float|Distance that the blurriness is at its peak near the viewpoint.}}
{{KV|Near focus depth (near_focus)|since=AS|float|Distance that the focus is in full effect near the viewpoint.}}
{{KV|Near focus depth|intn=near_focus|since=AS|float|Distance that the focus is in full effect near the viewpoint.}}
{{KV|Near blur radius (near_radius)|since=AS|float|Radius (in pixels) to blur the surrounding pixels.}}
{{KV|Near blur radius|intn=near_radius|since=AS|float|Radius (in pixels) to blur the surrounding pixels.}}
{{KV|Far blur depth (far_blur)|since=AS|float|Distance where blurriness is at its peak far from the viewpoint.}}
{{KV|Far blur depth|intn=far_blur|since=AS|float|Distance where blurriness is at its peak far from the viewpoint.}}
{{KV|Far focus depth (far_focus)|since=AS|float|Distance that the focus is in full effect far from the viewpoint.}}
{{KV|Far focus depth|intn=far_focus|since=AS|float|Distance that the focus is in full effect far from the viewpoint.}}
{{KV|Far blur radius (far_radius)|since=AS|float|Radius (in pixels) to blur the surrounding pixels.}}
{{KV|Far blur radius|intn=far_radius|since=AS|float|Radius (in pixels) to blur the surrounding pixels.}}
{{KV|Focus target (focus_target)|since=AS|target_source|Entity to use as a focal point.}}
{{KV|Focus target|intn=focus_target|since=AS|target_source|Entity to use as a focal point.}}
{{KV|Focus target range (focus_range)|since=AS|float|Distance behind the focal plane to remain in focus.}}
{{KV|Focus target range|intn=focus_range|since=AS|float|Distance behind the focal plane to remain in focus.}}
{{KV BaseEntity}}
{{KV Targetname}}


==Inputs==
==Inputs==
Line 27: Line 26:
{{IO|SetFocusTarget|since=AS|Set the focal target for the effect.|param=string}}
{{IO|SetFocusTarget|since=AS|Set the focal target for the effect.|param=string}}
{{IO|SetFocusTargetRange|since=AS|Set the distance behind the focal point that will remain in focus.|param=float}}
{{IO|SetFocusTargetRange|since=AS|Set the distance behind the focal point that will remain in focus.|param=float}}
{{I BaseEntity}}
==Outputs==
{{O BaseEntity|l4d=1}}

Revision as of 06:09, 6 August 2023

English (en)中文 (zh)Translate (Translate)
C++ Class hierarchy
CEnvDOFController
CPointEntity
CBaseEntity
C++ env_dof_controller.cpp
Env dof controller.png

Template:Entity This entity controls the depth of field settings for all players.

Keyvalues

Enabled (enabled) <boolean> (in all games since Alien Swarm)
Whether the effect should begin active. If it starts inactive, it must be enabled with SetNearBlurRadius or SetFarBlurRadius.
Near blur depth (near_blur) <float> (in all games since Alien Swarm)
Distance that the blurriness is at its peak near the viewpoint.
Near focus depth (near_focus) <float> (in all games since Alien Swarm)
Distance that the focus is in full effect near the viewpoint.
Near blur radius (near_radius) <float> (in all games since Alien Swarm)
Radius (in pixels) to blur the surrounding pixels.
Far blur depth (far_blur) <float> (in all games since Alien Swarm)
Distance where blurriness is at its peak far from the viewpoint.
Far focus depth (far_focus) <float> (in all games since Alien Swarm)
Distance that the focus is in full effect far from the viewpoint.
Far blur radius (far_radius) <float> (in all games since Alien Swarm)
Radius (in pixels) to blur the surrounding pixels.
Focus target (focus_target) <string> (in all games since Alien Swarm)
Entity to use as a focal point.
Focus target range (focus_range) <float> (in all games since Alien Swarm)
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 the near focus death.
SetNearFocusDepth <floatRedirectInput/float>
The area between the near focus and far focus distances is perfectly in focus. Must be smaller than the far focus depth.
SetFarFocusDepth <floatRedirectInput/float>
The area between the near focus and far focus distances is perfectly in focus. Must be smaller than the far blur depth.
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 the far focus depth.
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> (in all games since Alien Swarm)
Set the focal target for the effect.
SetFocusTargetRange <floatRedirectInput/float> (in all games since Alien Swarm)
Set the distance behind the focal point that will remain in focus.