Glow - PostProcessEffectType.Glow. More...

Inheritance diagram for PPEGlow:

Collaboration diagram for PPEGlow:

Private Member Functions
override int	GetPostProcessEffectID ()

override string	GetDefaultMaterialPath ()

override void	RegisterMaterialParameters ()

Private Member Functions inherited from PPEClassBase
void	PPEClassBase (string mat_path_override="")

void	Init (string mat_path_override="")

void	CreateMaterial ()

Material	GetMaterial ()

void	CreateDataStructure ()

void	RegisterMaterialParameters ()
	inserted into associative array by parameter int value, parameter registration order does not matter (still ordered, though)

void	RegisterParameterScalarBool (int idx, string parameter_name, bool default_value)

void	RegisterParameterScalarInt (int idx, string parameter_name, int default_value, int min, int max)

void	RegisterParameterScalarFloat (int idx, string parameter_name, float default_value, float min, float max)
	WARNING - min/max values are usually taken from Workbench defaults, may not be actual min/max values the renderer can handle! When in doubt, try some higher/lower values...

void	RegisterParameterScalarFloatEx (int idx, string parameter_name, float default_value, float min, float max, typename type)
	WARNING - min/max values are usually taken from Workbench defaults, may not be actual min/max values the renderer can handle! When in doubt, try some higher/lower values...

void	RegisterParameterColor (int idx, string parameter_name, float r, float g, float b, float a)
	WARNING - min/max values are usually taken from Workbench defaults, may not be actual min/max values the renderer can handle! When in doubt, try some higher/lower values...

void	RegisterParameterColorEx (int idx, string parameter_name, float r, float g, float b, float a, typename type)
	WARNING - min/max values are usually taken from Workbench defaults, may not be actual min/max values the renderer can handle! When in doubt, try some higher/lower values...

void	RegisterParameterVector (int idx, string parameter_name, array< float > default_values)

void	RegisterParameterTexture (int idx, string parameter_name, string default_path)

void	RegisterParameterResource (int idx, string parameter_name, string default_path)

void	InsertParamValueData (PPERequestParamDataBase request_data)
	Distributes requester data to the material class structure and links them to appropriate parameter.

void	RemoveRequest (int req_idx)
	unused, see 'RemoveActiveRequestFromMaterials' for more info

void	OnUpdate (float timeslice, int order)
	generic update method, take care when overriding!

void	SetFinalParameterValue (int parameter_idx)
	Clamps the values being set to defaults, if there is no request setting non-zero values on the parameter.

void	ApplyValueChanges ()

void	InsertUpdatedParameter (int mat_id)

void	ParamUpdateRemove (int parameter_idx)
	Queue selected parameter for removal from the update queue.

void	SetParameterUpdating (int order, int parameter_id)
	Queue specific parameter of this material to update.

void	ParamUpdateQueueCleanup (int order)

string	GetDefaultMaterialPath ()
	override this if you want to use different path by default; '.emat' is appended automatically

void	ChangeMaterialPathUsed (string path)

string	GetCurrentMaterialPath ()

int	GetPostProcessEffectID ()
	Overriden in all material classes!

PPEMatClassParameterCommandData	GetParameterCommandData (int parameter_idx)
	Some PP effects are handled as hard-coded exceptions, outside of material system. Default == PPEExceptions.NONE (systemic behaviour)

void	DbgPrnt (string text)

Static Private Attributes
static const int	PARAM_VISIBLEPERCENT = 0

static const int	PARAM_TARGETBRIGHTNESS = 1

static const int	PARAM_SPEEDDARKTOBRIGHT = 2

static const int	PARAM_SPEEDBRIGHTTODARK = 3

static const int	PARAM_TONEMAPPING = 4

static const int	PARAM_HDR = 5

static const int	PARAM_FILMICSHOULDERSTRENGTH = 6

static const int	PARAM_FILMICLINEARSTRENGTH = 7

static const int	PARAM_FILMICLINEARANGLE = 8

