Navigation
Unreal Engine C++ API Reference > Runtime > MovieSceneCapture > Protocols
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMovieSceneCaptureProtocolBase
- UMovieSceneImageCaptureProtocolBase
- UUserDefinedCaptureProtocol
- UUserDefinedImageCaptureProtocol
References
| Module | MovieSceneCapture |
| Header | /Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/UserDefinedCaptureProtocol.h |
| Include | #include "Protocols/UserDefinedCaptureProtocol.h" |
Syntax
class UUserDefinedImageCaptureProtocol : public UUserDefinedCaptureProtocol
Remarks
A blueprintable capture protocol tailored to capturing and exporting frames as images
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bEnableCompression | Whether to save images with compression or not. Not supported for bitmaps. |
 |
int32 | CompressionQuality | The compression quality for the image type. |
 |
EDesiredImageFormat | Format | The image format to save as |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UUserDefinedImageCaptureProtocol
(
const FObjectInitializer& ObjInit |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FString | GenerateFilenameForBuffer
(
UTexture* Buffer, |
Generate a filename for the specified buffer using this protocol's file name formatter |
 |
FString | Generate a filename for the current frame using this protocol's file name formatter | |
 |
void | ~ End UMovieSceneCaptureProtocolBase implementation Called on the main thread when an async operation dispatched from this class has completed (either successfully or otherwise) | |
 |
void | WriteImageToDisk
(
const FCapturedPixels& PixelData, |
Generate a filename for the current frame using this protocol's file name formatter |
Overridden from UMovieSceneCaptureProtocolBase
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnLoadConfigImpl
(
FMovieSceneCaptureSettings& InSettings |
Called when this protocol has been loaded |
  |
void | OnReleaseConfigImpl
(
FMovieSceneCaptureSettings& InSettings |
~ Begin UMovieSceneCaptureProtocolBase implementation |