Navigation
API > API/Plugins > API/Plugins/PixelCapture
A basic output frame from the Capture system that wraps a RHI texture buffer.
| Name | FPixelCaptureOutputFrameRHI |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelCapture/Source/PixelCapture/Public/PixelCaptureOutputFrameRHI.h |
| Include Path | #include "PixelCaptureOutputFrameRHI.h" |
Syntax
class FPixelCaptureOutputFrameRHI : public IPixelCaptureOutputFrame
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPixelCaptureOutputFrameRHI
(
FTextureRHIRef InFrameTexture |
PixelCaptureOutputFrameRHI.h | ||
FPixelCaptureOutputFrameRHI
(
FTextureRHIRef InFrameTexture, |
PixelCaptureOutputFrameRHI.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FPixelCaptureOutputFrameRHI() |
PixelCaptureOutputFrameRHI.h |
Structs
| Name | Remarks |
|---|---|
| WrapperFormatData | Sometimes we need to pack data in a pixel format not fully supported by the RHI, so we may instead store it as a different format for transport and read it as the original format sometime later, this struct is meant to hold information about the wrapper format if it exists |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasWrapperFormatData | bool | PixelCaptureOutputFrameRHI.h | ||
| FrameTexture | FTextureRHIRef | PixelCaptureOutputFrameRHI.h | ||
| WrapperData | WrapperFormatData | PixelCaptureOutputFrameRHI.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTextureRHIRef GetFrameTexture() |
PixelCaptureOutputFrameRHI.h | ||
virtual bool GetWrapperFormatData
(
WrapperFormatData& OutData |
PixelCaptureOutputFrameRHI.h | ||
void SetFrameTexture
(
FTextureRHIRef InFrameTexture |
PixelCaptureOutputFrameRHI.h |
Overridden from IPixelCaptureOutputFrame
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 GetHeight() |
PixelCaptureOutputFrameRHI.h | ||
virtual int32 GetWidth() |
PixelCaptureOutputFrameRHI.h |