IRenderTarget

Description

interface Tinman.Engine.Rendering.IRenderTarget

A render target surface.

Public / Methods

Finish


public method Finish → ()

Use of this render target as output (see IGraphicsContext.SetRenderTarget) has finished, it is now going to be used as input for subsequent work, for example rendering or presentation.

This method must be called once after having used the IRenderTarget object as output during one or more render cycles (see IGraphicsContext.SetRenderTarget) and before using it as input for subsequent work, for example rendering or presentation. Reading the current pixel contents via IGraphicsContext.ReadPixels does not count as rendering work.

Public / Attributes

IsSrgb


public attribute IsSrgb → (get)

value : bool

The sRGB behaviour flag.

The sRGB behaviour of this render target.

When true, the GPU is supposed to do on-the-fly sRGB compression for the render target object (e.g. in Direct3D 10+ by using DXGI_FORMAT_B8G8R8X8_UNORM_SRGB), so that the GPU shader may output linear color values.

Size


public attribute Size → (get)

value : Vec2I

The render target size, in pixels.

The size of this render target.

Texture


public attribute Texture → (get)

value : ITexture2D

The texture resource or null if this render target represents the backbuffer of a swap chain.

The texture resource that holds the rendered pixels.