ppEffectCreate

1.001.501.000.50

Hover & click on the images for description

Description

Description:

Creates Post Process Effects specified by effect name and priority.
Supported effects:

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

Groups:

Camera Control

Syntax

Syntax:

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

Return Value:

Number - handle or -1 if failed

Alternative Syntax

Syntax:

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

Return Value:

Array of Numbers [handle1, ...] 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

Additional Information

See also:

Post Process Effects ppEffectForceInNVG ppEffectEnable ppEffectEnabled ppEffectDestroy ppEffectCommit ppEffectCommitted ppEffectAdjust

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Lou Montana - c

Posted on Jun 29, 2009 - 22:33 (UTC)

For some examples, check this forums' topic.

Raymix (DayZ) - c

Posted on Jun 24, 2015 - 04:08 (UTC)

1.48

"wetDistortion" only works if handle is used.