1. Epic GamesDeveloper
  3. FPixelCaptureCapturer

FPixelCaptureCapturer

The base class for all Capturers in the system.

API > API/Plugins > API/Plugins/PixelCapture

Inheritance Hierarchy

References

   
Module PixelCapture
Header /Engine/Plugins/Media/PixelCapture/Source/PixelCapture/Public/PixelCaptureCapturer.h
Include #include "PixelCaptureCapturer.h"

Syntax

class FPixelCaptureCapturer

Remarks

The base class for all Capturers in the system. Incoming frames will be user types implementing IPixelCaptureInputFrame. Outgoing frames should be user types implementing IPixelCaptureOutputFrame. Each capturer system should expect one known input user type. Implement CreateOutputBuffer to create your custom IPixelCaptureOutputFrame implementation to hold the result of the capture process. Implement BeginProcess to start the capture work which ideally should be an async task of some sort. The capture work should fill the given IPixelCaptureOutputFrame and then call EndProcess to indicate the work is done. While the capture should be async it should only expect to work on one frame at a time.

Variables

  Type Name Description
Public variable FOnComplete OnComplete  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function void

BeginProcess ( const IPixelCaptureInputFrame& InputFrame,
IPixelCaptureOutputFrame* OutputBuffer
)

 Implement this with your specific process to capture the incoming frame.
Public function void

Capture ( const IPixelCaptureInputFrame& InputFrame
)

 Called when an input frame needs capturing.
Protected function IPixelCaptureOutputFrame *

CreateOutputBuffer ( int32 InputWidth,
int32 InputHeight
)

 Implement this to create a buffer for the output.
Protected function void Call this to mark the end of processing. Will commit the current write buffer into the read buffer.
Protected function Const FString Gets the human readable name for this capture process.
Public function Const bool Returns true if this process has a frame in the output buffer ready to be read.
Protected function Virtual void

Initialize ( int32 InputWidth,
int32 InputHeight
)

 Initializes the process to be ready for work. Called once at startup.
Public function Const bool

IsBusy ()

 Returns true when this process is actively working on capturing frame data.
Public function Const bool Returns true if Initialize() has been called.
Protected function void Metadata info (optional). Marks the end of some CPU work.
Protected function void Metadata info (optional). Marks the start of some CPU work. Multiple work sections are valid.
Protected function void Metadata info (optional). Marks the end of some GPU work.
Protected function void Metadata info (optional). Marks the start of some GPU work. Multiple work sections are valid.
Public function TSharedPtr< IPixelCaptureOutputFrame > Gets the output frame from the output buffer.

Typedefs

Name Description
FOnComplete Listen on this to be notified when the capture process completes for each input.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page