kanzi::Mesh::CreateInfo::Cluster Struct Reference

Parameters for Mesh::Cluster creation. More...

#include <kanzi/core.ui/graphics3d/mesh_create_info.hpp>

Public Member Functions
	Cluster ()=default
	Default constructor.
	Cluster (GraphicsPrimitiveType primitiveType, size_t indexCount, IndexBufferType indexType, gfx::BufferHandleGuard indexBufferHandle, MaterialSharedPtr material, string_view materialURL)
	Constructor.
	Cluster (GraphicsPrimitiveType primitiveType, size_t indexCount, IndexBufferType indexType, MaterialSharedPtr material, string_view materialURL)
	Constructor.
size_t	getIndexCount () const
	Compatibility helper method that returns the index count.
byte *	setIndexCount (size_t count)
	Sets the index count.

Public Attributes
gfx::BufferHandleGuard	indexBufferHandle
	Kanzi graphics handle to the index buffer.
size_t	indexCount
	Index count.
vector< byte >	indexData
	Index data.
IndexBufferType	indexType
	The data type of the index buffer: UInt16 or UInt32.
MaterialSharedPtr	material
	Material for this cluster.
string	materialURL
	Temporary resource URL from which Kanzi acquires the material resource during finishing of loading.
GraphicsPrimitiveType	primitiveType
	Primitive type for the cluster.

Detailed Description

Parameters for Mesh::Cluster creation.

Constructor & Destructor Documentation

Cluster() [1/3]

kanzi::Mesh::CreateInfo::Cluster::Cluster ( )

explicitdefault

Default constructor.

Cluster() [2/3]

kanzi::Mesh::CreateInfo::Cluster::Cluster ( GraphicsPrimitiveType primitiveType, size_t indexCount, IndexBufferType indexType, MaterialSharedPtr material, string_view materialURL )

inlineexplicit

Constructor.

Parameters

primitiveType	Primitive type for cluster.
indexCount	Number of indices for cluster.
indexType	Data type of the index buffer: UInt16 or UInt32.
material	Material (pointer).
materialURL	URL to material resource.

Since

Kanzi 4.0.0 changed the type of the indexCount parameter to size_t.

Cluster() [3/3]

kanzi::Mesh::CreateInfo::Cluster::Cluster ( GraphicsPrimitiveType primitiveType, size_t indexCount, IndexBufferType indexType, gfx::BufferHandleGuard indexBufferHandle, MaterialSharedPtr material, string_view materialURL )

inlineexplicit

Constructor.

Parameters

primitiveType	Primitive type for cluster.
indexCount	Number of indices for cluster.
indexType	Data type of the index buffer: UInt16 or UInt32.
indexBufferHandle	Native handle for the index buffer.
material	Material (pointer).
materialURL	URL to material resource.

Since

Kanzi 3.9.6

Kanzi 4.0.0 changed the type of the indexCount parameter to size_t and indexBufferHandle to BufferHandleGuard.

Member Function Documentation

getIndexCount()

size_t kanzi::Mesh::CreateInfo::Cluster::getIndexCount ( ) const

inline

Compatibility helper method that returns the index count.

Returns

Index count.

Since

Kanzi 4.0.0 changed the type of the return value to size_t.

setIndexCount()

byte * kanzi::Mesh::CreateInfo::Cluster::setIndexCount ( size_t count )

inline

Sets the index count.

Parameters

count

Number of indices.

Returns

Pointer to the index data after resizing the array, or, if count was 0, nullptr.

Since

Kanzi 4.0.0 changed the type of the count parameter to size_t.

Member Data Documentation

primitiveType

GraphicsPrimitiveType kanzi::Mesh::CreateInfo::Cluster::primitiveType

Primitive type for the cluster.

indexType

IndexBufferType kanzi::Mesh::CreateInfo::Cluster::indexType

The data type of the index buffer: UInt16 or UInt32.

indexCount

size_t kanzi::Mesh::CreateInfo::Cluster::indexCount

Index count.

Since

Kanzi 3.9.6

Kanzi 4.0.0 changed the type to size_t.

indexData

vector<byte> kanzi::Mesh::CreateInfo::Cluster::indexData

Index data.

indexBufferHandle

gfx::BufferHandleGuard kanzi::Mesh::CreateInfo::Cluster::indexBufferHandle

Kanzi graphics handle to the index buffer.

Since

Kanzi 3.9.6

Kanzi 4.0.0 changed the type to BufferHandleGuard.

material

MaterialSharedPtr kanzi::Mesh::CreateInfo::Cluster::material

Material for this cluster.

materialURL

string kanzi::Mesh::CreateInfo::Cluster::materialURL

Temporary resource URL from which Kanzi acquires the material resource during finishing of loading.

---

The documentation for this struct was generated from the following file:

• kanzi/core.ui/graphics3d/mesh_create_info.hpp