static const int	PARAM_FILMICTOESTRENGTH = 9

static const int	PARAM_FILMICTOENUMERATOR = 10

static const int	PARAM_FILMICTOEDENUMERATOR = 11

static const int	PARAM_FILMICEXPOSUREBIAS = 12

static const int	PARAM_FILMICWHITEPOINT = 13

static const int	PARAM_BLOOMTHRESHOLD = 14

static const int	PARAM_BLOOMSTEEPNESS = 15

static const int	PARAM_BLOOMINTENSITY = 16

static const int	PARAM_BRIGHTNESS = 17

static const int	PARAM_CONTRAST = 18

static const int	PARAM_OFFSET = 19

static const int	PARAM_OVERLAYFACTOR = 20

static const int	PARAM_OVERLAYCOLOR = 21

static const int	PARAM_SATURATION = 22

static const int	PARAM_COLORIZATIONCOLOR = 23

static const int	PARAM_DESATURATIONWEIGHTS = 24

static const int	PARAM_VIGNETTE = 25

static const int	PARAM_VIGNETTECOLOR = 26

static const int	PARAM_LENSDISTORT = 27

static const int	PARAM_MAXCHROMABBERATION = 28

static const int	PARAM_LENSCENTERX = 29

static const int	PARAM_LENSCENTERY = 30

static const int	L_20_HIT = 100

static const int	L_20_FLASHBANG = 300

static const int	L_20_SHOCK = 500

static const int	L_21_SHOCK = 100

static const int	L_21_HIT = 300

static const int	L_21_FLASHBANG = 500

static const int	L_22_BLOODLOSS = 100

static const int	L_23_GLASSES = 100

static const int	L_23_TOXIC_TINT = 200

static const int	L_23_NVG = 600

static const int	L_25_MENU = 100

static const int	L_25_TUNNEL = 300

static const int	L_25_SHOCK = 500

static const int	L_25_UNCON = 700

static const int	L_25_BURLAP = 800

static const int	L_26_MENU = 100

static const int	L_26_TUNNEL = 300

static const int	L_26_SHOCK = 500

static const int	L_26_UNCON = 700

static const int	L_26_BURLAP = 800

static const int	L_27_ADS = 100

static const int	L_28_ADS = 100

static const int	L_29_ADS = 100

static const int	L_30_ADS = 100

Additional Inherited Members
Private Attributes inherited from PPEClassBase
PPEManager	m_Manager

string	m_MaterialPath = ""

Material	m_Material

ref map< int, ref array< int > >	m_ParameterUpdateQueueMap

ref array< int >	m_ParameterRemovalQueue

ref array< int >	m_UpdatedParameters

ref map< int, ref PPEMatClassParameterCommandData >	m_MaterialParamMapStructure

Detailed Description

Glow - PostProcessEffectType.Glow.

Definition at line 7 of file PPEGlow.c.

Member Function Documentation

◆ GetDefaultMaterialPath()

override string PPEGlow::GetDefaultMaterialPath ( )

inlineprivate

Definition at line 81 of file PPEGlow.c.

  {
    return "Graphics/Materials/postprocess/glow";
  }

◆ GetPostProcessEffectID()

override int PPEGlow::GetPostProcessEffectID ( )

inlineprivate

Definition at line 76 of file PPEGlow.c.

  {
    return PostProcessEffectType.Glow;
  }

◆ RegisterMaterialParameters()

override void PPEGlow::RegisterMaterialParameters ( )

inlineprivate

