Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::Node3D::RenderEntryParameters Class Reference

Render entry parameters. More...

#include <kanzi/core.ui/node/node3d.hpp>

Public Member Functions

bool operator!= (const RenderEntryParameters &other) const
 Not equals operator. More...
 
bool operator== (const RenderEntryParameters &other) const
 Equals operator. More...
 
 RenderEntryParameters (Node3D &nodeParam, size_t indexParam, MaterialSharedPtr materialParam, Mesh *meshParam)
 Creates a set of render entry parameters. More...
 
 RenderEntryParameters (Node3D &nodeParam, size_t indexParam, MaterialSharedPtr materialParam)
 Creates a set of render entry parameters without setting a mesh. More...
 
 RenderEntryParameters (Node3D &nodeParam, size_t indexParam)
 Creates a set of render entry parameters without setting a mesh and material. More...
 

Public Attributes

size_t clusterIndex
 Index in the node. More...
 
MaterialSharedPtr material
 Material to use. More...
 
Meshmesh
 Mesh to render. Can be nullptr. More...
 
Node3Dnode
 Node. More...
 

Detailed Description

Render entry parameters.

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

Constructor & Destructor Documentation

kanzi::Node3D::RenderEntryParameters::RenderEntryParameters ( Node3D nodeParam,
size_t  indexParam,
MaterialSharedPtr  materialParam,
Mesh meshParam 
)
inlineexplicit

Creates a set of render entry parameters.

Parameters
nodeParamThe node to render.
indexParamThe index of the render entry in the node.
materialParamThe material to use.
meshParamThe mesh to render, mostly for data-driven path.
kanzi::Node3D::RenderEntryParameters::RenderEntryParameters ( Node3D nodeParam,
size_t  indexParam,
MaterialSharedPtr  materialParam 
)
inlineexplicit

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

Parameters
nodeParamThe node to render.
indexParamThe index of the render entry in the node.
materialParamThe material to use.
kanzi::Node3D::RenderEntryParameters::RenderEntryParameters ( Node3D nodeParam,
size_t  indexParam 
)
inlineexplicit

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

Parameters
nodeParamThe node to render.
indexParamThe index of the render entry in the node.

Member Function Documentation

bool kanzi::Node3D::RenderEntryParameters::operator== ( const RenderEntryParameters other) const
inline

Equals operator.

Parameters
otherThe entry to which to compare.
Returns
If the entries are equal, true, otherwise false.
bool kanzi::Node3D::RenderEntryParameters::operator!= ( const RenderEntryParameters other) const
inline

Not equals operator.

Parameters
otherThe entry to which to compare.
Returns
If the entries are not equal, true, otherwise false.

Member Data Documentation

Node3D* kanzi::Node3D::RenderEntryParameters::node

Node.

size_t kanzi::Node3D::RenderEntryParameters::clusterIndex

Index in the node.

MaterialSharedPtr kanzi::Node3D::RenderEntryParameters::material

Material to use.

Mesh* kanzi::Node3D::RenderEntryParameters::mesh

Mesh to render. Can be nullptr.


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