UE3:SceneCapturePortalComponent (UDK): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
No edit summary
 
m 1 revision: class descriptions for UDK January update (part 4)
 
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 -->

Latest revision as of 05:44, 17 January 2010

UDK Object >> Component >> ActorComponent >> SceneCaptureComponent >> SceneCapturePortalComponent
Package:
Engine
This class in other games:
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

Retrieved from "https://wiki.beyondunreal.com/index.php?title=UE3:SceneCapturePortalComponent_(UDK)&oldid=41401"