setPiPEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(73 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command


{{Command|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| TKOH |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|gr1= Camera Control
____________________________________________________________________________________________


| Set a Render Target's visual effect (Picture-in-Picture).  
|descr= Sets Render Target's visual effect (Picture-in-Picture).
* 0: normal (HDR)
{{{!}} class="wikitable align-center-col-1" style="font-size: .95em"
* 1: NV
! Mode
* 2: TI
! Description
* 3: Color correction
! Parameters
* 4: Mirror  
{{!}}-
|= Description
{{!}} 0
____________________________________________________________________________________________
{{!}} Normal
{{!}} [0]
{{!}}-
{{!}} 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]|= Syntax
|s1= name [[setPiPEffect]] [effect, optionalParam1, optionalParam2, ...]


|p1= name : [[String]] - Render Target name |= Parameter 1
|p1= name : [[String]] - render surface reference from [[Procedural Textures#Render To Texture|Render To Texture]]
|p2= effect : [[Number]] - effect type |= Parameter 2
|p3= optionalParam1: Parameters based on selected effect |= Parameter 3


| [[Nothing]] |= Return value
|p2= effect : [[Number]] - effect type
____________________________________________________________________________________________


|x1= <code>"rendertarget0" 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> |=


| |= See also
|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>


<h3 style="display:none">Notes</h3>
|x3= <sqf>
<dl class="command_description">
private _cam = "camera" camCreate (player modelToWorld [0,-5,2]);
<!-- Note Section BEGIN -->
_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>


<!-- Note Section END -->
|x4= Black & White:
</dl>
<sqf>"rtt" setPiPEffect [3, 1, 1.0, 0.4, 0, [0,0,0,0], [1,1,1,0], [1,1,1,1]];</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[Procedural Textures]] [[camCreate]] [[cameraEffect]] [[Post Process Effects]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Take On Helicopters: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
 
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
{{Note
|user= Killzone_Kid
|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.
}}

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.