FViewportSurfaceReader | Unreal Engine 4.27 Documentation

References


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

struct FViewportSurfaceReader

A single, managed surface used as a render target resolution destination

Type	Name	Description
FEvent *	AvailableEvent	Optional event that is triggered when the surface is no longer in use
FThreadSafeBool	bEnabled	Whether this surface reader is enabled or not
bool	bIsEnabled	Whether this reader is enabled or not.
bool	bQueuedForCapture
FIntRect	CaptureRect	The rectangle to read from the surface
EPixelFormat	PixelFormat	The desired pixel format of the resolved textures
FTexture2DRHIRef	ReadbackTexture	Texture used to store the resolved render target
FIntPoint	WindowSize	In windows mode, the size of the widget with the border

	Type	Name	Description
		FViewportSurfaceReader ( EPixelFormat InPixelFormat, FIntPoint InBufferSize )	Constructor

	Type	Name	Description
		~FViewportSurfaceReader ()	Destructor

Type	Name	Description
void	BlockUntilAvailable ()	Wait for this reader to become available, if it's currently in use
FIntPoint	GetCurrentSize ()	Get the current size of the texture
void	Initialize ()	Initialize this reader so that it can be waited on.
void	Reset ()	Safely resets the state of the wait event.
void	Resize ( uint32 Width, uint32 Height )	Set up this surface to the specified width/height
void	ResolveRenderTarget ( FViewportSurfaceReader* RenderToReadback, const FTexture2DRHIRef& BackBuffer, TFunction< void(FColor*, int32, int32)> Callback )	Resolve the specified viewport RHI, calling the specified callback with the result.
void	SetCaptureRect ( FIntRect InCaptureRect )	Set the rectangle within which to read pixels
void	SetWindowSize ( FIntPoint InWindowSize )	Set the window size that we expect from the BackBuffer
bool	WasEverQueued ()