1. Epic GamesDeveloper
  3. FPixelCaptureCapturerMultiFormat

FPixelCaptureCapturerMultiFormat

A capturer that contains multiple formats of multi layer capture processes.

API > API/Plugins > API/Plugins/PixelCapture

Inheritance Hierarchy

References

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

Syntax

class FPixelCaptureCapturerMultiFormat : public TSharedFromThis< FPixelCaptureCapturerMultiFormat >

Remarks

A capturer that contains multiple formats of multi layer capture processes. Feed it a IPixelCaptureCapturerSource that will create the appropriate base capturers. Input: User defined Output: Capturer defined

Variables

  Type Name Description
Protected variable bool bDisconnected  
Protected variable IPixelCaptureCapturerSource * CapturerSource  
Protected variable FCriticalSection EventMutex  
Protected variable TMap< int32, TSharedPtr< FPixelCaptureCapturerLayered > > FormatCapturers  
Protected variable TMap< int32, FEvent * > FormatEvents  
Protected variable FCriticalSection FormatGuard  
Protected variable TArray< float > LayerScales  
Protected variable TArray< FIntPoint > LayerSizes  
Public variable FOnComplete OnComplete  
Protected variable TAtomic< int > PendingFormats  

Constructors

  Type Name Description
Protected function  

FPixelCaptureCapturerMultiFormat ( IPixelCaptureCapturerSource* InCapturerSource,
TArray< float > InLayerScales
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddOutputFormat ( int32 Format
)

 Sets up a capture pipeline for the given destination format.
Public function void

Capture ( const IPixelCaptureInputFrame& SourceFrame
)

 Begins the capture process of a given frame.
Protected function void

CheckFormatEvent ( int32 Format
)

  
Public function Static TSharedPtr< FPixelCaptureCapturerMultiFormat >

Create ( IPixelCaptureCapturerSource* InCapturerSource,
TArray< float > LayerScales
)

 Create a new multi-format multi-Layered Capturer.
Protected function void  
Protected function void

FreeEvent ( int32 Format,
FEvent* Event
)

  
Protected function FEvent *

GetEventForFormat ( int32 Format
)

  
Public function Const int32

GetHeight ( int LayerIndex
)

 Gets the frame height of a given output layer.
Public function Const int32 Gets the number of layers in the multi-layered capturers.
Public function Const int32

GetWidth ( int LayerIndex
)

 Gets the frame width of a given output layer.
Protected function void

OnCaptureFormatComplete ( int32 Format
)

  
Public function void Call to notify this capturer that it has been disconnected and no more frames will be captured and any waiting for format calls should stop waiting.
Public function TSharedPtr< IPixelCaptureOutputFrame >

RequestFormat ( int32 Format,
int32 LayerIndex
)

 Requests the output in a specific format.
Public function TSharedPtr< IPixelCaptureOutputFrame >

WaitForFormat ( int32 Format,
int32 LayerIndex,
uint32 MaxWaitTime
)

 Like RequestFormat except if the format does not exist it will add it and then wait for the format to have output.

Typedefs

Name Description
FOnComplete Listen on this to be notified when a frame completes all capture formats/layers.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page