TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

struct PrimitiveBatch in Tinman.Engine.Rendering.Util

A rendering primitive batch.

struct PrimitiveBatch implements IEquatable<PrimitiveBatch>

Public / Attributes

Count

Number of vertex indices.

public readonly field Count
type int32

First

Index of first vertex index in buffer.

public readonly field First
type int32

Indexed

Is this an indexed primitive?

public readonly field Indexed
type bool

IsLines

Is this a line primitive batch?

public property IsLines { get }
type bool
value true if this is a line primitive batch, false if not.

IsPoints

Is this a point primitive batch?

public property IsPoints { get }
type bool
value true if this is a point primitive batch, false if not.

IsTriangles

Is this a triangle primitive batch?

public property IsTriangles { get }
type bool
value true if this is a triangle primitive batch, false if not.

Type

The primitive type.

public readonly field Type
type Primitive

Public / Constants

None

public static readonly field None
type PrimitiveBatch

Public / Constructors

LineList

Creates a LineList primitive batch.

[Pure]
public static method LineList (int32 first, int32 count)
type PrimitiveBatch
params first [>=0] First vertex to draw.
  count [>=0] Number of vertices to draw.
returns The primitive batch.

LineListIndexed

Creates an indexed LineList primitive batch.

[Pure]
public static method LineListIndexed (int32 first, int32 count)
type PrimitiveBatch
params first [>=0] First index to draw.
  count [>=0] Number of indices to draw.
returns The primitive batch.

LineStrip

Creates a LineStrip primitive batch.

[Pure]
public static method LineStrip (int32 first, int32 count)
type PrimitiveBatch
params first [>=0] First vertex to draw.
  count [>=0] Number of vertices to draw.
returns The primitive batch.

LineStripIndexed

Creates an indexed LineStrip primitive batch.

[Pure]
public static method LineStripIndexed (int32 first, int32 count)
type PrimitiveBatch
params first [>=0] First index to draw.
  count [>=0] Number of indices to draw.
returns The primitive batch.

PointList

Creates a PointList primitive batch.

[Pure]
public static method PointList (int32 first, int32 count)
type PrimitiveBatch
params first [>=0] First vertex to draw.
  count [>=0] Number of vertices to draw.
returns The primitive batch.

PointListIndexed

Creates an indexed PointList primitive batch.

[Pure]
public static method PointListIndexed (int32 first, int32 count)
type PrimitiveBatch
params first [>=0] First index to draw.
  count [>=0] Number of indices to draw.
returns The primitive batch.

PrimitiveBatch

Creates a new instance of PrimitiveBatch.

public constructor PrimitiveBatch (Primitive type, int32 first, int32 count, bool indexed)
params type The primitive type.
  first [>=0] First index resp. vertex to render.
  count [>=0] Number of indices resp. vertices to render.
  indexed Draw indexed geometry?

TriangleList

Creates a TriangleList primitive batch.

[Pure]
public static method TriangleList (int32 first, int32 count)
type PrimitiveBatch
params first [>=0] First vertex to draw.
  count [>=0] Number of vertices to draw.
returns The primitive batch.

TriangleListIndexed

Creates an indexed TriangleList primitive batch.

[Pure]
public static method TriangleListIndexed (int32 first, int32 count)
type PrimitiveBatch
params first [>=0] First index to draw.
  count [>=0] Number of indices to draw.
returns The primitive batch.

TriangleStrip

Creates a TriangleStrip primitive batch.

[Pure]
public static method TriangleStrip (int32 first, int32 count)
type PrimitiveBatch
params first [>=0] First vertex to draw.
  count [>=0] Number of vertices to draw.
returns The primitive batch.

TriangleStripIndexed

Creates an indexed TriangleStrip primitive batch.

[Pure]
public static method TriangleStripIndexed (int32 first, int32 count)
type PrimitiveBatch
params first [>=0] First index to draw.
  count [>=0] Number of indices to draw.
returns The primitive batch.

Public / Methods

CollectLines

Collects all line primitives.

public method CollectLines ([] int32[] indices)
type Vec2I[]
params indices The vertex indices for indexed geometry or null for non-indexed geometry.
returns The collected line primitives or null if none primitives have been collected.

CollectPoints

Collects all point primitives.

public method CollectPoints ([] int32[] indices)
type int32[]
params indices The vertex indices for indexed geometry or null for non-indexed geometry.
returns The collected point primitives or null if none primitives have been collected.

CollectTriangles

Collects all triangle primitives.

public method CollectTriangles ([] int32[] indices)
type Vec3I[]
params indices The vertex indices for indexed geometry or null for non-indexed geometry.
returns The collected triangle primitives or null if none primitives have been collected.

Equals

Compares this object with the given one.

[Pure]
public method Equals (PrimitiveBatch other)
type bool
params other The object to compare to.
returns true if this object is equal to other, false if not.

Render

public method Render (IPrimitiveRenderer renderer, int32 baseIndex = 0)
params renderer
  baseIndex