Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Components > USceneCaptureComponent

Light Theme

Dark Theme

USceneCaptureComponent

-> will be exported to EngineDecalClasses.h

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

USceneCaptureComponent

	UPlanarReflectionComponent
	USceneCaptureComponent2D
	USceneCaptureComponentCube

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/SceneCaptureComponent.h
Include	#include "Components/SceneCaptureComponent.h"

Syntax

class USceneCaptureComponent : public USceneComponent

Remarks

-> will be exported to EngineDecalClasses.h

Variables

	Name	Description
bool	bAlwaysPersistRenderingState	Whether to persist the rendering state even if bCaptureEveryFrame==false.
uint8: 1	bCaptureEveryFrame	Whether to update the capture's contents every frame.
uint8: 1	bCaptureOnMovement	Whether to update the capture's contents on movement.
bool	bUseRayTracingIfEnabled	Whether to use ray tracing for this capture. Ray Tracing must be enabled in the project.
UStaticMesh ...	CaptureMesh	The mesh used by ProxyMeshComponent
int32	CaptureSortPriority	Capture priority within the frame to sort scene capture on GPU to resolve interdependencies between multiple capture components.
TEnumAsByte< en...	CaptureSource
EStereoscopicPa...	CaptureStereoPass	Indicates which stereo pass this component is capturing for, if any
TArray< AActor ...	HiddenActors	The actors to hide in the scene capture.
TArray< TWeakOb...	HiddenComponents	The components won't rendered by current component.
float	LODDistanceFactor	Scales the distance used by LOD.
float	MaxViewDistanceOverride	If > 0, sets a maximum render distance override.
ESceneCapturePr...	PrimitiveRenderMode	Controls what primitives get rendered into the scene capture.
FString	ProfilingEventName	Name of the profiling event.
UStaticMeshComp...	ProxyMeshComponent	The mesh to show visually where the camera is placed
FEngineShowFlag...	ShowFlags	TODO: Make this a UStruct to set directly?
TArray< struct ...	ShowFlagSettings	ShowFlags for the SceneCapture's ViewFamily, to control rendering settings for this view.
TArray< AActor ...	ShowOnlyActors	The only actors to be rendered by this scene capture, if PrimitiveRenderMode is set to UseShowOnlyList.
TArray< TWeakOb...	ShowOnlyComponents	The only components to be rendered by this scene capture, if PrimitiveRenderMode is set to UseShowOnlyList.
TIndirectArray<...	ViewStates	The view state holds persistent scene rendering state and enables occlusion culling in scene captures.

Constructors

	Name	Description
	USceneCaptureComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	ClearHiddenComponents()	Clears the hidden list.
void	ClearShowOnlyComponents()	Clears the Show Only list.
const AActor...	GetViewOwner()	To leverage a component's bOwnerNoSee/bOnlyOwnerSee properties, the capture view requires an "owner".
FSceneViewSt...	GetViewState ( int32 ViewIndex )	Returns the view state, if any, and allocates one if needed.
void	HideActorComponents ( AActor* InActor, const bool bIncludeFromChildActors )	Adds all primitive components in the actor to our list of hidden components.
void	HideComponent ( UPrimitiveComponent* InCompone... )	Adds the component to our list of hidden components.
void	RemoveShowOnlyActorComponents ( AActor* InActor, const bool bIncludeFromChildActors )	Removes an actor's components from the Show Only list.
void	RemoveShowOnlyComponent ( UPrimitiveComponent* InCompone... )	Removes a component from the Show Only list.
void	SetCaptureSortPriority ( int32 NewCaptureSortPriority )	Changes the value of TranslucentSortPriority.
void	ShowOnlyActorComponents ( AActor* InActor, const bool bIncludeFromChildActors )	Adds all primitive components in the actor to our list of show-only components.
void	ShowOnlyComponent ( UPrimitiveComponent* InCompone... )	Adds the component to our list of show-only components.
void	UpdateDeferredCaptures ( FSceneInterface* Scene )
void	UpdateSceneCaptureContents ( FSceneInterface* Scene )
void	UpdateShowFlags()	Update the show flags from our show flags settings (ideally, you'd be able to set this more directly, but currently unable to make FEngineShowFlags a UStruct to use it as a FProperty...)

Overridden from UActorComponent

	Name	Description
void	OnComponentDestroyed ( bool bDestroyingHierarchy )	Called when a component is destroyed
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.

Overridden from UObject

	Name	Description
bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss