1. Epic GamesDeveloper
  3. USceneCaptureComponent2D

USceneCaptureComponent2D

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

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

References

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

Syntax

UCLASS (HideCategories=(Collision, Object, Physics, SceneComponent), ClassGroup=Rendering,  
       EditInlineNew, Meta=(BlueprintSpawnableComponent), MinimalAPI)  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float AutoPlaneShift Manually adjusts the planes of this camera, maintaining the distance between them.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bAutoCalculateOrthoPlanes Automatically determine a min/max Near/Far clip plane position depending on OrthoWidth value
Public variable UProperty Category BlueprintReadWrite Transient uint32: 1 bCameraCutThisFrame True if we did a camera cut this frame.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint32: 1 bConsiderUnrenderedOpaquePixelAsFullyTranslucent Whether to only render exponential height fog on opaque pixels which were rendered by the scene capture.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite bool bEnableClipPlane Enables a clip plane while rendering the scene capture which is useful for portals.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite bool bEnableOrthographicTiling Render the scene in n frames (i.e TileCount) - Ignored in Perspective mode, works only in Orthographic mode when CaptureSource uses SceneColor (not FinalColor) If CaptureSource uses FinalColor, tiling will be ignored and a Warning message will be logged
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bIgnoreScreenPercentage When rendering with main view resolution, ignore screen percentage scale and render at full resolution.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bMainViewCamera Render with main view camera.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bMainViewFamily Render with main view family (where bIsMainViewFamily == true)
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bMainViewResolution Render with main view resolution, ignoring the dimensions in the resource.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint32: 1 bOverride_CustomNearClippingPlane  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bRenderInMainRenderer Render scene capture as additional render passes of the main renderer rather than as an independent renderer.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bUpdateOrthoPlanes Adjusts the near/far planes and the view origin of the current camera automatically to avoid clipping and light artefacting
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bUseCameraHeightAsViewTarget If UpdateOrthoPlanes is enabled, this setting will use the cameras current height to compensate the distance to the general view (as a pseudo distance to view target when one isn't present)
Public variable UProperty Category, AdvancedDisplay BlueprintReadWrite bool bUseCustomProjectionMatrix Whether a custom projection matrix will be used during rendering.
Public variable UProperty Meta bool bUseFauxOrthoViewPos  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite FVector ClipPlaneBase Base position for the clip plane, can be any position on the plane.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite FVector ClipPlaneNormal Normal for the plane.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TEnumAsByte< enum ESceneCaptureCompositeMode > CompositeMode When enabled, the scene capture will composite into the render target instead of overwriting its contents.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float CustomNearClippingPlane Set bOverride_CustomNearClippingPlane to true if you want to use a custom clipping plane instead of GNearClippingPlane.
Public variable UProperty Category, AdvancedDisplay BlueprintReadWrite FMatrix CustomProjectionMatrix The custom projection matrix to use
Public variable TObjectPtr< class UDrawFrustumComponent > DrawFrustum The frustum component used to show visually where the camera field of view is
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float FOVAngle Camera field of view (in degrees).
Public variable const FSceneViewFamily * MainViewFamily Transient pointer set during calls to UpdateSceneCaptureContents from UpdateDeferredCaptures
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FIntPoint MainViewResolutionDivisor Divisor when rendering at Main View Resolution.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite int32 NumXTiles Number of X tiles to render. Ignored in Perspective mode, works only in Orthographic mode
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite int32 NumYTiles Number of Y tiles to render. Ignored in Perspective mode, works only in Orthographic mode
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float OrthoWidth The desired width (in world units) of the orthographic view (ignored in Perspective mode)
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float Overscan Amount to increase the view frustum by, from 0.0 for no increase to 1.0 for 100% increase
Public variable UProperty Category, Interp, Meta BlueprintReadWrite float PostProcessBlendWeight Range (0.0, 1.0) where 0 indicates no effect, 1 indicates full effect.
Public variable UProperty Category, Interp, Meta FPostProcessSettings PostProcessSettings  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TEnumAsByte< ECameraProjectionMode::Type > ProjectionType  
Public variable TArray< TWeakPtr< ISceneViewExtension, ESPMode::ThreadSafe > > SceneViewExtensions Array of scene view extensions specifically to apply to this scene capture
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< class UTextureRenderTarget2D > TextureTarget Output render target of the scene capture that can be read in materials.
Public variable int32 TileID Which tile to render of the orthographic view (ignored in Perspective mode)
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FName UserSceneTextureBaseColor Expose BaseColor as a UserSceneTexture.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FName UserSceneTextureNormal Expose Normal as a UserSceneTexture.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FName UserSceneTextureSceneColor Expose SceneColor (emissive/unlit) as a UserSceneTexture.

Constructors

  Type Name Description
Public function  

USceneCaptureComponent2D ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AddOrUpdateBlendable ( TScriptInterface< IBlendableInterface > InBlendableObject,
float InWeight
)

 Adds an Blendable (implements IBlendableInterface) to the array of Blendables (if it doesn't exist) and update the weight
Public function Static void  
Public function UFunction BlueprintCallable, Category void Render the scene to the texture target immediately.
Public function void Render the scene to the texture the next time the main view is rendered.
Public function Virtual void

GetCameraView ( float DeltaTime,
FMinimalViewInfo& OutDesiredView
)

  
Public function Const bool Return if orthographic tiling rendering is enabled or not
Public function Const int32 Return number of X tiles to render (to be used when orthographic tiling rendering is enabled)
Public function Const int32 Return number of Y tiles to render (to be used when orthographic tiling rendering is enabled)
Public function UFunction BlueprintCallable, Category void Removes a blendable.
Public function void Reset Orthographic tiling counter
Public function void

SetCameraView ( const FMinimalViewInfo& DesiredView
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void For backwards compatibility.
Public function void  

Overridden from USceneCaptureComponent

  Type Name Description
Public function Virtual Const bool

Is2D ()

 Whether this component is a USceneCaptureComponent2D
Public function Virtual void  

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

 Called when a component is destroyed
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual Const bool Return true if this component requires end of frame updates to happen from the game thread.
Public function Virtual void Called to send a transform update for this component to the rendering thread
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page