UPCGSceneCaptureSettings

API > API/Plugins > API/Plugins/PCG

Perform a 2D orthographic scene capture and write the result to a render target data. Can be costly, use with caution with runtime generation.


Name	UPCGSceneCaptureSettings
Type	class
Header File	/Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGSceneCapture.h
Include Path	#include "Elements/PCGSceneCapture.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))  
class UPCGSceneCaptureSettings : public UPCGSettings

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGSceneCaptureSettings

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bCaptureFromTopOfExtents	bool	Scene capture position will be translated such that the capture is taken from the top of the capture extents rather than from the center.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
bExcludePCGContent	bool	Exclude content created from PCG.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category="Settings\|Capture Filtering" DisplayName="Exclude PCG Content" Meta=(PCG_Overridable)
bOnlyCaptureContentMatchingIncludedTags	bool	Only capture actors and primitive components that have tags listed in Included Tags.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category="Settings\|Capture Filtering" Meta=(PCG_Overridable)
bSkipReadbackToCPU	bool	Deprecated section	Elements/PCGSceneCapture.h	Meta=(DeprecatedProperty, DeprecatedMessage="bSkipReadbackToCPU has been removed. CPU readback is now always deferred.")
CaptureHalfExtents	FVector	Used to determine the orthographic width of the scene capture.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="OrientationMode==EPCGSceneCaptureOrientationMode::Explicit", EditConditionHides, PCG_Overridable)
CaptureLocation	FVector	Positions the scene capture.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="OrientationMode==EPCGSceneCaptureOrientationMode::Explicit", EditConditionHides, PCG_Overridable)
CaptureRotation	FQuat	Rotates the scene capture.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="OrientationMode==EPCGSceneCaptureOrientationMode::Explicit", EditConditionHides, PCG_Overridable)
CaptureSource	TEnumAsByte< enum ESceneCaptureSource >	Specifies which component of the scene rendering should be output to the render target.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
ExcludedTags	TArray< FName >	Tags to match against actors/components when selecting for exclusion from the scene capture.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category="Settings\|Capture Filtering" Meta=(PCG_Overridable)
Filter	EPCGTextureFilter	Method used to determine the value for a sample based on the value of nearby texels.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
IncludedTags	TArray< FName >	Tags to match against actors/components when selecting for inclusion in the scene capture.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category="Settings\|Capture Filtering" Meta=(EditCondition="bOnlyCaptureContentMatchingIncludedTags", EditConditionHides, PCG_Overridable)
OrientationMode	EPCGSceneCaptureOrientationMode	Defines how the scene capture bounds and transform are computed.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
PixelFormat	TEnumAsByte< enum ETextureRenderTargetFormat >	Subset of EPixelFormat exposed to UTextureRenderTarget2D.	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
TexelSize	float	Size of a texel in the render target in world units (cm).	Elements/PCGSceneCapture.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(UIMin="1.0", ClampMin="1.0", PCG_Overridable)

Navigation

Syntax

Inheritance Hierarchy

Variables

Public

Functions