Navigation
API > API/Runtime > API/Runtime/MovieSceneCapture
References
| Module | MovieSceneCapture |
| Header | /Engine/Source/Runtime/MovieSceneCapture/Public/FrameGrabber.h |
| Include | #include "FrameGrabber.h" |
Syntax
struct FViewportSurfaceReader
Remarks
A single, managed surface used as a render target resolution destination
Variables
| 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 |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FViewportSurfaceReader
(
EPixelFormat InPixelFormat, |
Constructor |
Destructors
| Type | Name | Description | |
|---|---|---|---|
| Destructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Wait for this reader to become available, if it's currently in use | ||
| FIntPoint | 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, |
Set up this surface to the specified width/height | |
| void | ResolveRenderTarget
(
FViewportSurfaceReader* RenderToReadback, |
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 |