Cogito, ergo sum

UE3:SceneCaptureComponent (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> Component >> ActorComponent >> SceneCaptureComponent
Package: 
Engine
Direct subclasses:
SceneCapture2DComponent, SceneCaptureCubeMapComponent, SceneCapturePortalComponent, SceneCaptureReflectComponent
This class in other games:
UDK

SceneCaptureComponent

Base class for scene recording components

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

Properties[edit]

Property group 'Capture'[edit]

bEnableFog[edit]

Type: bool

toggle fog

bEnablePostProcess[edit]

Type: bool

toggle scene post-processing

ClearColor[edit]

Type: Object.Color

background color

Default value:

Member Value
A 255
B 0
G 0
R 0

FrameRate[edit]

Type: float

Modifiers: const

rate to capture the scene, TimeBetweenCaptures = Max( 1/FrameRate, DeltaTime), if the FrameRate is 0 then the scene is captured only once

Default value: 30.0

MaxStreamingUpdateDist[edit]

Type: float

if > 0, skip streaming texture updates for the scene capture if the Owner is further than this many units away from the viewer

MaxUpdateDist[edit]

Type: float

if > 0, skip updating the scene capture if the Owner is further than this many units away from the viewer

PostProcess[edit]

Type: PostProcessChain

Chain of post process effects for this post process view

SceneLOD[edit]

Type: int

level-of-detail setting

ViewMode[edit]

Type: ESceneCaptureViewMode

how to draw the scene

Default value: SceneCapView_LitNoShadows

Internal variables[edit]

bNeedsSceneUpdate[edit]

Type: bool

Modifiers: private, const, transient, native

TRUE if the scene capture needs to be updated in the scene

bSkipUpdateIfOwnerOccluded[edit]

Type: bool

if true, skip updating the scene capture if the Owner of the component has not been rendered recently

CaptureInfo[edit]

Type: pointer{FCaptureSceneInfo}

Modifiers: private, const, transient, native

ptr to the scene capture probe

ViewState[edit]

Type: pointer{FSceneViewStateInterface}

Modifiers: private, const, transient, native

pointer to the persistent view state for this scene capture

Enums[edit]

ESceneCaptureViewMode[edit]

SceneCapView_Lit 
SceneCapView_Unlit 
SceneCapView_LitNoShadows 
SceneCapView_Wire 

Native functions[edit]

SetFrameRate[edit]

native final function SetFrameRate (float NewFrameRate)

modifies the value of FrameRate