Navigation
API > API/Plugins > API/Plugins/PixelCapture
A basic capturer that will capture RHI texture frames to I420 buffers utilizing a compute shader. Involves compute shader reading and processing of GPU textures so should be faster than CPU variant. Input: FPixelCaptureInputFrameRHI Output: FPixelCaptureOutputFrameI420
| Name | FPixelCaptureCapturerRHIToI420Compute |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelCapture/Source/PixelCapture/Public/PixelCaptureCapturerRHIToI420Compute.h |
| Include Path | #include "PixelCaptureCapturerRHIToI420Compute.h" |
Syntax
class FPixelCaptureCapturerRHIToI420Compute :
public FPixelCaptureCapturer ,
public TSharedFromThis< FPixelCaptureCapturerRHIToI420Compute >
Inheritance Hierarchy
- FPixelCaptureCapturer → FPixelCaptureCapturerRHIToI420Compute
- FSharedFromThisBase → TSharedFromThis → FPixelCaptureCapturerRHIToI420Compute
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPixelCaptureCapturerRHIToI420Compute
(
FPixelCaptureCapturerConfig& Config |
PixelCaptureCapturerRHIToI420Compute.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FPixelCaptureCapturerRHIToI420Compute() |
PixelCaptureCapturerRHIToI420Compute.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MappedU | void * | PixelCaptureCapturerRHIToI420Compute.h | ||
| MappedV | void * | PixelCaptureCapturerRHIToI420Compute.h | ||
| MappedY | void * | Memory mapped pointers of the staging textures | PixelCaptureCapturerRHIToI420Compute.h | |
| PlaneUVDimensions | FIntPoint | PixelCaptureCapturerRHIToI420Compute.h | ||
| PlaneYDimensions | FIntPoint | Dimensions of the texures | PixelCaptureCapturerRHIToI420Compute.h | |
| StagingTextureU | FTextureRHIRef | PixelCaptureCapturerRHIToI420Compute.h | ||
| StagingTextureV | FTextureRHIRef | PixelCaptureCapturerRHIToI420Compute.h | ||
| StagingTextureY | FTextureRHIRef | Cpu readable copies of the targets above | PixelCaptureCapturerRHIToI420Compute.h | |
| TextureU | FTextureRHIRef | PixelCaptureCapturerRHIToI420Compute.h | ||
| TextureUUAV | FUnorderedAccessViewRHIRef | PixelCaptureCapturerRHIToI420Compute.h | ||
| TextureV | FTextureRHIRef | PixelCaptureCapturerRHIToI420Compute.h | ||
| TextureVUAV | FUnorderedAccessViewRHIRef | PixelCaptureCapturerRHIToI420Compute.h | ||
| TextureY | FTextureRHIRef | Used as targets for the compute shader | PixelCaptureCapturerRHIToI420Compute.h | |
| TextureYUAV | FUnorderedAccessViewRHIRef | The UAVs of the targets | PixelCaptureCapturerRHIToI420Compute.h | |
| UStride | int32 | PixelCaptureCapturerRHIToI420Compute.h | ||
| VStride | int32 | PixelCaptureCapturerRHIToI420Compute.h | ||
| YStride | int32 | PixelCaptureCapturerRHIToI420Compute.h |
Functions
Public
Protected
Overridden from FPixelCaptureCapturer
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginProcess
(
const IPixelCaptureInputFrame& InputFrame, |
PixelCaptureCapturerRHIToI420Compute.h | ||
virtual IPixelCaptureOutputFrame * CreateOutputBuffer
(
int32 InputWidth, |
Implement this to create a buffer for the output. | PixelCaptureCapturerRHIToI420Compute.h | |
virtual FString GetCapturerName () |
Gets the human readable name for this capture process. | PixelCaptureCapturerRHIToI420Compute.h | |
virtual void Initialize
(
int32 InputWidth, |
Initializes the process to be ready for work. Called once at startup. | PixelCaptureCapturerRHIToI420Compute.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedPtr< FPixelCaptureCapturerRHIToI420Compute > Create
(
FPixelCaptureCapturerConfig Config |
PixelCaptureCapturerRHIToI420Compute.h | ||
static TSharedPtr< FPixelCaptureCapturerRHIToI420Compute > Create
(
float InScale |
PixelCaptureCapturerRHIToI420Compute.h |