1. Epic GamesDeveloper
  3. UUserDefinedCaptureProtocol

UUserDefinedCaptureProtocol

A blueprintable capture protocol that defines how to capture frames from the engine

Unreal Engine C++ API Reference > Runtime > MovieSceneCapture > Protocols

Inheritance Hierarchy

References

   
Module MovieSceneCapture
Header /Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/UserDefinedCaptureProtocol.h
Include #include "Protocols/UserDefinedCaptureProtocol.h"

Syntax

class UUserDefinedCaptureProtocol : public UMovieSceneImageCaptureProtocolBase

Remarks

A blueprintable capture protocol that defines how to capture frames from the engine

Variables

  Type Name Description
Protected variable FFrameMetrics CachedFrameMetrics Frame metrics cached for the current frame
Protected variable const FCapturedPixelsID * CurrentStreamID Transient stream ID used only during filename generation
Protected variable TUniquePtr< FFrameGrabber > FinalPixelsFrameGrabber A frame grabber responsible for capturing LDR final pixels from the viewport when requested
Protected variable FCapturedPixelsID FinalPixelsID The ID of the final pixel stream cached from StartCapturingFinalPixels
Protected variable TAtomic< int32 > NumOutstandingOperations A running count of the number of currently pending async operations
Protected variable TObjectPtr< UWorld > World ~ End UObject implementation World pointer assigned on Setup

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual Const FString

GenerateFilename ( const FFrameMetrics& InFrameMetrics
)

 Generate a filename for the current frame
Public function Const FFrameMetrics Access this protocol's current frame metrics
Protected function void Called when this protocol is going to be shut down - should not capture any more frames
Protected function Const bool Called to check whether this protocol has finished any pending tasks, and can now be shut down
Protected function Virtual Const bool  
Protected function void Called when this protocol should capture the current frame
Protected function void Called to complete finalization of this protocol
Protected function void Called when this protocol should temporarily stop capturing frames
Protected function void

OnPixelsReceived ( const FCapturedPixels& Pixels,
const FCapturedPixelsID& ID,
FFrameMetrics FrameMetrics
)

 Called when pixels have been received for the specified stream name
Public function void

OnPixelsReceivedImpl ( const FCapturedPixels& Pixels,
const FCapturedPixelsID& StreamID,
FFrameMetrics FrameMetrics
)

 Called when image pixel data is ready to be processed
Protected function void Called before the capture process itself is ticked, before each frame is set up for capture Useful for any pre-frame set up or resetting the previous frame's state
Protected function bool

OnSetup ()

 Called once at the start of the capture process, but before any warmup frames
Protected function Virtual bool  
Protected function void Called when this protocol should start capturing frames
Protected function void

OnTick ()

 Called after the capture process itself is ticked, after the frame is set up for capture, but before most actors have ticked
Protected function void Called when the capture process is warming up.
Public function void

ReportOutstandingWork ( int32 NumNewOperations
)

 INTERNAL: Report that the protocol is dispatching the specified number of asynchronous tasks that need to be completed before this protocol can be finalized
Public function void

ResolveBuffer ( UTexture* Buffer,
const FCapturedPixelsID& BufferID
)

 Resolve the specified buffer and pass it directly to the specified handler when done (does not pass to any bound streams)
Public function void Instruct this protocol to start capturing LDR final pixels (including slate widgets and burn-ins)
Public function void Instruct this protocol to stop capturing LDR final pixels

Overridden from UMovieSceneCaptureProtocolBase

  Type Name Description
Protected function Virtual Const void Called when generating formatting filename to add any additional format mappings
Protected function Virtual void Called when we have finished capturing and we should start finalizing the capture
Protected function Virtual void

CaptureFrameImpl ( const FFrameMetrics& FrameMetrics
)

 Instruct this protocol to capture a frame relating to the specified metrics
Protected function Virtual void Called when we have finished capturing
Protected function Virtual Const UWorld * ~ End UMovieSceneCaptureProtocolBase implementation ~ Begin UObject implementation
Protected function Virtual Const bool Check whether this protocol has any processing left to do, or whether it should be finalized.
Protected function Virtual void ~ Begin UMovieSceneCaptureProtocolBase implementation
Protected function Virtual bool Called once at the start of the capture process (before any warmup) to set up anything required for the capture.
Protected function Virtual bool Start capturing
Protected function Virtual void Called on the main thread to do any additional processing
Protected function Virtual void Start warming up this capture protocol

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page