OffscreenView

Description

sealed class Tinman.Engine.Scenes.Entities.OffscreenView

Performs offscreen rendering.

To perform offscreen rendering, the following steps are necessary:

Create a component that performs rendering, for example a ISceneView.
Create a render target handle, which defines the properties of the render target that will be used for offscreen rendering. If offscreen rendering is supposed to produce transparent pixels, a render target format with an alpha channel is required (for example RenderTargetFormat.RGBA_8) and the default clear color should be transparent (see RenderTargetHandle.Color).
Create an OffscreenView, passing the render component and render target handle, and add it to a scene view.
Use OffscreenBitmap and OffscreenTexture to use the offscreen render results as the source for other rendering work.

public constructor OffscreenView → (4)

component ⁱⁿ : object: [not-null]
The component to wrap.
renderTargetHandle ⁱⁿ : RenderTargetHandle: [not-null]
The offscreen render target to use.
update ^opt : bool = true: Enable the IUpdateableFrameTime.UpdateFrameTime callback?
order ^opt : int32 = 0: See ISceneObject.Order.

Creates a new instance of OffscreenView.

The following callbacks will be performed on component ⁱⁿ, if it implements the respective interface:

public attribute OffscreenBitmap → (get)

The IResourceHandle that returns a Bitmap that represents the rendered offscreen content.

The same IResourceHandle object will be returned for the lifetime of this OffscreenView object.

public attribute OffscreenTexture → (get)

The IModelTexture that represents the rendered offscreen content.

The same IModelTexture object will be returned for the lifetime of this OffscreenView object.