Env dof controller: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(updates)
Line 1: Line 1:
{{base point|env_dof_controller|engine=Source|since=Left 4 Dead}}
{{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.


==Entity description==
{{code class|CEnvDOFController|env_dof_controller.cpp}}
[[File:env_dof_controller.png|left|link=]]
This entity controls the [[W:depth of field|depth of field]] settings for all players.{{clr}}


== Keyvalues ==
{{clr}}
{{KV|Enabled|boolean|Whether the effect should be active}}
{{KV|Near blur depth|float|Distance that the blurriness is at its peak near the viewpoint.}}
{{KV|Near focus depth|float|Distance that the focus is in full effect near the viewpoint.}}
{{KV|Near blur radius|float|Radius (in pixels) to blur the surrounding pixels.}}
{{KV|Far blur depth|float|Distance where blurriness is at its peak far from the viewpoint.}}
{{KV|Far focus depth|float|Distance that the focus is in full effect far from the viewpoint.}}
{{KV|Far blur radius|float|Radius (in pixels) to blur the surrounding pixels.}}
{{KV|Focus target|target_source|Entity to use as a focal point.}}
{{KV|Focus target range|float|Distance behind the focal plane to remain in focus.}}
{{KV Targetname}}


== Inputs ==
==Keyvalues==
{{IO|SetNearBlurDepth|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.|param=float}}
{{KV|Enabled (enabled)|since=AS|boolean|Whether the effect should begin active. If it starts inactive, it must be enabled with <codde>SetNearBlurRadius</code> or <code>SetFarBlurRadius</code>.}}
{{IO|SetNearFocusDepth|The area between the near focus and far focus distances is perfectly in focus. Must be smaller than FarFocusDepth.|param=float}}
{{KV|Near blur depth (near_blur)|since=AS|float|Distance that the blurriness is at its peak near the viewpoint.}}
{{IO|SetFarFocusDepth|The area between the near focus and far focus distances is perfectly in focus. Must be smaller than FarBlurDepth.|param=float}}
{{KV|Near focus depth (near_focus)|since=AS|float|Distance that the focus is in full effect near the viewpoint.}}
{{IO|SetFarBlurDepth|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.|param=float}}
{{KV|Near blur radius (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 focus depth (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|Focus target (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 BaseEntity}}
 
==Inputs==
{{IO|SetNearBlurDepth|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.|param=float}}
{{IO|SetNearFocusDepth|The area between the near focus and far focus distances is perfectly in focus. Must be smaller than the far focus depth.|param=float}}
{{IO|SetFarFocusDepth|The area between the near focus and far focus distances is perfectly in focus. Must be smaller than the far blur depth.|param=float}}
{{IO|SetFarBlurDepth|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.|param=float}}
{{IO|SetNearBlurRadius|Set the blur radius (in pixels) to use at the near blur distance. Set to 0 to disable near blur.|param=float}}
{{IO|SetNearBlurRadius|Set the blur radius (in pixels) to use at the near blur distance. Set to 0 to disable near blur.|param=float}}
{{IO|SetFarBlurRadius|Set the blur radius (in pixels) to use at the far blur distance. Set to 0 to disable far blur.|param=float}}
{{IO|SetFarBlurRadius|Set the blur radius (in pixels) to use at the far blur distance. Set to 0 to disable far blur.|param=float}}
{{IO|SetFocusTarget|Set the focal target for the effect.|param=string}}
{{IO|SetFocusTarget|since=AS|Set the focal target for the effect.|param=string}}
{{IO|SetFocusTargetRange|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 Targetname}}
{{I BaseEntity}}


== Outputs ==
==Outputs==
{{O Targetname}}
{{O BaseEntity|l4d=1}}

Revision as of 15:28, 23 September 2018

English (en)中文 (zh)Translate (Translate)
Env dof controller.png

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

C++ In code, it is represented by theCEnvDOFControllerclass, defined in theenv_dof_controller.cppfile.

Keyvalues

Enabled (enabled) ([todo internal name (i)]) <boolean> (in all games since Alien Swarm)
Whether the effect should begin active. If it starts inactive, it must be enabled with <codde>SetNearBlurRadius or SetFarBlurRadius.
Near blur depth (near_blur) ([todo internal name (i)]) <float> (in all games since Alien Swarm)
Distance that the blurriness is at its peak near the viewpoint.
Near focus depth (near_focus) ([todo internal name (i)]) <float> (in all games since Alien Swarm)
Distance that the focus is in full effect near the viewpoint.
Near blur radius (near_radius) ([todo internal name (i)]) <float> (in all games since Alien Swarm)
Radius (in pixels) to blur the surrounding pixels.
Far blur depth (far_blur) ([todo internal name (i)]) <float> (in all games since Alien Swarm)
Distance where blurriness is at its peak far from the viewpoint.
Far focus depth (far_focus) ([todo internal name (i)]) <float> (in all games since Alien Swarm)
Distance that the focus is in full effect far from the viewpoint.
Far blur radius (far_radius) ([todo internal name (i)]) <float> (in all games since Alien Swarm)
Radius (in pixels) to blur the surrounding pixels.
Focus target (focus_target) ([todo internal name (i)]) <string> (in all games since Alien Swarm)
Entity to use as a focal point.
Focus target range (focus_range) ([todo internal name (i)]) <float> (in all games since Alien Swarm)
Distance behind the focal plane to remain in focus.


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.


Outputs

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