Navigation
API > API/Runtime > API/Runtime/MovieSceneCapture
| Name | UCompositionGraphCaptureProtocol |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/CompositionGraphCaptureProtocol.h |
| Include Path | #include "Protocols/CompositionGraphCaptureProtocol.h" |
Syntax
UCLASS (Config=EditorPerProjectUserSettings,
Meta=(DisplayName="Custom Render Passes", CommandLineID="CustomRenderPasses"), MinimalAPI)
class UCompositionGraphCaptureProtocol : public UMovieSceneImageCaptureProtocolBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneCaptureProtocolBase → UMovieSceneImageCaptureProtocolBase → UCompositionGraphCaptureProtocol
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCompositionGraphCaptureProtocol
(
const FObjectInitializer& Init |
Protocols/CompositionGraphCaptureProtocol.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCaptureFramesInHDR | bool | Whether to capture the frames as HDR textures (*.exr format) | Protocols/CompositionGraphCaptureProtocol.h |
|
| bDisableScreenPercentage | bool | Whether to disable screen percentage | Protocols/CompositionGraphCaptureProtocol.h |
|
| CaptureGamut | TEnumAsByte< enum EHDRCaptureGamut > | The color gamut to use when storing HDR captured data. | Protocols/CompositionGraphCaptureProtocol.h |
|
| HDRCompressionQuality | int32 | Compression Quality for HDR Frames (0 for no compression, 1 for default compression which can be slow) | Protocols/CompositionGraphCaptureProtocol.h |
|
| IncludeRenderPasses | FCompositionGraphCapturePasses | A list of render passes to include in the capture. Leave empty to export all available passes. | Protocols/CompositionGraphCaptureProtocol.h |
|
| PostProcessingMaterial | FSoftObjectPath | Custom post processing material to use for rendering | Protocols/CompositionGraphCaptureProtocol.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PostProcessingMaterialPtr | TObjectPtr< UMaterialInterface > | ~ End UMovieSceneCaptureProtocolBase implementation | Protocols/CompositionGraphCaptureProtocol.h |
|
| SceneViewport | TWeakPtr< FSceneViewport > | The viewport we are capturing from | Protocols/CompositionGraphCaptureProtocol.h | |
| ViewExtension | TSharedPtr< FFrameCaptureViewExtension, ESPMode::ThreadSafe > | A view extension that we use to ensure we dump out the composition graph frames with the correct settings | Protocols/CompositionGraphCaptureProtocol.h |
Functions
Public
Overridden from UMovieSceneCaptureProtocolBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CaptureFrameImpl
(
const FFrameMetrics& FrameMetrics |
Instruct this protocol to capture a frame relating to the specified metrics | Protocols/CompositionGraphCaptureProtocol.h | |
virtual void FinalizeImpl() |
Called when we have finished capturing | Protocols/CompositionGraphCaptureProtocol.h | |
virtual bool HasFinishedProcessingImpl () |
Check whether this protocol has any processing left to do, or whether it should be finalized. | Protocols/CompositionGraphCaptureProtocol.h | |
virtual void OnLoadConfigImpl
(
FMovieSceneCaptureSettings& InSettings |
Called when this protocol has been loaded | Protocols/CompositionGraphCaptureProtocol.h | |
virtual void OnReleaseConfigImpl
(
FMovieSceneCaptureSettings& InSettings |
Called when this protocol has been released | Protocols/CompositionGraphCaptureProtocol.h | |
virtual bool SetupImpl() |
~ UMovieSceneCaptureProtocolBase implementation | Protocols/CompositionGraphCaptureProtocol.h | |
virtual void TickImpl() |
Called on the main thread to do any additional processing | Protocols/CompositionGraphCaptureProtocol.h |