VisuTwin Canvas
C++ 3D Engine — Metal Backend
Loading...
Searching...
No Matches
visutwin::canvas::Layer Class Reference

#include <scene/layer.h>

Public Member Functions

void addMeshInstances (const std::vector< MeshInstance * > &meshInstances)
bool clearColorBuffer () const
bool clearDepthBuffer () const
bool clearStencilBuffer () const
bool dirtyComposition () const
bool enabled () const
int id () const
 Layer (const std::string &name, int id)
const std::vector< MeshInstance * > & meshInstances () const
const std::string & name () const
void removeMeshInstances (const std::vector< MeshInstance * > &meshInstances)
void setClearColorBuffer (const bool value)
void setClearDepthBuffer (const bool value)
void setClearStencilBuffer (const bool value)
void setDirtyComposition (const bool value)
void setEnabled (const bool value)

Detailed Description

A Layer represents a renderable subset of the scene. It can contain a list of mesh instances, lights and cameras, their render settings and also defines custom callbacks before, after or during rendering. Layers are organized inside LayerComposition in a desired order.

Definition at line 21 of file layer.h.

Constructor & Destructor Documentation

◆ Layer()

visutwin::canvas::Layer::Layer ( const std::string & name,
int id )
inline

Definition at line 24 of file layer.h.

References id(), and name().

Member Function Documentation

◆ addMeshInstances()

void visutwin::canvas::Layer::addMeshInstances ( const std::vector< MeshInstance * > & meshInstances)
inline

Definition at line 30 of file layer.h.

References meshInstances().

◆ clearColorBuffer()

bool visutwin::canvas::Layer::clearColorBuffer ( ) const
inline

Definition at line 57 of file layer.h.

◆ clearDepthBuffer()

bool visutwin::canvas::Layer::clearDepthBuffer ( ) const
inline

Definition at line 60 of file layer.h.

◆ clearStencilBuffer()

bool visutwin::canvas::Layer::clearStencilBuffer ( ) const
inline

Definition at line 63 of file layer.h.

◆ dirtyComposition()

bool visutwin::canvas::Layer::dirtyComposition ( ) const
inline

Definition at line 66 of file layer.h.

◆ enabled()

bool visutwin::canvas::Layer::enabled ( ) const
inline

Definition at line 54 of file layer.h.

Referenced by visutwin::canvas::LayerComposition::isEnabled().

◆ id()

int visutwin::canvas::Layer::id ( ) const
inline

Definition at line 26 of file layer.h.

Referenced by visutwin::canvas::LayerComposition::isEnabled(), Layer(), and visutwin::canvas::Renderer::renderForwardLayer().

◆ meshInstances()

const std::vector< MeshInstance * > & visutwin::canvas::Layer::meshInstances ( ) const
inline

Definition at line 52 of file layer.h.

Referenced by addMeshInstances(), removeMeshInstances(), and visutwin::canvas::Renderer::renderForwardLayer().

◆ name()

const std::string & visutwin::canvas::Layer::name ( ) const
inline

Definition at line 28 of file layer.h.

Referenced by Layer().

◆ removeMeshInstances()

void visutwin::canvas::Layer::removeMeshInstances ( const std::vector< MeshInstance * > & meshInstances)
inline

Definition at line 42 of file layer.h.

References meshInstances().

◆ setClearColorBuffer()

void visutwin::canvas::Layer::setClearColorBuffer ( const bool value)
inline

Definition at line 58 of file layer.h.

◆ setClearDepthBuffer()

void visutwin::canvas::Layer::setClearDepthBuffer ( const bool value)
inline

Definition at line 61 of file layer.h.

◆ setClearStencilBuffer()

void visutwin::canvas::Layer::setClearStencilBuffer ( const bool value)
inline

Definition at line 64 of file layer.h.

◆ setDirtyComposition()

void visutwin::canvas::Layer::setDirtyComposition ( const bool value)
inline

Definition at line 67 of file layer.h.

◆ setEnabled()

void visutwin::canvas::Layer::setEnabled ( const bool value)
inline

Definition at line 55 of file layer.h.

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