Diligent::DrawIndexedAttribs Struct Reference

Defines the indexed draw command attributes. More...

#include <DeviceContext.h>

Public Member Functions
constexpr	DrawIndexedAttribs () noexcept
	Initializes the structure members with default values.
constexpr	DrawIndexedAttribs (Uint32 _NumIndices, VALUE_TYPE _IndexType, DRAW_FLAGS _Flags, Uint32 _NumInstances=1, Uint32 _FirstIndexLocation=0, Uint32 _BaseVertex=0, Uint32 _FirstInstanceLocation=0) noexcept
	Initializes the structure members with user-specified values.

Public Attributes
Uint32	NumIndices = 0
	The number of indices to draw.
VALUE_TYPE	IndexType = VT_UNDEFINED
	The type of elements in the index buffer.
DRAW_FLAGS	Flags = DRAW_FLAG_NONE
	Additional flags, see Diligent::DRAW_FLAGS.
Uint32	NumInstances = 1
	Number of instances to draw.
Uint32	FirstIndexLocation = 0
Uint32	BaseVertex = 0
	A constant which is added to each index before accessing the vertex buffer.
Uint32	FirstInstanceLocation = 0

Detailed Description

Defines the indexed draw command attributes.

This structure is used by IDeviceContext::DrawIndexed().

Constructor & Destructor Documentation

DrawIndexedAttribs()

Diligent::DrawIndexedAttribs::DrawIndexedAttribs ( )

inlineconstexprnoexcept

Initializes the structure members with default values.

Default values:

Member	Default value
NumIndices	0
IndexType	VT_UNDEFINED
Flags	DRAW_FLAG_NONE
NumInstances	1
FirstIndexLocation	0
BaseVertex	0
FirstInstanceLocation	0

Member Data Documentation

FirstIndexLocation

Uint32 Diligent::DrawIndexedAttribs::FirstIndexLocation = 0

LOCATION (NOT the byte offset) of the first index in the index buffer to start reading indices from.

FirstInstanceLocation

Uint32 Diligent::DrawIndexedAttribs::FirstInstanceLocation = 0

LOCATION (or INDEX, but NOT the byte offset) in the vertex buffer to start reading instance data from.

IndexType

VALUE_TYPE Diligent::DrawIndexedAttribs::IndexType = VT_UNDEFINED

The type of elements in the index buffer.

Allowed values: VT_UINT16 and VT_UINT32.

NumInstances

Uint32 Diligent::DrawIndexedAttribs::NumInstances = 1

Number of instances to draw.

If more than one instance is specified, instanced draw call will be performed.