FilmGrain - PostProcessEffectType.FilmGrain. More...

Inheritance diagram for PPEFilmGrain:

Collaboration diagram for PPEFilmGrain:

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_INTENSITY = 0

static const int	PARAM_SHARPNESS = 1

static const int	PARAM_GRAINSIZE = 2

static const int	PARAM_INTENSITYX0 = 3

static const int	PARAM_INTENSITYX1 = 4

static const int	PARAM_MONOCHROMATIC = 5

static const int	PARAM_SIMPLE = 6

static const int	PARAM_DISTORT = 7

static const int	PARAM_FREQUENCY = 8

static const int	L_1_NVG = 100

static const int	L_1_TOXIC_TINT = 200

static const int	L_2_NVG = 100

static const int	L_2_TOXIC_TINT = 200

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

FilmGrain - PostProcessEffectType.FilmGrain.

Be advised, for this to take any effect, 'g_Game.NightVissionLightParams' needs to have non-zero 'noiseIntensity' parameter. /note set by 'PPELightIntensityParamsNative.PARAM_NOISE_MULT' currently

Definition at line 6 of file PPEFilmGrain.c.

Member Function Documentation

◆ GetDefaultMaterialPath()

override string PPEFilmGrain::GetDefaultMaterialPath ( )

inlineprivate

Definition at line 29 of file PPEFilmGrain.c.

  {
    return "Graphics/Materials/postprocess/filmgrainNV"; //TODO - differentiate between filmgrainNV?
  }

◆ GetPostProcessEffectID()

override int PPEFilmGrain::GetPostProcessEffectID ( )

inlineprivate

Definition at line 24 of file PPEFilmGrain.c.

  {
    return PostProcessEffectType.FilmGrain;
  }

◆ RegisterMaterialParameters()

override void PPEFilmGrain::RegisterMaterialParameters ( )

inlineprivate

Definition at line 34 of file PPEFilmGrain.c.

  {
    RegisterParameterScalarFloat(PARAM_INTENSITY, "Intensity", 0.0, 0.0, 1.0);
    RegisterParameterScalarFloat(PARAM_SHARPNESS, "Sharpness", 2.35, 0.0, 20.0);
    RegisterParameterScalarFloat(PARAM_GRAINSIZE, "GrainSize", 2.75, 1.0, 9.0);
    RegisterParameterScalarFloat(PARAM_INTENSITYX0, "IntensityX0", 0.0, 0.0, 1.0);
    RegisterParameterScalarFloat(PARAM_INTENSITYX1, "IntensityX1", 0.0, 0.0, 1.0);
    RegisterParameterScalarBool(PARAM_MONOCHROMATIC, "Monochromatic", true);
    RegisterParameterScalarBool(PARAM_SIMPLE, "Simple", false);
    RegisterParameterScalarBool(PARAM_DISTORT, "Distort", true);
    RegisterParameterScalarFloat(PARAM_FREQUENCY, "Frequency", 20.0, 1.0, 1000.0);
    //RegisterParameterTexture(PARAM_NOISEMAP,"NoiseMap","{0B1C7AEDC4645C8A}System/textures/noise.edds");
  }