setPiPEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Command " to "{{RV|type=command ")
mNo edit summary
 
(42 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| TKOH
|game1= tkoh
|version1= 1.00


|1.00
|game2= arma3
|version2= 0.50


|gr1= Camera Control
|gr1= Camera Control


| Sets Render Target's visual effect (Picture-in-Picture).  
|descr= Sets Render Target's visual effect (Picture-in-Picture).
* 0: Normal - [0]
{{{!}} class="wikitable align-center-col-1" style="font-size: .95em"
* 1: Night Vision - [1]
! Mode
* 2: Thermal - [2]
! Description
* 3: [[Post_process_effects#ColorCorrections|Color Correction]] - [3, enabled, brightness, contrast, offset, blend [r,g,b,a], lerp [r,g,b,a], rgb [r,g,b,a]]
! Parameters
* 4: Mirror - [4] '''<currently not working>'''
{{!}}-
* 5: [[Post_process_effects#ChromAberration|Chromatic Aberration]] - [5, enabled, powerx, powery, (bool) aspectCorrection] '''<currently not working>'''
{{!}} 0
* 6: [[Post_process_effects#FilmGrain| Film Grain]] - [6, enabled, intensity, sharpness, grainsize, intensityx1, intensityx2, (bool) monochromatic] '''<currently not working>'''
{{!}} Normal
* 7: Thermal Inverted [7]
{{!}} [0]
* 8: Green Thermal [8]
{{!}}-
{{!}} 1
{{!}} Night Vision
{{!}} [1]
{{!}}-
{{!}} 2
{{!}} Thermal Imaging
{{!}} [2]
{{!}}-
{{!}} 3
{{!}} [[Post Process Effects#ColorCorrections|Color Correction]]
{{!}} [3, enabled, brightness, contrast, offset, blend [r,g,b,a], lerp [r,g,b,a], rgb [r,g,b,a]]
{{!}}-
<!--
{{!}} 4
{{!}} Mirror - '''non-functional'''
{{!}} [4]
{{!}}-
{{!}} 5
{{!}} [[Post Process Effects#ChromAberration|Chromatic Aberration]] - '''non-functional'''
{{!}} [5, enabled, powerx, powery, (bool) aspectCorrection]
{{!}}-
{{!}} 6
{{!}} [[Post Process Effects#FilmGrain| Film Grain]] - '''non-functional'''
{{!}} <small>[6, enabled, intensity, sharpness, grainsize, intensityx1, intensityx2, (bool) monochromatic]</small>
{{!}}-
-->
{{!}} 7
{{!}} Alt. Thermal Imaging 1 (Inverted)
{{!}} [7]
{{!}}-
{{!}} 8
{{!}} Alt. Thermal Imaging 2 (Green)
{{!}} [8]
{{!}}-
{{!}} 9..70
{{!}} {{GVI|arma3|2.10|size= 0.75}} Alt. Thermal Imaging 3..64
{{!}} ''[n]''
{{!}}}


| name '''setPiPEffect''' [effect, optionalParam1, ..., optionalParamN]
|s1= name [[setPiPEffect]] [effect, optionalParam1, optionalParam2, ...]


|p1= name : [[String]] - Render surface reference from [[Procedural_Textures#Render_To_Texture|Render To Texture]]
|p1= name : [[String]] - render surface reference from [[Procedural Textures#Render To Texture|Render To Texture]]
|p2= [effect, optionalParam1, ..., optionalParamN] : [[Array]]
|p3= effect : [[Number]] - effect type
|p4= optionalParam1: Parameters based on selected effect


| [[Nothing]]
|p2= effect : [[Number]] - effect type


|x1= <code>"rendersurface" [[setPiPEffect]] [0];</code>
|p3= optionalParamN: [[Number]] - (Optional) parameters based on selected effect
|x2= <code>"rendertarget0" [[setPiPEffect]] [3, 1.0, 1.0, 1.0, 0.0, [0.0, 1.0, 0.0, 0.25], [1.0, 0.0, 1.0, 1.0],  [0.199, 0.587, 0.114, 0.0]];</code>
|x3= <code>cam = "camera" [[camCreate]] ([[player]] [[modelToWorld]] [0,-5,2]);
cam [[cameraEffect]] ["internal","back","rtt"];
"rtt" [[setPiPEffect]] [2];
[[with]] [[uiNamespace]] [[do]] {
pic = [[findDisplay]] 46 [[ctrlCreate]] ["RscPicture", -1];
pic [[ctrlSetPosition]] [0,0,1,1];
pic [[ctrlCommit]] 0;
pic [[ctrlSetText]] "#(argb,512,512,1)r2t(rtt,1.0)";
};</code>
|x4= Black&White:<code>"rtt" [[setPiPEffect]] [3,1,1,0.4,0,[0,0,0,0],[1,1,1,0],[1,1,1,1]];</code>


| [[Procedural Textures]], [[camCreate]], [[cameraEffect]], [[Post process effects]]
|r1= [[Nothing]]
 
|x1= <sqf>"rendersurface" setPiPEffect [0];</sqf>
 
|x2= <sqf>"rendertarget0" setPiPEffect [3, 1, 1.0, 1.0, 0.0, [0.0, 1.0, 0.0, 0.25], [1.0, 0.0, 1.0, 1.0],  [0.199, 0.587, 0.114, 0.0]];</sqf>
 
|x3= <sqf>
private _cam = "camera" camCreate (player modelToWorld [0,-5,2]);
_cam cameraEffect ["internal", "back", "rtt"];
"rtt" setPiPEffect [2];
with uiNamespace do {
private _pic = findDisplay 46 ctrlCreate ["RscPicture", -1];
_pic ctrlSetPosition [0,0,1,1];
_pic ctrlCommit 0;
_pic ctrlSetText "#(argb,512,512,1)r2t(rtt,1.0)";
};
</sqf>
 
|x4= Black & White:
<sqf>"rtt" setPiPEffect [3, 1, 1.0, 0.4, 0, [0,0,0,0], [1,1,1,0], [1,1,1,1]];</sqf>
 
|seealso= [[Procedural Textures]] [[camCreate]] [[cameraEffect]] [[Post Process Effects]]
}}
}}


{{GameCategory|tkoh|Scripting Commands}}
{{Note
{{GameCategory|arma3|New Scripting Commands}}
|user= Killzone_Kid
{{GameCategory|arma3|Scripting Commands}}
|timestamp= 20170709200400
 
|text= If Color Corrections effect has been used, going back to Normal will have no effect. In order to unset Color Corrections, set the 2nd param in it (enable) to 0.
<!-- CONTINUE Notes -->
}}
<dl class="command_description">
<dd class="notedate">Posted on July 9, 2017 - 20:04 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">If Color Corrections effect has been used, going back to Normal will have no effect. In order to unset Color Corrections, set 2nd param in it (enable) to 0.</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 04:13, 27 November 2023

Hover & click on the images for description

Description

Description:
Sets Render Target's visual effect (Picture-in-Picture).
Mode Description Parameters
0 Normal [0]
1 Night Vision [1]
2 Thermal Imaging [2]
3 Color Correction [3, enabled, brightness, contrast, offset, blend [r,g,b,a], lerp [r,g,b,a], rgb [r,g,b,a]]
7 Alt. Thermal Imaging 1 (Inverted) [7]
8 Alt. Thermal Imaging 2 (Green) [8]
9..70 Arma 3 logo black.png2.10 Alt. Thermal Imaging 3..64 [n]
Groups:
Camera Control

Syntax

Syntax:
name setPiPEffect [effect, optionalParam1, optionalParam2, ...]
Parameters:
name : String - render surface reference from Render To Texture
effect : Number - effect type
optionalParamN: Number - (Optional) parameters based on selected effect
Return Value:
Nothing

Examples

Example 1:
"rendersurface" setPiPEffect [0];
Example 2:
"rendertarget0" setPiPEffect [3, 1, 1.0, 1.0, 0.0, [0.0, 1.0, 0.0, 0.25], [1.0, 0.0, 1.0, 1.0], [0.199, 0.587, 0.114, 0.0]];
Example 3:
private _cam = "camera" camCreate (player modelToWorld [0,-5,2]); _cam cameraEffect ["internal", "back", "rtt"]; "rtt" setPiPEffect [2]; with uiNamespace do { private _pic = findDisplay 46 ctrlCreate ["RscPicture", -1]; _pic ctrlSetPosition [0,0,1,1]; _pic ctrlCommit 0; _pic ctrlSetText "#(argb,512,512,1)r2t(rtt,1.0)"; };
Example 4:
Black & White:
"rtt" setPiPEffect [3, 1, 1.0, 0.4, 0, [0,0,0,0], [1,1,1,0], [1,1,1,1]];

Additional Information

See also:
Procedural Textures camCreate cameraEffect Post Process Effects

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
Killzone_Kid - c
Posted on Jul 09, 2017 - 20:04 (UTC)
If Color Corrections effect has been used, going back to Normal will have no effect. In order to unset Color Corrections, set the 2nd param in it (enable) to 0.