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 > USceneCaptureComponent2D

Light Theme

Dark Theme

USceneCaptureComponent2D

Used to capture a 'snapshot' of the scene from a single plane and feed it to a render target.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

USceneCaptureComponent

USceneCaptureComponent2D

References

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

Syntax

class USceneCaptureComponent2D : public USceneCaptureComponent

Remarks

Used to capture a 'snapshot' of the scene from a single plane and feed it to a render target.

Variables

	Name	Description
uint32: 1	bCameraCutThisFrame	True if we did a camera cut this frame.
uint32: 1	bConsiderUnrenderedOpaquePixelAsFullyTranslucent	Treat unrendered opaque pixels as fully translucent.
bool	bDisableFlipCopyGLES	Scene captures render an extra flip pass for LDR color on GLES so that the final output is oriented correctly.
bool	bEnableClipPlane	Enables a clip plane while rendering the scene capture which is useful for portals.
uint32: 1	bOverride_CustomNearClippingPlane
bool	bUseCustomProjectionMatrix	Whether a custom projection matrix will be used during rendering.
FVector	ClipPlaneBase	Base position for the clip plane, can be any position on the plane.
FVector	ClipPlaneNormal	Normal for the plane.
TEnumAsByte< en...	CompositeMode	When enabled, the scene capture will composite into the render target instead of overwriting its contents.
float	CustomNearClippingPlane	Set bOverride_CustomNearClippingPlane to true if you want to use a custom clipping plane instead of GNearClippingPlane.
FMatrix	CustomProjectionMatrix	The custom projection matrix to use
UDrawFrustumCom...	DrawFrustum	The frustum component used to show visually where the camera field of view is
float	FOVAngle	Camera field of view (in degrees).
float	OrthoWidth	The desired width (in world units) of the orthographic view (ignored in Perspective mode)
float	PostProcessBlendWeight	Range (0.0, 1.0) where 0 indicates no effect, 1 indicates full effect.
FPostProcessSet...	PostProcessSettings
TEnumAsByte< EC...	ProjectionType
TArray< TWeakPt...	SceneViewExtensions	Array of scene view extensions specifically to apply to this scene capture
UTextureRenderT...	TextureTarget	Output render target of the scene capture that can be read in materals.

Constructors

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

Functions

	Name	Description
void	AddOrUpdateBlendable ( TScriptInterface< IBlendableInterfa..., float InWeight )	Adds an Blendable (implements IBlendableInterface) to the array of Blendables (if it doesn't exist) and update the weight
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	CaptureScene()	Render the scene to the texture target immediately.
void	CaptureSceneDeferred()	Render the scene to the texture the next time the main view is rendered.
void	GetCameraView ( float DeltaTime, FMinimalViewInfo& OutDesiredView )
void	SetCameraView ( const FMinimalViewInfo& DesiredVie... )
void	UpdateContent()	For backwards compatibility.
void	UpdateDrawFrustum()

Overridden from USceneCaptureComponent

		Name	Description
	void	UpdateSceneCaptureContents ( FSceneInterface* Scene )

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.
bool	RequiresGameThreadEndOfFrameUpdates()	Return true if this component requires end of frame updates to happen from the game thread.
void	SendRenderTransform_Concurrent()	Called to send a transform update for this component to the rendering thread
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

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