kanzi::RenderEntryParameters3D Struct Reference

Parameters for RenderEntry3D construction. More...

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

Public Member Functions
bool	operator!= (const RenderEntryParameters3D &other) const
	Not equals operator.
RenderEntryParameters3D &	operator= (const RenderEntryParameters3D &)=default
	Default copy operator.
RenderEntryParameters3D &	operator= (RenderEntryParameters3D &&)=default
	Default move operator.
bool	operator== (const RenderEntryParameters3D &other) const
	Equals operator.
	RenderEntryParameters3D (const RenderEntryParameters3D &)=default
	Default copy constructor.
	RenderEntryParameters3D (Node3D &nodeParam, size_t indexParam)
	Creates a set of render entry parameters without setting a mesh and material.
	RenderEntryParameters3D (Node3D &nodeParam, size_t indexParam, MaterialSharedPtr materialParam)
	Creates a set of render entry parameters without setting a mesh.
	RenderEntryParameters3D (Node3D &nodeParam, size_t indexParam, MaterialSharedPtr materialParam, Mesh *meshParam)
	Creates a set of render entry parameters.
	RenderEntryParameters3D (RenderEntryParameters3D &&)=default
	Default move constructor.

Public Attributes
size_t	clusterIndex
	Index in the node.
MaterialSharedPtr	material
	Material to use.
Mesh *	mesh
	Mesh to render. Can be nullptr.
Node3D *	node
	Node.

Detailed Description

Parameters for RenderEntry3D construction.

Kanzi uses this set of parameters to generate a render entries.

Since

Kanzi 4.0.0

• Renamed from RenderEntryParameters.
• Moved outside Node3D.

Constructor & Destructor Documentation

RenderEntryParameters3D() [1/5]

kanzi::RenderEntryParameters3D::RenderEntryParameters3D ( Node3D & nodeParam, size_t indexParam, MaterialSharedPtr materialParam, Mesh * meshParam )

inlineexplicit

Creates a set of render entry parameters.

Parameters

nodeParam	The node to render.
indexParam	The index of the render entry in the node.
materialParam	The material to use.
meshParam	The mesh to render, mostly for data-driven path.

RenderEntryParameters3D() [2/5]

kanzi::RenderEntryParameters3D::RenderEntryParameters3D ( Node3D & nodeParam, size_t indexParam, MaterialSharedPtr materialParam )

inlineexplicit

Creates a set of render entry parameters without setting a mesh.

Parameters

nodeParam	The node to render.
indexParam	The index of the render entry in the node.
materialParam	The material to use.

RenderEntryParameters3D() [3/5]

kanzi::RenderEntryParameters3D::RenderEntryParameters3D ( Node3D & nodeParam, size_t indexParam )

inlineexplicit

Creates a set of render entry parameters without setting a mesh and material.

Parameters

nodeParam	The node to render.
indexParam	The index of the render entry in the node.

RenderEntryParameters3D() [4/5]

kanzi::RenderEntryParameters3D::RenderEntryParameters3D ( const RenderEntryParameters3D & )

default

Default copy constructor.

RenderEntryParameters3D() [5/5]

kanzi::RenderEntryParameters3D::RenderEntryParameters3D ( RenderEntryParameters3D && )

default

Default move constructor.

Member Function Documentation

operator=() [1/2]

RenderEntryParameters3D & kanzi::RenderEntryParameters3D::operator= ( const RenderEntryParameters3D & )

default

Default copy operator.

operator=() [2/2]

RenderEntryParameters3D & kanzi::RenderEntryParameters3D::operator= ( RenderEntryParameters3D && )

default

Default move operator.

operator==()

bool kanzi::RenderEntryParameters3D::operator== ( const RenderEntryParameters3D & other ) const

inline

Equals operator.

Parameters

other

The entry to which to compare.

Returns

If the entries are equal, true, otherwise false.

operator!=()

bool kanzi::RenderEntryParameters3D::operator!= ( const RenderEntryParameters3D & other ) const

inline

Not equals operator.

Parameters

other

The entry to which to compare.

Returns

If the entries are not equal, true, otherwise false.

Member Data Documentation

node

Node3D* kanzi::RenderEntryParameters3D::node

Node.

clusterIndex

size_t kanzi::RenderEntryParameters3D::clusterIndex

Index in the node.

material

MaterialSharedPtr kanzi::RenderEntryParameters3D::material

Material to use.

mesh

Mesh* kanzi::RenderEntryParameters3D::mesh

Mesh to render. Can be nullptr.

---

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

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