ppEffectCreate

Description

Creates Post Process Effects specified by effect name and priority.

Supported effects:

• "RadialBlur"
• "ChromAberration"
• "WetDistortion"
• "ColorCorrections"
• "DynamicBlur"
• "FilmGrain"
• "ColorInversion"
• "SSAO"
• "Resolution"

Syntax

Syntax 1

ppEffectCreate [name, priority]

Parameters:

• name: String - name of effect type
• priority: Number - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail

Returns: Number - handle or -1 if failed

Syntax 2

ppEffectCreate [[name1, priority1], ...]

Parameters:

• nameN: String - name of effect type
• priorityN: Number - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail

Returns: Array of Numbers or Nothing if failed

Examples

Example 1

_ppGrain = ppEffectCreate ["filmGrain", 2005];

Example 2

If an effect ID is already used, the effect is not created. Use the following:

private _name = "ChromAberration";
private _priority = 200;
private _handle = -1;
while
{
    _handle = ppEffectCreate [_name, _priority];
    _handle < 0;
} do {
    _priority = _priority + 1;
};

// _handle can be used here as usual

or

private _name = "ChromAberration";
private _priority = 200;
private _handle = -1;
waitUntil { _handle = ppEffectCreate [_name, _priority]; _priority = _priority + 1; _handle > 0; };

// _handle can be used here as usual

See also

Post Process Effects · ppEffectForceInNVG · ppEffectEnable · ppEffectEnabled · ppEffectDestroy · ppEffectCommit · ppEffectCommitted · ppEffectAdjust