Kanzi Framework  3.9.0
Kanzi Engine 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 new parameter set. More...
 
 RenderEntryParameters (Node3D &nodeParam, size_t indexParam, MaterialSharedPtr materialParam)
 Creates a new parameter set. More...
 
 RenderEntryParameters (Node3D &nodeParam, size_t indexParam)
 Creates a new parameter set. More...
 

Public Attributes

size_t clusterIndex
 Index within the node. More...
 
MaterialSharedPtr material
 Material used. More...
 
Meshmesh
 Mesh used (may be nullptr). More...
 
Node3Dnode
 Node. More...
 

Detailed Description

Render entry parameters.

The parameter set used for generating a render entry.

Constructor & Destructor Documentation

◆ RenderEntryParameters() [1/3]

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

Creates a new parameter set.

Parameters
nodeParamNode being rendered.
indexParamRender entry index within the node.
materialParamMaterial used.
meshParamMesh being rendered (mostly for data-driven path).

◆ RenderEntryParameters() [2/3]

kanzi::Node3D::RenderEntryParameters::RenderEntryParameters ( Node3D nodeParam,
size_t  indexParam,
MaterialSharedPtr  materialParam 
)
inline

Creates a new parameter set.

Mesh is not set.

Parameters
nodeParamNode being rendered.
indexParamRender entry index within the node.
materialParamMaterial used.

◆ RenderEntryParameters() [3/3]

kanzi::Node3D::RenderEntryParameters::RenderEntryParameters ( Node3D nodeParam,
size_t  indexParam 
)
inline

Creates a new parameter set.

Mesh is not set. Material is not set.

Parameters
nodeParamNode being rendered.
indexParamRender entry index within the node.

Member Function Documentation

◆ operator==()

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

Equals operator.

Parameters
otherOther entry to compare against.
Returns
True if equal, false if not equal.

◆ operator!=()

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

Not equals operator.

Parameters
otherOther entry to compare against.
Returns
True if not equal, false if equal.

Member Data Documentation

◆ node

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

Node.

◆ clusterIndex

size_t kanzi::Node3D::RenderEntryParameters::clusterIndex

Index within the node.

◆ material

MaterialSharedPtr kanzi::Node3D::RenderEntryParameters::material

Material used.

◆ mesh

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

Mesh used (may be nullptr).


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