RenderTargetHandle

Description

sealed class Tinman.Engine.Rendering.RenderTargetHandle

Derived from

IResourceHandle

Resource handle for render target objects.

See also

IRenderTarget

Public / Constructors

Render​Target​Handle


public constructor RenderTargetHandle → (7)

name in : string

[not-empty]
The render target identifier.

width in : int32

[>0]
The render target width, in pixels.

height in : int32

[>0]
The render target height, in pixels.

format in : RenderTargetFormat

The render target format.

color opt : int64 = 0

The default render target clear color value.

depth opt : float32 = 1

[0..1]
The default render target clear depth value.

stencil opt : int32 = 0

[0..255]
The default render target clear stencil value.

Creates a new instance of RenderTargetHandle.

Public / Attributes

Color


public readonly attribute Color → (int64)

The clear color.

Depth


public readonly attribute Depth → (float32)

The clear depth in the range [0..1].

Format


public readonly attribute Format → (RenderTargetFormat)

The render target format.

Height


public readonly attribute Height → (int32)

The render target height, in pixels.

Name


public readonly attribute Name → (string)

User-defined name of the render target.

Stencil


public readonly attribute Stencil → (int32)

The clear stencil value, in the range [0..255].

Width


public readonly attribute Width → (int32)

The render target width, in pixels.