Navigation
API > API/Runtime > API/Runtime/MovieSceneCapture > API/Runtime/MovieSceneCapture/Protocols
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMovieSceneCaptureProtocolBase
- UMovieSceneImageCaptureProtocolBase
- UFrameGrabberProtocol
- UImageSequenceProtocol
- UCompressedImageSequenceProtocol
- UImageSequenceProtocol_JPG
- UImageSequenceProtocol_PNG
- UImageSequenceProtocol_BMP
- UImageSequenceProtocol_EXR
- UVideoCaptureProtocol
References
| Module | MovieSceneCapture |
| Header | /Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/FrameGrabberProtocol.h |
| Include | #include "Protocols/FrameGrabberProtocol.h" |
Syntax
class UFrameGrabberProtocol : public UMovieSceneImageCaptureProtocolBase
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
EPixelFormat | DesiredPixelFormat | The pixel format we want to capture in |
 |
uint32 | RingBufferSize | The size of the render-target resolution surface ring-buffer |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UFrameGrabberProtocol
(
const FObjectInitializer& ObjectInit |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FFramePayloadPtr | GetFramePayload
(
const FFrameMetrics& FrameMetrics |
~ End UMovieSceneCaptureProtocolBase Implementation Retrieve an arbitrary set of data that relates to the specified frame metrics. |
  |
void | ProcessFrame
(
FCapturedFrameData Frame |
Process a captured frame. This may be called on any thread. |
Overridden from UMovieSceneCaptureProtocolBase
| Type | Name | Description | |
|---|---|---|---|
  |
void | Called when we have finished capturing and we should start finalizing the capture | |
  |
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 | ~ UMovieSceneCaptureProtocolBase Implementation | |
  |
bool | SetupImpl () |
Called once at the start of the capture process (before any warmup) to set up anything required for the capture. |
  |
void | TickImpl () |
Called on the main thread to do any additional processing |