class
render::RenderWindow
Render thread counterpart of RenderWindow.
Public
Constructors
RenderWindow
Methods
~RenderWindow
Initialize
Called on the render thread when the object is first created.
Destroy
Called on the render thread before the object is destroyed.
ReadAsync
Reads the contents of this render target.
Issues a copy command into the command buffer and returns an async operation that triggers when the data has been read.
- commandBuffer
- Command buffer to issue copy commands into.
- colorSurfaceIndex
- Which color surface to read (default 0).
- mipLevel
- Mip level to read (default 0).
- arrayLayer
- Array layer to read (default 0).
Returns: Async operation that triggers when the read operation is complete. May retun null PixelData if reading is not supported.
NotifySwapBuffersRequested
Called by the GPU backend after it requests swap chain back buffer to be presented.
RebuildSwapChain
Rebuilds the swap chain according to the currently set properties.
IsRedrawRequested
Returns true if the operating system has requested the window to be redrawn.
This state is cleared when NotifySwapBuffersRequested() is called.
GetRenderWindowProperties
Returns properties that describe the render window.
GetRenderWindowSurface
Returns the internal render window surface, if any.
DoOnSwapChainPropertiesModified
Triggers whenever the window changes properties that are relevant for the swap chain.
Fields
OnSwapChainDidRebuild
Triggered when the window swap chain has been recreated.
Protected
Methods
SyncFromCoreObject
Update internal data from provided memory buffer that was populated with data from the owning CoreObject.