Navigation
API > API/Runtime > API/Runtime/MovieSceneCapture
| Name | UFrameGrabberProtocol |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/FrameGrabberProtocol.h |
| Include Path | #include "Protocols/FrameGrabberProtocol.h" |
Syntax
UCLASS (Abstract, Config=EditorPerProjectUserSettings, MinimalAPI)
class UFrameGrabberProtocol : public UMovieSceneImageCaptureProtocolBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneCaptureProtocolBase → UMovieSceneImageCaptureProtocolBase → UFrameGrabberProtocol
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UFrameGrabberProtocol
(
const FObjectInitializer& ObjectInit |
Protocols/FrameGrabberProtocol.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DesiredPixelFormat | EPixelFormat | The pixel format we want to capture in | Protocols/FrameGrabberProtocol.h | |
| RingBufferSize | uint32 | The size of the render-target resolution surface ring-buffer | Protocols/FrameGrabberProtocol.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FrameGrabber | TUniquePtr< FFrameGrabber > | The frame grabber, responsible for actually capturing frames | Protocols/FrameGrabberProtocol.h |
Functions
Public
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FFramePayloadPtr GetFramePayload
(
const FFrameMetrics& FrameMetrics |
~ End UMovieSceneCaptureProtocolBase Implementation Retrieve an arbitrary set of data that relates to the specified frame metrics. | Protocols/FrameGrabberProtocol.h | |
virtual void ProcessFrame
(
FCapturedFrameData Frame |
Process a captured frame. This may be called on any thread. | Protocols/FrameGrabberProtocol.h |
Overridden from UMovieSceneCaptureProtocolBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginFinalizeImpl() |
Called when we have finished capturing and we should start finalizing the capture | Protocols/FrameGrabberProtocol.h | |
virtual void CaptureFrameImpl
(
const FFrameMetrics& FrameMetrics |
Instruct this protocol to capture a frame relating to the specified metrics | Protocols/FrameGrabberProtocol.h | |
virtual void FinalizeImpl() |
Called when we have finished capturing | Protocols/FrameGrabberProtocol.h | |
virtual bool HasFinishedProcessingImpl() |
~ UMovieSceneCaptureProtocolBase Implementation | Protocols/FrameGrabberProtocol.h | |
virtual bool SetupImpl() |
Called once at the start of the capture process (before any warmup) to set up anything required for the capture. | Protocols/FrameGrabberProtocol.h | |
virtual void TickImpl() |
Called on the main thread to do any additional processing | Protocols/FrameGrabberProtocol.h |