Post Process Effects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
(Add Effect disabling and Effect Fade Out sections to the page, rel.: https://discord.com/channels/105462288051380224/105465701543723008/1226483081016512612)
 
(90 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{enHeader}}
{{TOC|side}}
== Scripting Commands ==


===Scripting commands===
{{Columns|4|
* [[ppEffectCreate]]
* [[ppEffectAdjust]]
* [[ppEffectEnable]]
* [[ppEffectEnabled]]
* [[ppEffectForceInNVG]]
* [[ppEffectCommit]]
* [[ppEffectCommitted]]
* [[ppEffectDestroy]]
}}


Effect creation:


hndl = ppEffectCreate ["effect_type", priority]
== Usage ==
hndls[] = ppEffectCreate [["effect_type0", priority0], ["effect_type1", priority1], ...]


Effect cancellation:
=== Effect Creation ===


ppEffectDestroy hndl
<sqf>
ppEffectDestroy [hndl0, hndl1, ..., hndlN]
_handle = ppEffectCreate ["effect_type", priority];
_handlesArray = ppEffectCreate [["effect_type0", priority0], ["effect_type1", priority1], /* ... */];
</sqf>


Parameter setup:
=== Effect Cancellation ===


hndl ppEffectAdjust [par0, par1, .... , parN]
<sqf>
ppEffectDestroy handle;
Parameter application:
ppEffectDestroy handlesArray;
</sqf>


hndl ppEffectCommit time
=== Effect Disabling ===
[hndl0, ..., hndlN] ppEffectCommit time
Compared to the effect cancellation, in this case the effect is just disabled but still exists
<sqf>
_handle ppEffectEnable false;
</sqf>


Effect permission:
=== Effect Fade out ===
hndl ppEffectEnable
Rather than disabling the effect completely at once, it is possible to use ppEffectAdjust to fade it out over time
[hndl0, ..., hndlN] ppEffectEnable OnOf
<sqf>
//after having created and used effect:
//set the parameters for the effect back to the default values
"colorCorrections" ppEffectAdjust [1,1,0,[0,0,0,0],[1,1,1,1],[0.299, 0.587, 0.114, 0],[-1,-1,0,0,0,0,0]];
//then commit and fade out over given time (10 seconds)
"colorCorrections" ppEffectCommit 10;
//Disable completely after fadeout
"colorCorrections" ppEffectEnable false;
</sqf>


'''Priority defines sequence in which are post effects applied.'''
=== Parameter Setup ===


====Example====
<sqf>handle ppEffectAdjust [par0, par1, /* ... */, parN];</sqf>


_hndl = ppEffectCreate ["colorCorrections", 1501];
=== Parameter application ===
_hndl ppEffectEnable true;
_hndl ppEffectAdjust [1.0, 1.0, 0.0, [1.0, 0.1, 1.0, 0.75], [0.0, 1.0, 1.0, 1.0],[0.199, 0.587, 0.114, 0.0]];
_hndl ppEffectCommit 0;
sleep 10;
ppEffectDestroy _hndl;


====Table of priorities====
<sqf>
handle ppEffectCommit _duration;
handlesArray ppEffectCommit _duration;
</sqf>


<table style="width: 75%; margin-left: center; margin-right: auto; border-style: solid; border-width: 1px; padding: 1pt; text-align: center;">
=== Effect Permission ===
  <tr><th>Priority</th><th>PostEffect</th><th>Popis</th></tr>


  <tr><th>2050</th><th>FilmGrain</th><th>CfgOpticsEffect::TankCommanderOptics1(2)</th></tr>
<sqf>
  <tr><th>1550</th><th>ColorCorrections</th><th>CfgOpticsEffect::TankGunnerOptics1(2)</th></tr>
handle ppEffectEnable _OnOrOff;
  <tr><th>450</th><th>DynamicBlur</th><th>CfgOpticsEffect::OpticsBlur1(2,3)</th></tr>
handlesArray ppEffectEnable _OnOrOff;
  <tr><th>250</th><th>Chromatic Aberration</th><th>CfgOpticsEffect::OpticsCHAbera1(2,3)</th></tr>
</sqf>


</table>
{{ArgTitle|3|Check if Enabled|{{GVI|arma3|1.56}}}}


===Postprocess effects===
<sqf>ppEffectEnabled handle;</sqf>


#Radial Zoom Blur
=== Example ===
#Chromatic Aberration
#Wet Distortion
#Color Corrections
#Dynamic Blur
#Film Grain
#Color Inversion


===Parameters of individual effects===
<sqf>
_handle = ppEffectCreate ["colorCorrections", 1501];
_handle ppEffectEnable true;
_handle ppEffectAdjust [1.0, 1.0, 0.0, [1.0, 0.1, 1.0, 0.75], [0.0, 1.0, 1.0, 1.0], [0.199, 0.587, 0.114, 0.0]];
_handle ppEffectCommit 0;
sleep 10;
ppEffectDestroy _handle;
</sqf>


'''RadialBlur'''
== Table of Priorities ==


Base priority 100
Priority defines sequence in which post effects are applied. The higher priority, the later the effect will be applied, on top of the others.


Title RadialBlur
{| class="wikitable sortable"
! Base Priority !! Effect
|-
| 2500 || [[#ColorInversion|ColorInversion]]
|-
| 2000 || [[#FilmGrain|FilmGrain]]
|-
| 1500 || [[#ColorCorrections|ColorCorrections]]
|-
| 400 || [[#DynamicBlur|DynamicBlur]]
|-
| 300 || [[#WetDistortion|WetDistortion]]
|-
| 200 || [[#ChromaticAberration|ChromaticAberration]]
|-
| 100 || [[#RadialBlur|RadialBlur]]
|-
| 0 || [[#SSAO|SSAO]]
|-
| 0 || [[#Resolution|Resolution]]
|}


hndRadBlur ppEffectAdjust [par0, par1, par2, par3]


<table style="width: 75%; margin-left: center; margin-right: auto; border-style: solid; border-width: 1px; padding: 1pt; text-align: center;">
== Parameters of Individual Effects ==
  <tr>
      <th>Parameter</th><th>Meaning</th><th>Typ</th><th>Range</th>
  </tr> 
  <tr>
    <td>par0</td> <td>relative blur degree in axis X</td><td> float</td><td>[0,1]</td>
  </tr>
  <tr>
    <td>par1</td> <td>relative blur degree in axis Y</td><td> float</td><td>[0,1]</td>
  </tr>
  <tr>
    <td>par2</td> <td>relative size of un-blurred centre</td><td> float</td><td>[0,0.5]</td>
  </tr>
  <tr>
    <td>par3</td> <td>relative size of un-blurred centre</td><td> float</td><td>[0,0.5]</td>
  </tr>
</table>


'''ChromaticAberration'''
=== RadialBlur ===


Base priority 200
Title: "RadialBlur"; Base Priority: 100


Title ChromAberration
{{Feature|informative|RadialBlur will not do anything if RADIAL BLUR is disabled in Video Options}}


hndlChromAberr ppEffectAdjust [par0, par1, par2, par3]
{| class="wikitable"
! Parameter !! Meaning !! Type !! Range !! Defaults
|-
| powerX || relative blur degree on axis X || float || 0... || 0.01
|-
| powerY || relative blur degree on axis Y || float || 0... || 0.01
|-
| offsetX || relative size X of un-blurred centre || float || 0... || 0.06
|-
| offsetY || relative size Y of un-blurred centre || float || 0... || 0.06
|}


<table style="width: 75%; margin-left: center; margin-right: auto; border-style: solid; border-width: 1px; padding: 1pt; text-align: center;">
Syntax:
  <tr>
<sqf>_radialBlurHandle ppEffectAdjust [powerX, powerY, offsetX, offsetY];</sqf>
      <th>Parameter</th><th>Meaning</th><th>Typ</th><th>Range</th>
  </tr> 
  <tr>
    <td>par0</td> <td>relative effect strength (sample spacing from each other) in axis X</td><td> float</td><td></td>
  </tr>
  <tr>
    <td>par1</td> <td>relative effect streng ht (sample spacing from each other) in axis Y</td><td> float</td><td></td>
  </tr>
  <tr>
    <td>par2</td> <td>correction according to screen aspect ratio</td><td>bool</td><td></td>
  </tr>
</table>


'''WetDistortion'''
Defaults:
<sqf>_radialBlurHandle ppEffectAdjust [0.01, 0.01, 0.06, 0.06];</sqf>


Base priority 300
Example:
<sqf>
["RadialBlur", 100, [100, 0.5, 0.1, 0.5]] spawn
{
params ["_name", "_priority", "_effect", "_handle"];
while {
_handle = ppEffectCreate [_name, _priority];
_handle < 0
} do {
_priority = _priority + 1;
};
_handle ppEffectEnable true;
_handle ppEffectAdjust _effect;
_handle ppEffectCommit 5;
waitUntil { ppEffectCommitted _handle };
systemChat "admire effect for a sec";
uiSleep 3;
_handle ppEffectEnable false;
ppEffectDestroy _handle;
};
</sqf>


Title WetDistortion
=== ChromAberration ===


hndlWetDist ppEffectAdjust [par0, apr1, par2, ..., par13, par14]
Title "ChromAberration"; Base Priority: 200


<table style="width: 75%; margin-left: center; margin-right: auto; border-style: solid; border-width: 1px; padding: 1pt; text-align: left;">
{| class="wikitable"
  <tr>
! Parameter !! Meaning !! Type !! Range !! Defaults
      <th>Parameter</th><th>Meaning</th><th>Typ</th><th>Range</th>
|-
  </tr> 
| aberrationPowerX || relative effect strength (sample spacing from each other) axis X || float || 0... || 0.005
  <tr>
|-
    <td>par0</td> <td>blurriness</td><td> float</td><td>[0,1]</td>
| aberrationPowerY || relative effect strength (sample spacing from each other) axis Y || float || 0... || 0.005
  </tr>
|-
  <tr>
| aspectCorrection || enable/disable correction according to screen aspect ratio || bool || true, false || false
    <td>par1, par2</td><td>effect strength(top and bottom part)</td><td> float</td><td></td>
|}
  </tr>
  <tr>
    <td>par3 - par6</td> <td>wave speed:  (frequency/PI)</td><td> float</td><td></td>
  </tr>
  <tr>
    <td>par7 - par10</td> <td>wave amplitudes</td><td> float</td><td></td>
  </tr>
  <tr>
    <td>par11 - par14</td> <td>phase coefficients: random value influence coefficient inside vertex</td><td> float</td><td></td>
  </tr>
</table>


'''ColorCorrection'''
Syntax:
<sqf>_chromaticAberrationHandle ppEffectAdjust [aberrationPowerX, aberrationPowerY, aspectCorrection];</sqf>


Base priority 1500
Defaults:
<sqf>_chromaticAberrationHandle ppEffectAdjust [0.005, 0.005, false];</sqf>


Title ColorCorrections
Example:
<sqf>
["ChromAberration", 200, [0.05, 0.05, true]] spawn {
params ["_name", "_priority", "_effect", "_handle"];
while {
_handle = ppEffectCreate [_name, _priority];
_handle < 0
} do {
_priority = _priority + 1;
};
_handle ppEffectEnable true;
_handle ppEffectAdjust _effect;
_handle ppEffectCommit 5;
waitUntil { ppEffectCommitted _handle };
systemChat "admire effect for a sec";
uiSleep 3;
_handle ppEffectEnable false;
ppEffectDestroy _handle;
};
</sqf>


hndlClrCorr ppEffectAdjust [par0, apr1, par2, ..., par13, par14]
=== WetDistortion ===


<table style="width: 50%; margin-left: center; margin-right: auto; border-style: solid; border-width: 1px; padding: 1pt; text-align: center;">
Title: "WetDistortion"; Base Priority: 300
  <tr>
      <th>Parameter</th><th>Meaning</th><th>Typ</th><th>Range</th>
  </tr> 
  <tr>
    <td>par0</td> <td>brightness</td><td> float</td><td>[0,1]</td>
  </tr>
  <tr>
    <td>par1</td><td>contrast</td><td> float</td><td></td>
  </tr>
  <tr>
    <td>par2</td> <td>offset</td><td> float</td><td></td>
  </tr>
  <tr>
    <td>par3 - par6</td> <td>blend color  (R,G,B,A)</td><td> float</td><td></td>
  </tr>
  <tr>
    <td>par7 - par10</td> <td>colorize color  (R,G,B,A)</td><td> float</td><td></td>
  </tr>
  <tr>
    <td>par11 - par14</td> <td>colorize color (R,G,B,A)</td><td> float</td><td></td>
  </tr>
</table>


'''Dynamic Blur'''
{{Feature | Informative | Effect cancels automatically under water.}}


Base priority 400
{| class="wikitable"
! Parameter !! Meaning !! Type !! Range !! Defaults
|-
| value || blurriness of distorted image (0 to 1, values above 1 cause unusual) || float || 0..1 || 1
|-
| top, bottom || effect power (top/bottom of screen separately) || float || 0..1 || 1, 1
|-
| horizontal1, horizontal2, vertical1, vertical2 || waves speeds (frequency/PI) || float || 0... || 4.10, 3.70, 2.50, 1.85
|-
| horizontal1, horizontal2, vertical1, vertical2 || waves amplitudes (delta texture coordinates)|| float || 0... || 0.0054, 0.0041, 0.0090, 0.0070
|-
| randX, randY || coefficients for phase computing; weight of random vertex data on horizontal/vertical wave phases || float || 0... || 0.5, 0.3
|-
| posX, posY || coefficients for phase computing; weight of vertex X/Y-position on horizontal/vertical wave phases || float || 0... || 10.0, 6.0
|}


Title DynamicBlur
Syntax:
<sqf>
_wetDistorsionHandle ppEffectAdjust [
value,
top, bottom,
horizontal1, horizontal2, vertical1, vertical2,
horizontal1, horizontal2, vertical1, vertical2,
randX, randY, posX, posY
];
</sqf>


hndlDynBlur ppEffectAdjust [par0]
Defaults:
<sqf>
_wetDistorsionHandle ppEffectAdjust [
1,
1, 1,
4.10, 3.70, 2.50, 1.85,
0.0054, 0.0041, 0.0090, 0.0070,
0.5, 0.3, 10.0, 6.0
];
</sqf>


<table style="width: 50%; margin-left: center; margin-right: auto; border-style: solid; border-width: 1px; padding: 1pt; text-align: center;">
Example:
  <tr>
<sqf>
      <th>Parameter</th><th>Meaning</th><th>Typ</th><th>Range</th>
["WetDistortion", 300, [1, 0, 1, 4.10, 3.70, 2.50, 1.85, 0.0054, 0.0041, 0.05, 0.0070, 1, 1, 1, 1]] spawn
  </tr> 
{
  <tr>
params ["_name", "_priority", "_effect", "_handle"];
    <td>par0</td><td>blurriness</td><td>float</td><td></td>
while {
  </tr>
_handle = ppEffectCreate [_name, _priority];
</table>
_handle < 0
} do {
_priority = _priority + 1;
};
_handle ppEffectEnable true;
_handle ppEffectAdjust _effect;
_handle ppEffectCommit 5;
waitUntil { ppEffectCommitted _handle };
systemChat "admire effect for a sec";
uiSleep 3;
_handle ppEffectEnable false;
ppEffectDestroy _handle;
};
</sqf>


'''FilmGrain'''
=== ColorCorrections ===


Base priority 2000
Title: "ColorCorrections"; Base Priority: 1500


Title FilmGrain
{| class="wikitable"
! Parameter !! Meaning !! Type !! Range !! Defaults
|-
| brightness|| image brightness (0 - black, 1 - unchanged, 2 - white ) || float || 0..2 || 1
|-
| contrast || image contrast (1 - normal contrast) || float || 0... || 1
|-
| offset || image contrast offset (0 - unchanged )|| float || 0... || 0
|-
| [r, g, b, a] || color for blending (r, g, b - color, a - blend factor (0 - original color, 1 - blend color )) || float || 0..1 || [0, 0, 0, 0]
|-
| [r, g, b, a] || color for colorization ( r, g, b - color, a - saturation (0 - original color, 1 - B&W multiplied by colorize color)) || float || 0..1 || [1, 1, 1, 1]
|-
| [r, g, b, 0] || color rgb weights for desaturation || float || 0..1 || [0.299, 0.587, 0.114, 0]
|-
| [<br>
&nbsp;&nbsp;&nbsp;&nbsp;radialMajorAxisRadius,<br>
&nbsp;&nbsp;&nbsp;&nbsp;radialMinorAxisRadius,<br>
&nbsp;&nbsp;&nbsp;&nbsp;radialRotationDeg,<br>
&nbsp;&nbsp;&nbsp;&nbsp;radialCenterX,<br>
&nbsp;&nbsp;&nbsp;&nbsp;radialCenterY,<br>
&nbsp;&nbsp;&nbsp;&nbsp;radialInnerRadiusCoef,<br>
&nbsp;&nbsp;&nbsp;&nbsp;radialInterpCoef<br>
]
|| radial color '''''(optional, Arma 3 only)'''''<br>
major axis radius of ellipse<br>
minor axis radius of ellipse<br>
rotation of ellipse axis (in degrees)<br>
centerX of ellipse on the screen (in relative coords, [-0.5] -> [0.5], where 0 is in the screen center)<br>
centerY of ellipse on the screen (in relative coords, [-0.5] -> [0.5], where 0 is in the screen center)<br>
coefficient for inner radius (where effect is not applied)<br>
coefficient for color interpolation between inner and outer radius<br>
&nbsp;
||<br>
float<br>
float<br>
float<br>
float<br>
float<br>
float<br>
float<br>
&nbsp;
||<br>
0..1<br>
0..1<br>
0..359<br>
-1..1<br>
-1..1<br>
0..1<br>
0...<br>
&nbsp;
||
[<br>
&nbsp;&nbsp;&nbsp;&nbsp;-1,<br>
&nbsp;&nbsp;&nbsp;&nbsp;-1,<br>
&nbsp;&nbsp;&nbsp;&nbsp;0,<br>
&nbsp;&nbsp;&nbsp;&nbsp;0,<br>
&nbsp;&nbsp;&nbsp;&nbsp;0,<br>
&nbsp;&nbsp;&nbsp;&nbsp;0,<br>
&nbsp;&nbsp;&nbsp;&nbsp;0<br>
]
|}


Number of parameters is flexible ... it may be defined 1 to 6 parameters, meaning of individual parameters is following:
Syntax:
{| class="wikitable valign-top"
! {{GVI|arma3|1.00}}
! {{GVI|arma2|1.00}}{{GVI|arma2oa|1.50}}
|-
| <sqf>
_colorCorrectionHandle ppEffectAdjust
[
brightness,
contrast,
offset,
[blendR, blendG, blendB, blendA],
[colorizeR, colorizeG, colorizeB, colorizeA],
[weightR, weightG, weightB, 0],
[a, b, angle, cx, cy, innerRCoef, interpCoef]
];
</sqf>
| <sqf>
_colorCorrectionHandle ppEffectAdjust
[
brightness,
contrast,
offset,
[blendR, blendG, blendB, blendA],
[colorizeR, colorizeG, colorizeB, colorizeA],
[weightR, weightG, weightB, 0]
];
</sqf>
|}


hndlFilmGrain ppEffectAdjust [par0, par1, par2, apr3, apr4, par5]
Defaults:
{| class="wikitable"
! {{GVI|arma3|1.00}}
! {{GVI|arma2|1.00}}{{GVI|arma2oa|1.50}}
|-
| <sqf>
_colorCorrectionHandle ppEffectAdjust
[
1,
1,
0,
[0, 0, 0, 0],
[1, 1, 1, 1],
[0.299, 0.587, 0.114, 0],
[-1, -1, 0, 0, 0, 0, 0]
];
</sqf>
| <sqf>
_colorCorrectionHandle ppEffectAdjust
[
1,
1,
0,
[0, 0, 0, 0],
[1, 1, 1, 1],
[0.299, 0.587, 0.114, 0]
];
</sqf>
|}


<table style="width: 50%; margin-left: center; margin-right: auto; border-style: solid; border-width: 1px; padding: 1pt; text-align: center;">
Example:
  <tr>
<sqf>
      <th>Parameter</th><th>Meaning</th><th>Typ</th><th>Range</th>
["ColorCorrections", 1500, [1, 0.4, 0, [0, 0, 0, 0], [1, 1, 1, 0], [1, 1, 1, 0]]] spawn
  </tr> 
{
  <tr>
params ["_name", "_priority", "_effect", "_handle"];
    <td>par0</td> <td>intensity </td><td> float</td><td>[0,1]</td>
while {
  </tr>
_handle = ppEffectCreate [_name, _priority];
  <tr>
_handle < 0
    <td>par1</td> <td>sharpness</td><td> float</td><td>[0,20]</td>
} do {
  </tr>
_priority = _priority + 1;
  <tr>
};
    <td>par2</td> <td>grain size</td><td> float</td><td>[1,8]</td>
_handle ppEffectEnable true;
  </tr>
_handle ppEffectAdjust _effect;
  <tr>
_handle ppEffectCommit 5;
    <td>par3</td> <td>intensityX0 </td><td> float</td><td></td>
waitUntil { ppEffectCommitted _handle };
  </tr>
systemChat "admire effect for a sec";
  <tr>
uiSleep 3;
    <td>par4</td> <td>intensityX1</td><td> float</td><td></td>
_handle ppEffectEnable false;
  </tr>
ppEffectDestroy _handle;
  <tr>
};
    <td>par5</td> <td>monochromatic</td><td> bool</td><td></td>
</sqf>
  </tr>
</table>


'''ColorInversion'''
=== DynamicBlur ===


Base priority 2500
Title: "DynamicBlur"; Base Priority: 400


Title ColorInversion
{| class="wikitable"
! Parameter !! Meaning !! Type !! Range !! Defaults
|-
| value || blurriness || float || 0... || 0
|}


hndlClrInversion ppEffectAdjust [par0, par1, par2, apr3]
Syntax:
<sqf>_dynamicBlurHandle ppEffectAdjust [value];</sqf>


<table style="width: 50%; margin-left: center; margin-right: auto; border-style: solid; border-width: 1px; padding: 1pt; text-align: center;">
Defaults:
  <tr>
<sqf>_dynamicBlurHandle ppEffectAdjust [0];</sqf>
      <th>Parameter</th><th>Meaning</th><th>Typ</th><th>Range</th>
 
  </tr>  
Example:
  <tr>
<sqf>
    <td>par0</td> <td>Inversion of R channel</td><td> float</td><td>[0,1]</td>
["DynamicBlur", 400, [10]] spawn
  </tr>
{
  <tr>
params ["_name", "_priority", "_effect", "_handle"];
    <td>par1</td> <td>Inversion of G channel</td><td> float</td><td>[0,1]</td>
while {
  </tr>
_handle = ppEffectCreate [_name, _priority];
  <tr>
_handle < 0
    <td>par2</td> <td>Inversion of B channel</td><td> float</td><td>[0,1]</td>
} do {
  </tr>
_priority = _priority + 1;
  <tr>
};
    <td>par3</td> <td>-</td><td> float</td><td></td>
_handle ppEffectEnable true;
  </tr>
_handle ppEffectAdjust _effect;
</table>
_handle ppEffectCommit 5;
waitUntil { ppEffectCommitted _handle };
systemChat "admire effect for a sec";
uiSleep 3;
_handle ppEffectEnable false;
ppEffectDestroy _handle;
};
</sqf>
 
=== FilmGrain ===
 
Title: "FilmGrain"; Base Priority: 2000
 
{{Feature|arma3|In {{arma3}} the '''monochromatic''' parameter is [[Number|numeric]]. Use '''0''' for monochrome, any other value for colour.}}
 
Number of parameters is flexible: it may be defined from 1 to 6 parameters, meaning of individual parameters is following:
 
{| class="wikitable"
! colspan="2" | Parameter !! Meaning !! Type !! Range !! Default
|-
| colspan="2" | intensity || intensity || float || 0..1 || 0.005
|-
| colspan="2" | sharpness || sharpness || float || 1..20 || 1.25
|-
| colspan="2" | grainSize || grain size || float || 1..8 ||  2.01
|-
| colspan="2" | intensityX0 || intensityX0 || float || -x..0..+x ||0.75
|-
| colspan="2" | intensityX1 || intensityX1 || float || -x..0..+x ||1.0
|-
| rowspan="2" | monochromatic || {{GVI|arma2|1.00}}{{GVI|arma2oa|1.50}} || monochromatic || bool|| false, true || true
|-
| {{GVI|arma3|1.00}} || monochromatic || integer || 0, 1 || 0
|}
 
Syntax:
<sqf>
_filmGrainHandle ppEffectAdjust [
intensity,
sharpness,
grainSize,
intensityX0,
intensityX1,
monochromatic
];
</sqf>
 
Defaults:
{| class="wikitable"
! {{GVI|arma3|1.00}}
! {{GVI|arma2|1.00}}{{GVI|arma2oa|1.50}}
|-
| <sqf>
_filmGrainHandle ppEffectAdjust [
0.005,
1.25,
2.01,
0.75,
1.0,
0
];
</sqf>
| <sqf>
_filmGrainHandle ppEffectAdjust [
0.005,
1.25,
2.01,
0.75,
1.0,
true
];
</sqf>
|}
 
Example:
{| class="wikitable"
! {{GVI|arma3|1.00}}
! {{GVI|arma2|1.00}}{{GVI|arma2oa|1.50}}
|-
| <sqf>
["FilmGrain", 2000, [1, 0.15, 7, 0.2, 1.0, 0]] spawn
{
params ["_name", "_priority", "_effect"];
 
 
private _handle = -1;
while {
_handle = ppEffectCreate [_name, _priority];
_handle < 0;
} do {
_priority = _priority + 1;
};
_handle ppEffectEnable true;
_handle ppEffectAdjust _effect;
_handle ppEffectCommit 5;
waitUntil { sleep 0.1; ppEffectCommitted _handle };
systemChat "admire effect for a sec";
uiSleep 3;
_handle ppEffectEnable false;
ppEffectDestroy _handle;
};
</sqf>
| <sqf>
["FilmGrain", 2000, [1, 0.15, 7, 0.2, 1.0, true]] spawn
{
local _name = _this select 0;
local _priority = _this select 1;
local _effect = _this select 2;
local _handle = -1;
while {
_handle = ppEffectCreate [_name, _priority];
_handle < 0;
} do {
_priority = _priority + 1;
};
_handle ppEffectEnable true;
_handle ppEffectAdjust _effect;
_handle ppEffectCommit 5;
waitUntil { sleep 0.1; ppEffectCommitted _handle };
systemChat "admire effect for a sec";
uiSleep 3;
_handle ppEffectEnable false;
ppEffectDestroy _handle;
};
</sqf>
|}
 
=== ColorInversion ===
 
Title: "ColorInversion"; Base Priority: 2500
 
{| class="wikitable"
! Parameter !! Meaning !! Type !! Range !! Defaults
|-
| Red || Inversion of R channel (image inversion (0..no blur, 1..very blurred) || float || 0..1 || 0
|-
| Green || Inversion of G channel (image inversion (0..no blur, 1..very blurred) || float || 0..1 || 0
|-
| Blue || Inversion of B channel (image inversion (0..no blur, 1..very blurred) || float || 0..1 || 0
|}
 
Syntax:
<sqf>_colorInversionHandle ppEffectAdjust [Red, Green, Blue];</sqf>
 
Defaults:
<sqf>_colorInversionHandle ppEffectAdjust [0, 0, 0];</sqf>
 
Example:
<sqf>
["ColorInversion", 2500, [0.5, 0.5, 0.5]] spawn
{
params ["_name", "_priority", "_effect", "_handle"];
while {
_handle = ppEffectCreate [_name, _priority];
_handle < 0
} do {
_priority = _priority + 1;
};
_handle ppEffectEnable true;
_handle ppEffectAdjust _effect;
_handle ppEffectCommit 5;
waitUntil { ppEffectCommitted _handle };
systemChat "admire effect for a sec";
uiSleep 3;
_handle ppEffectEnable false;
ppEffectDestroy _handle;
};
</sqf>
 
{{ArgTitle|3|SSAO|{{GVI|arma3|0.50}}}}
 
Title: "SSAO"; Base Priority: 0
 
{| class="wikitable"
! Parameter !! Meaning !! Type !! Range !! Defaults
|-
| intensity ||  || float || 0..1 || 0
|-
| threshold0 ||  || float || 0..1 || 0
|-
| threshold0 ||  || float || 0..1 || 0
|-
| nearRadius ||  || float || 0..1 || 0
|-
| farRadius ||  || float || 0..1 || 0
|-
| nearDist ||  || float || 0..1 || 0
|-
| farDist ||  || float || 0..1 || 0
|-
| depthBlurDist ||  || float || 0..1 || 0
|-
| blurPasses ||  || integer || 0..x || 0
|-
| halfRes ||  || bool || true, false|| false
|-
| blurHalfRes ||  || boolean || true, false|| false
|}
 
Syntax:
<sqf>
_ssaoHandle ppEffectAdjust [
intensity,
threshold0,
threshold1,
nearRadius,
farRadius,
nearDist,
farDist,
depthBlurDist,
blurPasses,
halfRes,
blurHalfRes
];
</sqf>
 
Defaults:
<sqf>_ssaoHandle ppEffectAdjust [0, 0, 0, 0, 0, 0, 0, 0, 0, false, false];</sqf>
 
Example:
<sqf>
["SSAO", 1, [3, 0.25, 0.75, 5, 50, 5, 25, 100, 3, true, true]] spawn
{
params ["_name", "_priority", "_effect", "_handle"];
while {
_handle = ppEffectCreate [_name, _priority];
_handle < 0;
} do {
_priority = _priority + 1;
};
_handle ppEffectEnable true;
_handle ppEffectAdjust _effect;
_handle ppEffectCommit 5;
waitUntil { ppEffectCommitted _handle };
systemChat "admire effect for a sec";
uiSleep 3;
_handle ppEffectEnable false;
ppEffectDestroy _handle;
};
</sqf>
 
{{ArgTitle|3|Resolution|{{GVI|arma3|2.10}}}}
 
Title: "Resolution"; Base Priority: 0
 
{| class="wikitable"
! Parameter !! Meaning !! Type !! Range !! Defaults
|-
| verticalResolution || define the render's vertical resolution.<br>
If the value is negative, the resolution goes back to normal. If the value is greater than the final render's vertical resolution, it gets clamped to it.<br>
The effect can be disabled in both cases.
| integer || -1..x || -1
|}
 
Syntax:
<sqf>_resolutionHandle ppEffectAdjust [verticalResolution];</sqf>
 
Defaults:
<sqf>_ssaoHandle ppEffectAdjust [-1];</sqf>
 
Example:
<sqf>
["Resolution", 1, [400]] spawn
{
params ["_name", "_priority", "_effect", "_handle"];
while {
_handle = ppEffectCreate [_name, _priority];
_handle < 0;
} do {
_priority = _priority + 1;
};
_handle ppEffectEnable true;
_handle ppEffectAdjust _effect;
_handle ppEffectCommit 5;
waitUntil { ppEffectCommitted _handle };
systemChat "admire effect for a sec";
uiSleep 3;
_handle ppEffectEnable false;
ppEffectDestroy _handle;
};
</sqf>
 
 
== Advanced effects ==
 
{{Feature|important|The advanced effects are not intended to be used by the end user. They cannot be created by [[ppEffectCreate]] and their adjustments (''via'' [[ppEffectAdjust]]) are '''immediate''' and do not require [[ppEffectCommit]].<br/>{{Link|https://forums.bohemia.net/forums/topic/220199-hbaoplus-post-processing-effect/|More info on the forums}}.}}
 
=== LightShafts ===
 
Title: "LightShafts"; Base Priority: N/A
 
* can be used with [[ppEffectAdjust]]
* can be used with [[ppEffectEnable]]
* '''cannot''' be used with [[ppEffectCreate]]
* '''cannot''' be used with [[ppEffectCommit]]
 
{| class="wikitable"
! Parameter !! Meaning !! Type !! Range !! Defaults
|-
| sunInnerRadius || inner radius of the sun. 0 = no radius, 1 = full screen || float || 0.001..1 || 0.01
|-
| sunOuterRadius || outer radius of the sun. Must be > sunInnerRadius. 0 = no radius, 1 = full screen. light intensity fades out from inner to outer radius || float || 0..1 || 0.6
|-
| exposure || strength of effect || float || 0... || 0.45
|-
| decay || how fast intensity of rays decays with distance || float || 0..1 || 0.89
|}
 
Syntax:
<sqf>"LightShafts" ppEffectAdjust [sunInnerRadius, sunOuterRadius, exposure, decay];</sqf>
 
Defaults:
<sqf>"LightShafts" ppEffectAdjust [0.01, 0.6, 0.45, 0.89];</sqf>
 
Example:
<sqf>
0 spawn
{
"LightShafts" ppEffectEnable true;
"LightShafts" ppEffectAdjust [0.1,0.25,0.1,1];
systemChat "admire effect for a sec";
uiSleep 3;
"LightShafts" ppEffectEnable false;
};
</sqf>
 
=== HBAOPlus ===
 
{{Feature|important|HBAOPlus requires DirectX 11 feature level 11 or above as well as being enabled in Video Options to affect display.}}
 
Title: "HBAOPlus"; Base Priority: N/A
 
* can be used with [[ppEffectAdjust]]
* '''cannot''' be used with [[ppEffectEnable]]
* '''cannot''' be used with [[ppEffectCreate]]
* '''cannot''' be used with [[ppEffectCommit]]
 
{| class="wikitable"
! Parameter !! Meaning !! Type !! Range !! Defaults (Soft) !! Defaults (Medium) !! Defaults (Strong)
|-
| radius || AO radius in meters || float || 0...
| colspan="2" style="text-align: center;" | 1
| style="text-align: center;" | 1.2
|-
| bias || hide low-tessellation artifacts || float || 0..0.5
| colspan="3" style="text-align: center;" | 0.3
|-
| detailAO || scale factor for the small-scale AO, the greater the darker || float || 0..2
| style="text-align: center;" | 0.1
| style="text-align: center;" | 0.3
| style="text-align: center;" | 0.5
|-
| coarseAO || scale factor for the large-scale AO, the greater the darker || float || 0..2
| style="text-align: center;" | 0.50
| style="text-align: center;" | 0.75
| style="text-align: center;" | 1.00
|-
| powerExponent || final AO output is pow(AO, powerExponent) || float || 1..4
| colspan="3" style="text-align: center;" | 3
|-
| blurRadius ||  0 = disabled blur, 1 = enabled with a radius of 2, 2 = enabled with a radius of 4. || integer || 0, 1, 2
| colspan="3" style="text-align: center;" | 1
|-
| blurSharpness || the greater the sharpness parameter, the more the blur preserves edges || float || 0...
| colspan="3" style="text-align: center;" | 4
|-
| fadeSharpness || fading of the AO with distance (greater value = sharper transition) || float || 0...
| colspan="3" style="text-align: center;" | 5
|-
| foregroundViewDepth || distance (in meters) of foreground objects - up to this distance the depth is handled differently from the rest of the scene - to prevent huge AO kernel of foreground objects || float || 0...
| colspan="3" style="text-align: center;" | 2
|-
| backgroundViewDepth || distance (in meters) of background objects - AO kernel for objects beyond this distance is computed differently || float || 0...
| colspan="3" style="text-align: center;" | 0
|}
 
Syntax:
<sqf>"HBAOPlus" ppEffectAdjust [radius, bias, detailAO, coarseAO, powerExponent, blurRadius, blurSharpness, fadeSharpness, foregroundViewDepth, backgroundViewDepth];</sqf>
 
Defaults - ''depend on HBAO+ setting in Video Options'':
<sqf>
// HBAO+ Soft
"HBAOPlus" ppEffectAdjust [1.0, 0.3, 0.1, 0.50, 3.0, 1.0, 4.0, 5.0, 2.0, 0.0];
 
// HBAO+ Medium
"HBAOPlus" ppEffectAdjust [1.0, 0.3, 0.3, 0.75, 3.0, 1.0, 4.0, 5.0, 2.0, 0.0];
 
// HBAO+ Strong
"HBAOPlus" ppEffectAdjust [1.2, 0.3, 0.5, 1.0, 3.0, 1.0, 4.0, 5.0, 2.0, 0.0];
</sqf>
 
 
Example:
<sqf>
0 spawn
{
"HBAOPlus" ppEffectAdjust [2, 0.3, 1, 1, 2, 1, 4, 5, 2, 0];
systemChat "admire effect for a sec";
uiSleep 3;
"HBAOPlus" ppEffectAdjust [1.0, 0.3, 0.1, 0.50, 3.0, 1.0, 4.0, 5.0, 2.0, 0.0];
};
</sqf>
 
 
[[Category: Scripting Topics]]

Latest revision as of 12:57, 7 April 2024

Scripting Commands


Usage

Effect Creation

_handle = ppEffectCreate ["effect_type", priority]; _handlesArray = ppEffectCreate [["effect_type0", priority0], ["effect_type1", priority1], /* ... */];

Effect Cancellation

ppEffectDestroy handle; ppEffectDestroy handlesArray;

Effect Disabling

Compared to the effect cancellation, in this case the effect is just disabled but still exists

_handle ppEffectEnable false;

Effect Fade out

Rather than disabling the effect completely at once, it is possible to use ppEffectAdjust to fade it out over time

//after having created and used effect: //set the parameters for the effect back to the default values "colorCorrections" ppEffectAdjust [1,1,0,[0,0,0,0],[1,1,1,1],[0.299, 0.587, 0.114, 0],[-1,-1,0,0,0,0,0]]; //then commit and fade out over given time (10 seconds) "colorCorrections" ppEffectCommit 10; //Disable completely after fadeout "colorCorrections" ppEffectEnable false;

Parameter Setup

handle ppEffectAdjust [par0, par1, /* ... */, parN];

Parameter application

handle ppEffectCommit _duration; handlesArray ppEffectCommit _duration;

Effect Permission

handle ppEffectEnable _OnOrOff; handlesArray ppEffectEnable _OnOrOff;

Check if Enabled

ppEffectEnabled handle;

Example

_handle = ppEffectCreate ["colorCorrections", 1501]; _handle ppEffectEnable true; _handle ppEffectAdjust [1.0, 1.0, 0.0, [1.0, 0.1, 1.0, 0.75], [0.0, 1.0, 1.0, 1.0], [0.199, 0.587, 0.114, 0.0]]; _handle ppEffectCommit 0; sleep 10; ppEffectDestroy _handle;

Table of Priorities

Priority defines sequence in which post effects are applied. The higher priority, the later the effect will be applied, on top of the others.

Base Priority Effect
2500 ColorInversion
2000 FilmGrain
1500 ColorCorrections
400 DynamicBlur
300 WetDistortion
200 ChromaticAberration
100 RadialBlur
0 SSAO
0 Resolution


Parameters of Individual Effects

RadialBlur

Title: "RadialBlur"; Base Priority: 100

ⓘ
RadialBlur will not do anything if RADIAL BLUR is disabled in Video Options
Parameter Meaning Type Range Defaults
powerX relative blur degree on axis X float 0... 0.01
powerY relative blur degree on axis Y float 0... 0.01
offsetX relative size X of un-blurred centre float 0... 0.06
offsetY relative size Y of un-blurred centre float 0... 0.06

Syntax:

_radialBlurHandle ppEffectAdjust [powerX, powerY, offsetX, offsetY];

Defaults:

_radialBlurHandle ppEffectAdjust [0.01, 0.01, 0.06, 0.06];

Example:

["RadialBlur", 100, [100, 0.5, 0.1, 0.5]] spawn { params ["_name", "_priority", "_effect", "_handle"]; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0 } do { _priority = _priority + 1; }; _handle ppEffectEnable true; _handle ppEffectAdjust _effect; _handle ppEffectCommit 5; waitUntil { ppEffectCommitted _handle }; systemChat "admire effect for a sec"; uiSleep 3; _handle ppEffectEnable false; ppEffectDestroy _handle; };

ChromAberration

Title "ChromAberration"; Base Priority: 200

Parameter Meaning Type Range Defaults
aberrationPowerX relative effect strength (sample spacing from each other) axis X float 0... 0.005
aberrationPowerY relative effect strength (sample spacing from each other) axis Y float 0... 0.005
aspectCorrection enable/disable correction according to screen aspect ratio bool true, false false

Syntax:

_chromaticAberrationHandle ppEffectAdjust [aberrationPowerX, aberrationPowerY, aspectCorrection];

Defaults:

_chromaticAberrationHandle ppEffectAdjust [0.005, 0.005, false];

Example:

["ChromAberration", 200, [0.05, 0.05, true]] spawn { params ["_name", "_priority", "_effect", "_handle"]; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0 } do { _priority = _priority + 1; }; _handle ppEffectEnable true; _handle ppEffectAdjust _effect; _handle ppEffectCommit 5; waitUntil { ppEffectCommitted _handle }; systemChat "admire effect for a sec"; uiSleep 3; _handle ppEffectEnable false; ppEffectDestroy _handle; };

WetDistortion

Title: "WetDistortion"; Base Priority: 300

ⓘ
Effect cancels automatically under water.
Parameter Meaning Type Range Defaults
value blurriness of distorted image (0 to 1, values above 1 cause unusual) float 0..1 1
top, bottom effect power (top/bottom of screen separately) float 0..1 1, 1
horizontal1, horizontal2, vertical1, vertical2 waves speeds (frequency/PI) float 0... 4.10, 3.70, 2.50, 1.85
horizontal1, horizontal2, vertical1, vertical2 waves amplitudes (delta texture coordinates) float 0... 0.0054, 0.0041, 0.0090, 0.0070
randX, randY coefficients for phase computing; weight of random vertex data on horizontal/vertical wave phases float 0... 0.5, 0.3
posX, posY coefficients for phase computing; weight of vertex X/Y-position on horizontal/vertical wave phases float 0... 10.0, 6.0

Syntax:

_wetDistorsionHandle ppEffectAdjust [ value, top, bottom, horizontal1, horizontal2, vertical1, vertical2, horizontal1, horizontal2, vertical1, vertical2, randX, randY, posX, posY ];

Defaults:

_wetDistorsionHandle ppEffectAdjust [ 1, 1, 1, 4.10, 3.70, 2.50, 1.85, 0.0054, 0.0041, 0.0090, 0.0070, 0.5, 0.3, 10.0, 6.0 ];

Example:

["WetDistortion", 300, [1, 0, 1, 4.10, 3.70, 2.50, 1.85, 0.0054, 0.0041, 0.05, 0.0070, 1, 1, 1, 1]] spawn { params ["_name", "_priority", "_effect", "_handle"]; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0 } do { _priority = _priority + 1; }; _handle ppEffectEnable true; _handle ppEffectAdjust _effect; _handle ppEffectCommit 5; waitUntil { ppEffectCommitted _handle }; systemChat "admire effect for a sec"; uiSleep 3; _handle ppEffectEnable false; ppEffectDestroy _handle; };

ColorCorrections

Title: "ColorCorrections"; Base Priority: 1500

Parameter Meaning Type Range Defaults
brightness image brightness (0 - black, 1 - unchanged, 2 - white ) float 0..2 1
contrast image contrast (1 - normal contrast) float 0... 1
offset image contrast offset (0 - unchanged ) float 0... 0
[r, g, b, a] color for blending (r, g, b - color, a - blend factor (0 - original color, 1 - blend color )) float 0..1 [0, 0, 0, 0]
[r, g, b, a] color for colorization ( r, g, b - color, a - saturation (0 - original color, 1 - B&W multiplied by colorize color)) float 0..1 [1, 1, 1, 1]
[r, g, b, 0] color rgb weights for desaturation float 0..1 [0.299, 0.587, 0.114, 0]
[

    radialMajorAxisRadius,
    radialMinorAxisRadius,
    radialRotationDeg,
    radialCenterX,
    radialCenterY,
    radialInnerRadiusCoef,
    radialInterpCoef
]

radial color (optional, Arma 3 only)

major axis radius of ellipse
minor axis radius of ellipse
rotation of ellipse axis (in degrees)
centerX of ellipse on the screen (in relative coords, [-0.5] -> [0.5], where 0 is in the screen center)
centerY of ellipse on the screen (in relative coords, [-0.5] -> [0.5], where 0 is in the screen center)
coefficient for inner radius (where effect is not applied)
coefficient for color interpolation between inner and outer radius
 


float
float
float
float
float
float
float
 


0..1
0..1
0..359
-1..1
-1..1
0..1
0...
 

[
    -1,
    -1,
    0,
    0,
    0,
    0,
    0
]

Syntax:

Arma 3 logo black.png1.00 Logo A2.png1.00A2 OA Logo.png1.50
_colorCorrectionHandle ppEffectAdjust [ brightness, contrast, offset, [blendR, blendG, blendB, blendA], [colorizeR, colorizeG, colorizeB, colorizeA], [weightR, weightG, weightB, 0], [a, b, angle, cx, cy, innerRCoef, interpCoef] ];
_colorCorrectionHandle ppEffectAdjust [ brightness, contrast, offset, [blendR, blendG, blendB, blendA], [colorizeR, colorizeG, colorizeB, colorizeA], [weightR, weightG, weightB, 0] ];

Defaults:

Arma 3 logo black.png1.00 Logo A2.png1.00A2 OA Logo.png1.50
_colorCorrectionHandle ppEffectAdjust [ 1, 1, 0, [0, 0, 0, 0], [1, 1, 1, 1], [0.299, 0.587, 0.114, 0], [-1, -1, 0, 0, 0, 0, 0] ];
_colorCorrectionHandle ppEffectAdjust [ 1, 1, 0, [0, 0, 0, 0], [1, 1, 1, 1], [0.299, 0.587, 0.114, 0] ];

Example:

["ColorCorrections", 1500, [1, 0.4, 0, [0, 0, 0, 0], [1, 1, 1, 0], [1, 1, 1, 0]]] spawn { params ["_name", "_priority", "_effect", "_handle"]; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0 } do { _priority = _priority + 1; }; _handle ppEffectEnable true; _handle ppEffectAdjust _effect; _handle ppEffectCommit 5; waitUntil { ppEffectCommitted _handle }; systemChat "admire effect for a sec"; uiSleep 3; _handle ppEffectEnable false; ppEffectDestroy _handle; };

DynamicBlur

Title: "DynamicBlur"; Base Priority: 400

Parameter Meaning Type Range Defaults
value blurriness float 0... 0

Syntax:

_dynamicBlurHandle ppEffectAdjust [value];

Defaults:

_dynamicBlurHandle ppEffectAdjust [0];

Example:

["DynamicBlur", 400, [10]] spawn { params ["_name", "_priority", "_effect", "_handle"]; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0 } do { _priority = _priority + 1; }; _handle ppEffectEnable true; _handle ppEffectAdjust _effect; _handle ppEffectCommit 5; waitUntil { ppEffectCommitted _handle }; systemChat "admire effect for a sec"; uiSleep 3; _handle ppEffectEnable false; ppEffectDestroy _handle; };

FilmGrain

Title: "FilmGrain"; Base Priority: 2000

Arma 3
In Arma 3 the monochromatic parameter is numeric. Use 0 for monochrome, any other value for colour.

Number of parameters is flexible: it may be defined from 1 to 6 parameters, meaning of individual parameters is following:

Parameter Meaning Type Range Default
intensity intensity float 0..1 0.005
sharpness sharpness float 1..20 1.25
grainSize grain size float 1..8 2.01
intensityX0 intensityX0 float -x..0..+x 0.75
intensityX1 intensityX1 float -x..0..+x 1.0
monochromatic Logo A2.png1.00A2 OA Logo.png1.50 monochromatic bool false, true true
Arma 3 logo black.png1.00 monochromatic integer 0, 1 0

Syntax:

_filmGrainHandle ppEffectAdjust [ intensity, sharpness, grainSize, intensityX0, intensityX1, monochromatic ];

Defaults:

Arma 3 logo black.png1.00 Logo A2.png1.00A2 OA Logo.png1.50
_filmGrainHandle ppEffectAdjust [ 0.005, 1.25, 2.01, 0.75, 1.0, 0 ];
_filmGrainHandle ppEffectAdjust [ 0.005, 1.25, 2.01, 0.75, 1.0, true ];

Example:

Arma 3 logo black.png1.00 Logo A2.png1.00A2 OA Logo.png1.50
["FilmGrain", 2000, [1, 0.15, 7, 0.2, 1.0, 0]] spawn { params ["_name", "_priority", "_effect"]; private _handle = -1; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0; } do { _priority = _priority + 1; }; _handle ppEffectEnable true; _handle ppEffectAdjust _effect; _handle ppEffectCommit 5; waitUntil { sleep 0.1; ppEffectCommitted _handle }; systemChat "admire effect for a sec"; uiSleep 3; _handle ppEffectEnable false; ppEffectDestroy _handle; };
["FilmGrain", 2000, [1, 0.15, 7, 0.2, 1.0, true]] spawn { local _name = _this select 0; local _priority = _this select 1; local _effect = _this select 2; local _handle = -1; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0; } do { _priority = _priority + 1; }; _handle ppEffectEnable true; _handle ppEffectAdjust _effect; _handle ppEffectCommit 5; waitUntil { sleep 0.1; ppEffectCommitted _handle }; systemChat "admire effect for a sec"; uiSleep 3; _handle ppEffectEnable false; ppEffectDestroy _handle; };

ColorInversion

Title: "ColorInversion"; Base Priority: 2500

Parameter Meaning Type Range Defaults
Red Inversion of R channel (image inversion (0..no blur, 1..very blurred) float 0..1 0
Green Inversion of G channel (image inversion (0..no blur, 1..very blurred) float 0..1 0
Blue Inversion of B channel (image inversion (0..no blur, 1..very blurred) float 0..1 0

Syntax:

_colorInversionHandle ppEffectAdjust [Red, Green, Blue];

Defaults:

_colorInversionHandle ppEffectAdjust [0, 0, 0];

Example:

["ColorInversion", 2500, [0.5, 0.5, 0.5]] spawn { params ["_name", "_priority", "_effect", "_handle"]; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0 } do { _priority = _priority + 1; }; _handle ppEffectEnable true; _handle ppEffectAdjust _effect; _handle ppEffectCommit 5; waitUntil { ppEffectCommitted _handle }; systemChat "admire effect for a sec"; uiSleep 3; _handle ppEffectEnable false; ppEffectDestroy _handle; };

SSAO

Title: "SSAO"; Base Priority: 0

Parameter Meaning Type Range Defaults
intensity float 0..1 0
threshold0 float 0..1 0
threshold0 float 0..1 0
nearRadius float 0..1 0
farRadius float 0..1 0
nearDist float 0..1 0
farDist float 0..1 0
depthBlurDist float 0..1 0
blurPasses integer 0..x 0
halfRes bool true, false false
blurHalfRes boolean true, false false

Syntax:

_ssaoHandle ppEffectAdjust [ intensity, threshold0, threshold1, nearRadius, farRadius, nearDist, farDist, depthBlurDist, blurPasses, halfRes, blurHalfRes ];

Defaults:

_ssaoHandle ppEffectAdjust [0, 0, 0, 0, 0, 0, 0, 0, 0, false, false];

Example:

["SSAO", 1, [3, 0.25, 0.75, 5, 50, 5, 25, 100, 3, true, true]] spawn { params ["_name", "_priority", "_effect", "_handle"]; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0; } do { _priority = _priority + 1; }; _handle ppEffectEnable true; _handle ppEffectAdjust _effect; _handle ppEffectCommit 5; waitUntil { ppEffectCommitted _handle }; systemChat "admire effect for a sec"; uiSleep 3; _handle ppEffectEnable false; ppEffectDestroy _handle; };

Resolution

Title: "Resolution"; Base Priority: 0

Parameter Meaning Type Range Defaults
verticalResolution define the render's vertical resolution.

If the value is negative, the resolution goes back to normal. If the value is greater than the final render's vertical resolution, it gets clamped to it.
The effect can be disabled in both cases.

integer -1..x -1

Syntax:

_resolutionHandle ppEffectAdjust [verticalResolution];

Defaults:

_ssaoHandle ppEffectAdjust [-1];

Example:

["Resolution", 1, [400]] spawn { params ["_name", "_priority", "_effect", "_handle"]; while { _handle = ppEffectCreate [_name, _priority]; _handle < 0; } do { _priority = _priority + 1; }; _handle ppEffectEnable true; _handle ppEffectAdjust _effect; _handle ppEffectCommit 5; waitUntil { ppEffectCommitted _handle }; systemChat "admire effect for a sec"; uiSleep 3; _handle ppEffectEnable false; ppEffectDestroy _handle; };


Advanced effects

⚠
The advanced effects are not intended to be used by the end user. They cannot be created by ppEffectCreate and their adjustments (via ppEffectAdjust) are immediate and do not require ppEffectCommit.
More info on the forums.

LightShafts

Title: "LightShafts"; Base Priority: N/A

Parameter Meaning Type Range Defaults
sunInnerRadius inner radius of the sun. 0 = no radius, 1 = full screen float 0.001..1 0.01
sunOuterRadius outer radius of the sun. Must be > sunInnerRadius. 0 = no radius, 1 = full screen. light intensity fades out from inner to outer radius float 0..1 0.6
exposure strength of effect float 0... 0.45
decay how fast intensity of rays decays with distance float 0..1 0.89

Syntax:

"LightShafts" ppEffectAdjust [sunInnerRadius, sunOuterRadius, exposure, decay];

Defaults:

"LightShafts" ppEffectAdjust [0.01, 0.6, 0.45, 0.89];

Example:

0 spawn { "LightShafts" ppEffectEnable true; "LightShafts" ppEffectAdjust [0.1,0.25,0.1,1]; systemChat "admire effect for a sec"; uiSleep 3; "LightShafts" ppEffectEnable false; };

HBAOPlus

⚠
HBAOPlus requires DirectX 11 feature level 11 or above as well as being enabled in Video Options to affect display.

Title: "HBAOPlus"; Base Priority: N/A

Parameter Meaning Type Range Defaults (Soft) Defaults (Medium) Defaults (Strong)
radius AO radius in meters float 0... 1 1.2
bias hide low-tessellation artifacts float 0..0.5 0.3
detailAO scale factor for the small-scale AO, the greater the darker float 0..2 0.1 0.3 0.5
coarseAO scale factor for the large-scale AO, the greater the darker float 0..2 0.50 0.75 1.00
powerExponent final AO output is pow(AO, powerExponent) float 1..4 3
blurRadius 0 = disabled blur, 1 = enabled with a radius of 2, 2 = enabled with a radius of 4. integer 0, 1, 2 1
blurSharpness the greater the sharpness parameter, the more the blur preserves edges float 0... 4
fadeSharpness fading of the AO with distance (greater value = sharper transition) float 0... 5
foregroundViewDepth distance (in meters) of foreground objects - up to this distance the depth is handled differently from the rest of the scene - to prevent huge AO kernel of foreground objects float 0... 2
backgroundViewDepth distance (in meters) of background objects - AO kernel for objects beyond this distance is computed differently float 0... 0

Syntax:

"HBAOPlus" ppEffectAdjust [radius, bias, detailAO, coarseAO, powerExponent, blurRadius, blurSharpness, fadeSharpness, foregroundViewDepth, backgroundViewDepth];

Defaults - depend on HBAO+ setting in Video Options:

// HBAO+ Soft "HBAOPlus" ppEffectAdjust [1.0, 0.3, 0.1, 0.50, 3.0, 1.0, 4.0, 5.0, 2.0, 0.0]; // HBAO+ Medium "HBAOPlus" ppEffectAdjust [1.0, 0.3, 0.3, 0.75, 3.0, 1.0, 4.0, 5.0, 2.0, 0.0]; // HBAO+ Strong "HBAOPlus" ppEffectAdjust [1.2, 0.3, 0.5, 1.0, 3.0, 1.0, 4.0, 5.0, 2.0, 0.0];


Example:

0 spawn { "HBAOPlus" ppEffectAdjust [2, 0.3, 1, 1, 2, 1, 4, 5, 2, 0]; systemChat "admire effect for a sec"; uiSleep 3; "HBAOPlus" ppEffectAdjust [1.0, 0.3, 0.1, 0.50, 3.0, 1.0, 4.0, 5.0, 2.0, 0.0]; };

Retrieved from "https://community.bistudio.com/wiki?title=Post_Process_Effects&oldid=363575"