Definition at line 86 of file PPEGlow.c.

  {
    //HDR
    RegisterParameterScalarFloat(PARAM_VISIBLEPERCENT, "VisiblePercent", 95, 1, 100);
    RegisterParameterScalarFloat(PARAM_TARGETBRIGHTNESS, "TargetBrightness", 0.3, 0.01, 1);
    RegisterParameterScalarFloat(PARAM_SPEEDDARKTOBRIGHT, "SpeedDarkToBright", 0.3, 0.01, 1);
    RegisterParameterScalarFloat(PARAM_SPEEDBRIGHTTODARK, "SpeedBrightToDark", 0.3, 0.01, 1);
    RegisterParameterScalarInt(PARAM_TONEMAPPING, "ToneMapping", 2, 0, 2);
    RegisterParameterScalarBool(PARAM_HDR, "HDR", 1);
    //Filmic tonemapping
    RegisterParameterScalarFloat(PARAM_FILMICSHOULDERSTRENGTH, "FilmicShoulderStrength", 0.153, 0, 1);
    RegisterParameterScalarFloat(PARAM_FILMICLINEARSTRENGTH, "FilmicLinearStrength", 0.357, -1, 1);
    RegisterParameterScalarFloat(PARAM_FILMICLINEARANGLE, "FilmicLinearAngle", 0.231, -1, 1);
    RegisterParameterScalarFloat(PARAM_FILMICTOESTRENGTH, "FilmicToeStrength", 0.1573, 0.001, 3);
    RegisterParameterScalarFloat(PARAM_FILMICTOENUMERATOR, "FilmicToeNumerator", 0.011, -1, 1);
    RegisterParameterScalarFloat(PARAM_FILMICTOEDENUMERATOR, "FilmicToeDenumerator", 3.75, 0.1, 20);
    RegisterParameterScalarFloat(PARAM_FILMICEXPOSUREBIAS, "FilmicExposureBias", 4.0, 0.1, 20);
    RegisterParameterScalarFloat(PARAM_FILMICWHITEPOINT, "FilmicWhitePoint", 1.5, 0.1, 20);
    //Bloom
    RegisterParameterScalarFloat(PARAM_BLOOMTHRESHOLD, "BloomThreshold", 0.5, 0, 1);
    RegisterParameterScalarFloat(PARAM_BLOOMSTEEPNESS, "BloomSteepness", 1, 0, 10);
    RegisterParameterScalarFloat(PARAM_BLOOMINTENSITY, "BloomIntensity", 1, 0, 4);
    //Color modificators
    //color defines
    RegisterParameterScalarFloat(PARAM_BRIGHTNESS, "Brightness", 1, 0, 2);
    RegisterParameterScalarFloat(PARAM_CONTRAST, "Contrast", 1, 0, 2);
    RegisterParameterScalarFloat(PARAM_OFFSET, "Offset", 0, -1, 1);
    RegisterParameterScalarFloat(PARAM_OVERLAYFACTOR, "OverlayFactor", 0, 0, 1);
    RegisterParameterColor(PARAM_OVERLAYCOLOR, "OverlayColor", 1, 1, 1, 0);
    RegisterParameterScalarFloatEx(PARAM_SATURATION, "Saturation", 1, 0, 1, PPEMatClassParameterFloatSaturation);
    RegisterParameterColorEx(PARAM_COLORIZATIONCOLOR, "ColorizationColor", 1.0, 1.0, 1.0, 0.0, PPEMatClassParameterColorColorization);
    RegisterParameterVector(PARAM_DESATURATIONWEIGHTS, "DesaturationWeights", {0.299, 0.587, 0.114, 0});
    RegisterParameterScalarFloat(PARAM_VIGNETTE, "Vignette", 0, 0, 2); //C++ maximum is set to 1.0 (Workbench), but the parameter can accept more. 2.0 is a reasonable value
    RegisterParameterColor(PARAM_VIGNETTECOLOR, "VignetteColor", 0, 0, 0, 0);
    //Distort
    RegisterParameterScalarFloat(PARAM_LENSDISTORT, "LensDistort", 0, -5, 5);
    RegisterParameterScalarFloat(PARAM_MAXCHROMABBERATION, "MaxChromAbberation", 0, 0, 1);
    RegisterParameterScalarFloat(PARAM_LENSCENTERX, "LensCenterX", 0, -1, 1);
    RegisterParameterScalarFloat(PARAM_LENSCENTERY, "LensCenterY", 0, -1, 1);
  }