Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Classes | Public Member Functions | Protected Attributes | List of all members
vl::RenderQueue Class Reference

The RenderQueue class collects a list of RenderToken objects to be sorted and rendered. More...

#include <RenderQueue.hpp>

+ Inheritance diagram for vl::RenderQueue:

Public Member Functions

 RenderQueue ()
 
const RenderTokenat (int i) const
 
RenderTokenat (int i)
 
RenderTokennewToken (bool multipass)
 
void clear ()
 
bool empty ()
 
int size () const
 
void sort (RenderQueueSorter *sorter, Camera *camera)
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Attributes

std::vector< ref< RenderToken > > mList
 
std::vector< ref< RenderToken > > mListMP
 
int mSize
 
int mSizeMP
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Detailed Description

The RenderQueue class collects a list of RenderToken objects to be sorted and rendered.

Definition at line 45 of file RenderQueue.hpp.

Constructor & Destructor Documentation

◆ RenderQueue()

vl::RenderQueue::RenderQueue ( )
inline

Definition at line 50 of file RenderQueue.hpp.

References mList, and mListMP.

Member Function Documentation

◆ at() [1/2]

const RenderToken* vl::RenderQueue::at ( int  i) const
inline

◆ at() [2/2]

RenderToken* vl::RenderQueue::at ( int  i)
inline

Definition at line 59 of file RenderQueue.hpp.

References mList.

◆ clear()

void vl::RenderQueue::clear ( )
inline

Definition at line 79 of file RenderQueue.hpp.

References mSize, and mSizeMP.

Referenced by vl::Rendering::render().

◆ empty()

bool vl::RenderQueue::empty ( )
inline

Definition at line 85 of file RenderQueue.hpp.

References mSize.

◆ newToken()

RenderToken* vl::RenderQueue::newToken ( bool  multipass)
inline

Definition at line 61 of file RenderQueue.hpp.

References mList, mListMP, mSize, and mSizeMP.

Referenced by vl::Rendering::fillRenderQueue().

◆ size()

int vl::RenderQueue::size ( ) const
inline

◆ sort()

void vl::RenderQueue::sort ( RenderQueueSorter sorter,
Camera camera 
)
inline

Member Data Documentation

◆ mList

std::vector< ref<RenderToken> > vl::RenderQueue::mList
protected

Definition at line 142 of file RenderQueue.hpp.

Referenced by at(), newToken(), RenderQueue(), and sort().

◆ mListMP

std::vector< ref<RenderToken> > vl::RenderQueue::mListMP
protected

Definition at line 143 of file RenderQueue.hpp.

Referenced by newToken(), and RenderQueue().

◆ mSize

int vl::RenderQueue::mSize
protected

Definition at line 144 of file RenderQueue.hpp.

Referenced by clear(), empty(), newToken(), and size().

◆ mSizeMP

int vl::RenderQueue::mSizeMP
protected

Definition at line 145 of file RenderQueue.hpp.

Referenced by clear(), and newToken().


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