1. Epic GamesDeveloper
  3. USceneCaptureComponent

USceneCaptureComponent

-> will be exported to EngineDecalClasses.h

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, HideCategories=(Collision, Object, Physics, SceneComponent, Mobility),  
       MinimalAPI)  
class USceneCaptureComponent : public USceneComponent

Remarks

-> will be exported to EngineDecalClasses.h

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bAlwaysPersistRenderingState Whether to persist the rendering state even if bCaptureEveryFrame==false.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bCaptureEveryFrame Whether to update the capture's contents every frame.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite Transient duplicatetransient, nontransactional, skipserialization uint8: 1 bCaptureGpuNextRender Capture a GPU frame for this scene capture, next time it renders (capture program must be connected).
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bCaptureOnMovement Whether to update the capture's contents on movement.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite Transient duplicatetransient, nontransactional, skipserialization uint8: 1 bDumpGpuNextRender Run DumpGPU for this scene capture, next time it renders.
Public variable uint8: 1 bSuppressGpuCaptureOrDump Flag used to suppress bCaptureGpuNextRender or bDumpGpuNextRender on reregistration of the component.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUseRayTracingIfEnabled Whether to use ray tracing for this capture. Ray Tracing must be enabled in the project.
Public variable TRefCountPtr< FSceneCaptureMemorySize > CaptureMemorySize Thread safe storage for memory statistics for a scene capture
Protected variable UProperty Transient TObjectPtr< class UStaticMesh > CaptureMesh The mesh used by ProxyMeshComponent
Public variable UProperty Category, EditAnywhere BlueprintReadOnly int32 CaptureSortPriority Capture priority within the frame to sort scene capture on GPU to resolve interdependencies between multiple capture components.
Public variable UProperty Category, Interp, Meta TEnumAsByte< enum ESceneCaptureSource > CaptureSource  
Protected variable uint64 FrameUpdated Frame this scene capture was last updated
Public variable UProperty Category BlueprintReadWrite editinstanceonly TArray< TObjectPtr< AActor > > HiddenActors The actors to hide in the scene capture.
Public variable UProperty TArray< TWeakObjectPtr< UPrimitiveComponent > > HiddenComponents The components won't rendered by current component.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta float LODDistanceFactor Scales the distance used by LOD.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float MaxViewDistanceOverride If > 0, sets a maximum render distance override.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ESceneCapturePrimitiveRenderMode PrimitiveRenderMode Controls what primitives get rendered into the scene capture.
Public variable UProperty Category, EditAnywhere, Interp FString ProfilingEventName Name of the profiling event.
Protected variable TObjectPtr< class UStaticMeshComponent > ProxyMeshComponent The mesh to show visually where the camera is placed
Public variable FEngineShowFlags ShowFlags TODO: Make this a UStruct to set directly?
Public variable UProperty Category BlueprintReadWrite editinstanceonly TArray< TObjectPtr< AActor > > ShowOnlyActors The only actors to be rendered by this scene capture, if PrimitiveRenderMode is set to UseShowOnlyList.
Public variable UProperty TArray< TWeakObjectPtr< UPrimitiveComponent > > ShowOnlyComponents The only components to be rendered by this scene capture, if PrimitiveRenderMode is set to UseShowOnlyList.
Protected variable TIndirectArray< FSceneViewStateReference > ViewStates The view state holds persistent scene rendering state and enables occlusion culling in scene captures.

Constructors

  Type Name Description
Public function  

USceneCaptureComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void  
Public function UFunction BlueprintCallable, Category void Clears the hidden list.
Public function UFunction BlueprintCallable, Category void Clears the Show Only list.
Public function Const UFunction blueprintgetter const TArray< FEngineShowFlagsSetting > & Get the show flag settings.
Public function Virtual Const const AActor * To leverage a component's bOwnerNoSee/bOnlyOwnerSee properties, the capture view requires an "owner".
Public function FSceneViewStateInterface *

GetViewState ( int32 ViewIndex
)

 Returns the view state, if any, and allocates one if needed.
Public function UFunction BlueprintCallable, Category void

HideActorComponents ( AActor* InActor,
const bool bIncludeFromChildActors
)

 Adds all primitive components in the actor to our list of hidden components.
Public function UFunction BlueprintCallable, Category void Adds the component to our list of hidden components.
Public function Virtual Const bool

Is2D ()

 Whether this component is a USceneCaptureComponent2D
Public function Virtual Const bool

IsCube ()

 Whether this component is a USceneCaptureComponentCube
Protected function Const bool  
Protected function void  
Protected function void  
Public function UFunction BlueprintCallable, Category void

RemoveShowOnlyActorComponents ( AActor* InActor,
const bool bIncludeFromChildActors
)

 Removes an actor's components from the Show Only list.
Public function UFunction BlueprintCallable, Category void Removes a component from the Show Only list.
Public function UFunction BlueprintCallable, Category void

SetCaptureSortPriority ( int32 NewCaptureSortPriority
)

 Changes the value of TranslucentSortPriority.
Public function bool Updates "FrameUpdated" field, returns "true" if this is one of multiple scene captures this frame.
Public function UFunction blueprintsetter void

SetShowFlagSettings ( const TArray< FEngineShowFlagsSetting >& InShowFlagSettings
)

 Set the show flag settings.
Public function UFunction BlueprintCallable, Category void

ShowOnlyActorComponents ( AActor* InActor,
const bool bIncludeFromChildActors
)

 Adds all primitive components in the actor to our list of show-only components.
Public function UFunction BlueprintCallable, Category void Adds the component to our list of show-only components.
Public function  

UE_DEPRECATED_FORGAME (

  1. 5,
    "Public access to this property is deprecated,
    and it will become private in a future release. Please use SetShowFlagSettings and GetShowFlagSettin...
    )
 ShowFlags for the SceneCapture's ViewFamily, to control rendering settings for this view.
Protected function void  
Public function Static void  
Public function Virtual void  
Protected function void 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

  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 void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
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 Do any object-specific cleanup required immediately after loading an object.
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