The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

Difference between revisions of "UE3:SceneCapturePortalComponent (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
(Talk)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{infobox class
+
{{UE3:SceneCapturePortalComponent (UT3)}}
| package = Engine
+
| parent1 = SceneCaptureComponent
+
| parent2 = ActorComponent
+
| parent3 = Component
+
| parent4 = Object
+
}}
+
{{autogenerated}}
+
SceneCapturePortalComponent
+
 
+
Captures the scene as if viewed through a portal to a
+
2D texture render target.
+
 
+
==Properties==
+
===Property group 'Capture'===
+
====ScaleFOV====
+
'''Type:''' [[float]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' const
+
 
+
scale field of view so that there can be some overdraw
+
 
+
'''Default value:''' 1.0
+
 
+
====TextureTarget====
+
'''Type:''' {{cl|TextureRenderTarget2D}}
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' const
+
 
+
render target resource to set as target for capture
+
 
+
====ViewDestination====
+
'''Type:''' {{cl|Actor}}
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' const
+
 
+
actor at the target view location for this portal
+
(this will be the point where the scene is captured from)
+
 
+
===Default values===
+
{| class="list defaults"
+
! Property
+
! Value
+
|-
+
| {{tl|bSkipUpdateIfOwnerOccluded||SceneCaptureComponent}}
+
| True
+
|-
+
| {{tl|FrameRate||SceneCaptureComponent}}
+
| 1000.0
+
|}
+
 
+
==Native functions==
+
====SetCaptureParameters====
+
{{code|native noexport final function '''SetCaptureParameters''' (optional {{cl|TextureRenderTarget2D}} '''NewTextureTarget''', optional [[float]] '''NewScaleFOV''', optional {{cl|Actor}} '''NewViewDest''')}}
+
 
+
<!-- enter function description -->
+

Revision as of 06:12, 17 January 2010

UDK Object >> Component >> ActorComponent >> SceneCaptureComponent >> SceneCapturePortalComponent
Package: 
Engine
This class in other games:
UT3

SceneCapturePortalComponent

Captures the scene as if viewed through a portal to a 2D texture render target.

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties

Property group 'Capture'

ScaleFOV

Type: float

Modifiers: const

scale field of view so that there can be some overdraw

Default value: 1.0

TextureTarget

Type: TextureRenderTarget2D

Modifiers: const

render target resource to set as target for capture

ViewDestination

Type: Actor

Modifiers: const

actor at the target view location for this portal (this will be the point where the scene is captured from)

Default values

Property Value
bSkipUpdateIfOwnerOccluded True
FrameRate 1000.0

Native functions

SetCaptureParameters

native noexport final function SetCaptureParameters (optional TextureRenderTarget2D NewTextureTarget, optional float NewScaleFOV, optional Actor NewViewDest)

interface for changing TextureTarget, ScaleFOV, and ViewDestination