VertexWriter

Description

sealed class Tinman.Engine.Rendering.Util.VertexWriter

Helper class for writing vertex data to a buffer in a specific format.

The following methods may be used to specify per-vertex data:

Vertex colors:
Use C(…) methods to write.
Maps to VertexElementUsage.Color for ordinals [0..15]
Maps to Semantic.Texture for ordinal 0.
Vertex normal vectors:
Use N(…) methods to write.
Maps to VertexElementUsage.Normal for ordinals [0..15]
Maps to Semantic.Normal for ordinal 0.
Vertex positions:
Use P(…) methods to write.
Maps to VertexElementUsage.Position for ordinals [0..15]
Maps to Semantic.Position for ordinal 0.
Vertex tangent vectors:
Use P(…) methods to write.
Maps to VertexElementUsage.Tangent for ordinals [0..15]
Maps to Semantic.TangentX for ordinal 0.
Maps to Semantic.TangentY for ordinal 1.
Vertex texture coordinates:
Maps to VertexElementUsage.TextureCoords for ordinals [0..15]
Maps to Semantic.TextureCoords for ordinal 0.
Maps to Semantic.TextureCoordsExtra for ordinal 1.

The Out method creates a new vertex, using the data that has been specified with the above methods. Use the ToArrays, ToBuffer and ToBytes methods in order to output the created vertices to the respective format.

Public / Constructors

VertexWriter

public constructor VertexWriter → ()

Creates a new instance of VertexWriter.

Public / Methods

C

_4 overloads

public method C¹ → (1)

argb32 ⁱⁿ : int32: The vertex color, as a 32-bit A8R8G8B compressed sRGB color value.
returns → VertexWriter: this

Specifies a vertex color.

See also: Colors.Decode_A8R8G8B8

public method C² → (1)

argb64 ⁱⁿ : int64: The vertex color, as a 64-bit A16R16G16B16 linear sRGB color value.
returns → VertexWriter: this

Specifies a vertex color.

See also: Colors

public method C³ → (1)

color ⁱⁿ : ColorF: The color value.
returns → VertexWriter: this

Specifies a vertex color.

public method C⁴ → (4)

r ⁱⁿ : float32: Red channel value (linear sRGB).
g ⁱⁿ : float32: Green channel value (linear sRGB).
b ⁱⁿ : float32: Blue channel value (linear sRGB).
a ^opt : float32 = 1: Alpha channel value.
returns → VertexWriter: this

Specifies a vertex color.

Clear

public method Clear → ()

Clears all vertex data from this writer and re-starts at vertex index zero.

G

_3 overloads

public method G¹ → (1)

v ⁱⁿ : Vec3F: The vertex tangent vector.
returns → VertexWriter: this

Specifies a vertex tangent vector.

The given vector will be normalized if necessary.

public method G² → (1)

v ⁱⁿ : Vec3D: The vertex tangent vector.
returns → VertexWriter: this

Specifies a vertex tangent vector.

The given vector will be normalized if necessary.

public method G³ → (3)

x ⁱⁿ : float64: X-component of vertex tangent vector.
y ⁱⁿ : float64: Y-component of vertex tangent vector.
z ⁱⁿ : float64: Z-component of vertex tangent vector.
returns → VertexWriter: this

Specifies a vertex tangent vector.

The given vector will be normalized if necessary.

N

_3 overloads

public method N¹ → (1)

v ⁱⁿ : Vec3F: The vertex normal vector.
returns → VertexWriter: this

Specifies a vertex normal vector.

The given vector will be normalized if necessary.

public method N² → (1)

v ⁱⁿ : Vec3D: The vertex normal vector.
returns → VertexWriter: this

Specifies a vertex normal vector.

The given vector will be normalized if necessary.

public method N³ → (3)

x ⁱⁿ : float64: X-component of vertex normal vector.
y ⁱⁿ : float64: Y-component of vertex normal vector.
z ⁱⁿ : float64: Z-component of vertex normal vector.
returns → VertexWriter: this

Specifies a vertex normal vector.

The given vector will be normalized if necessary.

Ordinal

public method Ordinal → (1)

usage ⁱⁿ : VertexElementUsage: The vertex element usage.
returns → int32: The usage ordinal in the current vertex.

Returns the ordinal of the given vertex element usage (see VertexElementUsage) that will be specified next for the current vertex.

Out

public method Out → ()

Finishes the current vertex and begins to write the next one.

P

_3 overloads

public method P¹ → (1)

v ⁱⁿ : Vec3F: The vertex position.
returns → VertexWriter: this

Specifies a vertex position.

public method P² → (1)

v ⁱⁿ : Vec3D: The vertex position.
returns → VertexWriter: this

Specifies a vertex position.

public method P³ → (3)

x ⁱⁿ : float64: X-coordinate of vertex position.
y ⁱⁿ : float64: Y-coordinate of vertex position.
z ⁱⁿ : float64: Z-coordinate of vertex position.
returns → VertexWriter: this

Specifies a vertex position.