Navigation
Unreal Engine C++ API Reference > Runtime > MovieSceneCapture > Protocols
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMovieSceneCaptureProtocolBase
- UMovieSceneImageCaptureProtocolBase
- UCompositionGraphCaptureProtocol
References
| Module | MovieSceneCapture |
| Header | /Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/CompositionGraphCaptureProtocol.h |
| Include | #include "Protocols/CompositionGraphCaptureProtocol.h" |
Syntax
class UCompositionGraphCaptureProtocol : public UMovieSceneImageCaptureProtocolBase
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bCaptureFramesInHDR | Whether to capture the frames as HDR textures (*.exr format) |
 |
bool | bDisableScreenPercentage | Whether to disable screen percentage |
 |
TEnumAsByte< enum EHDRCaptureGamut > | CaptureGamut | The color gamut to use when storing HDR captured data. |
 |
int32 | HDRCompressionQuality | Compression Quality for HDR Frames (0 for no compression, 1 for default compression which can be slow) |
 |
FCompositionGraphCapturePasses | IncludeRenderPasses | A list of render passes to include in the capture. Leave empty to export all available passes. |
 |
FSoftObjectPath | PostProcessingMaterial | Custom post processing material to use for rendering |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UCompositionGraphCaptureProtocol
(
const FObjectInitializer& Init |
Overridden from UMovieSceneCaptureProtocolBase
| Type | Name | Description | |
|---|---|---|---|
  |
void | CaptureFrameImpl
(
const FFrameMetrics& FrameMetrics |
Instruct this protocol to capture a frame relating to the specified metrics |
  |
void | FinalizeImpl () |
Called when we have finished capturing |
   |
bool | Check whether this protocol has any processing left to do, or whether it should be finalized. | |
  |
void | OnLoadConfigImpl
(
FMovieSceneCaptureSettings& InSettings |
Called when this protocol has been loaded |
  |
void | OnReleaseConfigImpl
(
FMovieSceneCaptureSettings& InSettings |
Called when this protocol has been released |
  |
bool | SetupImpl () |
~ UMovieSceneCaptureProtocolBase implementation |
  |
void | TickImpl () |
Called on the main thread to do any additional processing |