This article's documentation is for anything that uses the Source engine. Click here for more information.

env_tonemap_controller

From Valve Developer Community
Jump to: navigation, search
Env tonemap controller.png

env_tonemap_controller is a point entity available in all Source Source games.

English (en)
Edit

It controls the HDR tonemapping for the player. Think of it as a method of controlling the exposure of the player's eyes. Tonemapping affect all players in multiplayer. HDR settings should normally be changed through triggers, whenever transitioning between environments of different light levels (or for multiplayer, at the start of the map via logic_auto).

class hierarchy
CEnvTonemapController defined in env_tonemap_controller.cpp
CPointEntity
CBaseEntity

Flags

  •  [1] : Master (Has priority if multiple env_tonemap_controller entities exist) (in all games since Left 4 Dead)

Keyvalues


Targetname:
Name (targetname) <string>
The targetname that other entities refer to this entity by.
bUseNextGenBloom (bUseNextGenBloom) <choices> (only in Black Mesa)
  • 0: NO
  • 1: YES
bUseCusBloomNG_Threshold (bUseCusBloomNG_Threshold) <choices> (only in Black Mesa)
  • 0: NO
  • 1: YES
Icon-Important.pngImportant:Most new Black Mesa Black Mesa keyvalues and I/O doesn't work if this keyvalue use choice NO.
Examples


fCusBloomNG_Threshold (fCusBloomNG_Threshold) <float> (only in Black Mesa)
Threshold for bright pass filter. Determines the influence of tonemapping; with high values, only brightest parts of frame will be bloomed.
Note.pngNote:The default value from fgd is 1, which is incorrect. The default value is 0.1.
Note.pngNote:A value of 0 means all pixels contribute to bloom, and is considered the most physically accurate setting.
bUseCusBloomNG_tintExponent (bUseCusBloomNG_tintExponent) <choices> (only in Black Mesa)
  • 0: NO
  • 1: YES
m_fCustomBloomNextGen_r (m_fCustomBloomNextGen_r) <float> (only in Black Mesa)
Determines the influence for reder tones in frame.
Note.pngNote:The default value from fgd is 1, which is incorrect. The default value is 0.25.
m_fCustomBloomNextGen_g (m_fCustomBloomNextGen_g) <float> (only in Black Mesa)
Determines the influence for greener tones in frame.
Note.pngNote:The default value from fgd is 1, which is incorrect. The default value is 0.25.
m_fCustomBloomNextGen_b (m_fCustomBloomNextGen_b) <float> (only in Black Mesa)
Determines the influence for bluer tones in frame.
Note.pngNote:The default value from fgd is 1, which is incorrect. The default value is 0.25.
m_fCusBloomNG_exponent (m_fCusBloomNG_exponent) <float> (only in Black Mesa)
Determines the tightness of the bloom.
Note.pngNote:The default value from fgd is 1, which is incorrect. The default value is 2.2.

Inputs

SetTonemapScale <float> (not in Counter-Strike: Global Offensive)
Sets the player's tonemap scale. It should be a value between 0 and 2, where 0 is the eyes fully closed, 1 is use the unchanged autoexposure (default), and 2 is the eye fully wide open.
BlendTonemapScale <string> (not in Counter-Strike: Global Offensive)
Blends from the player's current tonemap scale to a new one. The parameter syntax is as follows: <target tonemap scale> <blend duration>. For example: 0.5 10 would blend from the current tonemap scale to 0.5 over a period of 10 seconds.
UseDefaultAutoExposure
Reverts to using the default tonemap auto exposure.
UseDefaultBloomScale  !FGD
Reverts to using the default bloom scale.
SetAutoExposureMin <float>
Sets a custom tonemap auto exposure minimum.
SetAutoExposureMax <float>
Sets a custom tonemap auto exposure maximum.
SetBloomScale <float>
Sets a custom bloom scale.
SetBloomScaleRange <vector> !FGD
Sets a range for the bloom scale. First number is the maximum, second number is the minimum.
Icon-Bug.pngBug:Broken. The code that processes this input has its formatting and source reversed.
SetTonemapRate <float>
Sets the rate for autoexposure adjustment (mat_hdr_manual_tonemap_rate).
SetBloomExponent <float> (in all games since Left 4 Dead)
Sets a custom bloom exponent.
SetBloomSaturation <float> (in all games since Left 4 Dead)
Sets a custom bloom saturation.
SetTonemapPercentBrightPixels <float> (only in Left 4 Dead 2 Counter-Strike: Global Offensive)
Sets a target percentage of pixels to maintain above a certain brightness. (default: 1)
SetTonemapPercentTarget <float> (only in Left 4 Dead 2 Counter-Strike: Global Offensive)
Sets the brightness that the percentage of pixels defined by SetTonemapPercentBrightPixels should be kept above. (default: 45)
SetTonemapMinAvgLum <float> (only in Left 4 Dead 2 Counter-Strike: Global Offensive)
Sets custom tonemapping param (default: 3).[Clarify]
InputSetBloomNxtGen_Threshold <float> (only in Black Mesa)
Sets the influence of tonemapping; with high values, only brightest parts of frame will be bloomed.
An example of what it does.


InputSetBloomNxtGen_TintR <float> (only in Black Mesa)
Sets the influence value for redder tones in frame.
An example of what it does.


InputSetBloomNxtGen_TintG <float> (only in Black Mesa)
Sets the influence value for greener tones in frame.
An example of what it does.


InputSetBloomNxtGen_TintB <float> (only in Black Mesa)
Sets the influence value for bluer tones in frame.
An example of what it does.


InputSetBloomNxtGen_Exponent <float> (only in Black Mesa)
Sets the brightness of the bloom.
An example of what it does.


See also