ppEffectCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(syntax)
Line 17: Line 17:
* "filmGrain"
* "filmGrain"
* "colorInversion"
* "colorInversion"
In Arma 3 also:
* "LightShafts"
* "SSAO"
* "HDAO"


|= Description
|= Description
Line 23: Line 27:
| '''ppEffectCreate''' [name, priority] |= Syntax
| '''ppEffectCreate''' [name, priority] |= Syntax


|p1= name: [[String]] - name of effect type.  |= PARAMETER1
|p1= [name, priority]: [[Array]] |=
|p2= name: [[String]] - name of effect type.  |= PARAMETER1
|p3= priority: [[Number]] - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail. |= PARAMETER2


|p2= priority: [[Number]] - unique priority |= PARAMETER2
| [[Number]] - handle or -1 if failed |= RETURNVALUE


| [[Number]] - handle |= RETURNVALUE
| s2= '''ppEffectCreate''' <nowiki>[</nowiki>[name1, priority1],...] |= Syntax


|p21= [name1, priority1]: [[Array]] |=
|p22= name: [[String]] - name of effect type.  |= PARAMETER1
|p23= priority: [[Number]] - unique priority, defines order of applying effect to the scene. If there is another effect using the same priority, creation will fail.|= PARAMETER2
| r2= [[Array]] - [handle1,...] array of effects handles or [[Nothing]] if failed |= RETURNVALUE
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 16:38, 16 August 2015

Hover & click on the images for description

Description

Description:
Create Post process effects specified by effect name and priority. See class CfgOpticsEffect for examples using:
  • "radialBlur"
  • "chromAberration"
  • "wetDistortion"
  • "colorCorrections"
  • "dynamicBlur"
  • "filmGrain"
  • "colorInversion"
In Arma 3 also:
  • "LightShafts"
  • "SSAO"
  • "HDAO"
Groups:
Uncategorised

Syntax

Syntax:
ppEffectCreate [name, priority]
Parameters:
[name, priority]: Array
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:
[name1, priority1]: Array
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:
Array - [handle1,...] array of effects handles or Nothing if failed

Examples

Example 1:
_ppGrain = ppEffectCreate ["filmGrain", 2005];

Additional Information

See also:
Post process effectsppEffectForceInNVGppEffectEnableppEffectDestroyppEffectCommitppEffectCommittedppEffectAdjust

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

Notes

For some examples, check this topic - Lou Montana

Bottom Section

Posted on July 24, 2015 - 04:08 (UTC)
Raymix
"wetDistortion" only works if handle is used. Arma 3 (1.48.131561)