OGRE: Ogre::RenderQueue Class Reference - OGRE Documentation

# Ogre::RenderQueue Class Reference

Class to manage the scene object rendering queue. More...

`#include <OgreRenderQueue.h>`

Inheritance diagram for Ogre::RenderQueue:

[legend]

List of all members.

## Public Types
typedef std::map< uint8, RenderQueueGroup * > | RenderQueueGroupMap
typedef MapIterator < RenderQueueGroupMap > | QueueGroupIterator
| Iterator over queue groups.
## Public Member Functions
| RenderQueue ()
virtual | ~RenderQueue ()
void | clear (bool destroyPassMaps=false)
| Empty the queue - should only be called by SceneManagers.
RenderQueueGroup * | getQueueGroup (uint8 qid)
| Get a render queue group.
void | addRenderable (Renderable *pRend, uint8 groupID, ushort priority)
| Add a renderable object to the queue.
void | addRenderable (Renderable *pRend, uint8 groupId)
| Add a renderable object to the queue.
void | addRenderable (Renderable *pRend)
| Add a renderable object to the queue.
uint8 | getDefaultQueueGroup (void) const
| Gets the current default queue group, which will be used for all renderable which do not specify which group they wish to be on.
void | setDefaultRenderablePriority (ushort priority)
| Sets the current default renderable priority, which will be used for all renderables which do not specify which priority they wish to use.
ushort | getDefaultRenderablePriority (void) const
| Gets the current default renderable priority, which will be used for all renderables which do not specify which priority they wish to use.
void | setDefaultQueueGroup (uint8 grp)
| Sets the current default queue group, which will be used for all renderable which do not specify which group they wish to be on.
QueueGroupIterator | _getQueueGroupIterator (void)
| Internal method, returns an iterator for the queue groups.
void | setSplitPassesByLightingType (bool split)
| Sets whether or not the queue will split passes by their lighting type, ie ambient, per-light and decal.
void | setSplitNoShadowPasses (bool split)
| Sets whether or not the queue will split passes which have shadow receive turned off (in their parent material), which is needed when certain shadow techniques are used.
void | setShadowCastersCannotBeReceivers (bool ind)
| Sets whether or not objects which cast shadows should be treated as never receiving shadows.
void | setRenderableListener (RenderableListener *listener)
| Set a renderable listener on the queue.
RenderableListener * | getRenderableListener (void) const
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info
void * | operator new[] (size_t sz)
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
## Protected Attributes
RenderQueueGroupMap | mGroups
uint8 | mDefaultQueueGroup
| The current default queue group.
ushort | mDefaultRenderablePriority
| The default priority.
bool | mSplitPassesByLightingType
bool | mSplitNoShadowPasses
bool | mShadowCastersCannotBeReceivers
RenderableListener * | mRenderableListener
## Classes
class | RenderableListener
| Class to listen in on items being added to the render queue. More...

## Detailed Description

Class to manage the scene object rendering queue.

Remarks:
  Objects are grouped by material to minimise rendering state changes. The map from material to renderable object is wrapped in a class for ease of use.

  This class now includes the concept of 'queue groups' which allows the application adding the renderable to specifically schedule it so that it is included in a discrete group. Good for separating renderables into the main scene, backgrounds and overlays, and also could be used in the future for more complex multipass routines like stenciling.

Definition at line 82 of file OgreRenderQueue.h.

## Member Typedef Documentation

typedef std::map< uint8, RenderQueueGroup* > Ogre::RenderQueue::RenderQueueGroupMap

Definition at line 85 of file OgreRenderQueue.h.

typedef MapIterator<RenderQueueGroupMap> Ogre::RenderQueue::QueueGroupIterator

Iterator over queue groups.

Definition at line 87 of file OgreRenderQueue.h.

## Constructor & Destructor Documentation

Ogre::RenderQueue::RenderQueue | ( |  | ) |

virtual Ogre::RenderQueue::~RenderQueue | ( |  | ) | `[virtual]`

## Member Function Documentation

void Ogre::RenderQueue::clear | ( | bool | destroyPassMaps = `false` | ) |

Empty the queue - should only be called by SceneManagers.

Parameters:

  | destroyPassMaps | Set to true to destroy all pass maps so that the queue is completely clean (useful when switching scene managers)

RenderQueueGroup* Ogre::RenderQueue::getQueueGroup | ( | uint8 | qid | ) |

Get a render queue group.

Remarks:
  OGRE registers new queue groups as they are requested, therefore this method will always return a valid group.

void Ogre::RenderQueue::addRenderable | ( | Renderable * | pRend,
|  | uint8 | groupID,
|  | ushort | priority |
| ) |  |  |

Add a renderable object to the queue.

Remarks:
  This methods adds a Renderable to the queue, which will be rendered later by the SceneManager. This is the advanced version of the call which allows the renderable to be added to any queue.

Note:
  Called by implementation of MovableObject::_updateRenderQueue.

Parameters:

  | pRend | Pointer to the Renderable to be added to the queue
  | groupID | The group the renderable is to be added to. This can be used to schedule renderable objects in separate groups such that the SceneManager respects the divisions between the groupings and does not reorder them outside these boundaries. This can be handy for overlays where no matter what you want the overlay to be rendered last.
  | priority | Controls the priority of the renderable within the queue group. If this number is raised, the renderable will be rendered later in the group compared to it's peers. Don't use this unless you really need to, manually ordering renderables prevents OGRE from sorting them for best efficiency. However this could be useful for ordering 2D elements manually for example.

void Ogre::RenderQueue::addRenderable | ( | Renderable * | pRend,
|  | uint8 | groupId |
| ) |  |  |

Add a renderable object to the queue.

Remarks:
  This methods adds a Renderable to the queue, which will be rendered later by the SceneManager. This is the simplified version of the call which does not require a priority to be specified. The queue priority is take from the current default (see setDefaultRenderablePriority).

Note:
  Called by implementation of MovableObject::_updateRenderQueue.

Parameters:

  | pRend | Pointer to the Renderable to be added to the queue
  | groupID | The group the renderable is to be added to. This can be used to schedule renderable objects in separate groups such that the SceneManager respects the divisions between the groupings and does not reorder them outside these boundaries. This can be handy for overlays where no matter what you want the overlay to be rendered last.

void Ogre::RenderQueue::addRenderable | ( | Renderable * | pRend | ) |

Add a renderable object to the queue.

Remarks:
  This methods adds a Renderable to the queue, which will be rendered later by the SceneManager. This is the simplified version of the call which does not require a queue or priority to be specified. The queue group is taken from the current default (see setDefaultQueueGroup). The queue priority is take from the current default (see setDefaultRenderablePriority).

Note:
  Called by implementation of MovableObject::_updateRenderQueue.

Parameters:

  | pRend | Pointer to the Renderable to be added to the queue

uint8 Ogre::RenderQueue::getDefaultQueueGroup | ( | void |  | ) | const

Gets the current default queue group, which will be used for all renderable which do not specify which group they wish to be on.

void Ogre::RenderQueue::setDefaultRenderablePriority | ( | ushort | priority | ) |

Sets the current default renderable priority, which will be used for all renderables which do not specify which priority they wish to use.

ushort Ogre::RenderQueue::getDefaultRenderablePriority | ( | void |  | ) | const

Gets the current default renderable priority, which will be used for all renderables which do not specify which priority they wish to use.

void Ogre::RenderQueue::setDefaultQueueGroup | ( | uint8 | grp | ) |

Sets the current default queue group, which will be used for all renderable which do not specify which group they wish to be on.

QueueGroupIterator Ogre::RenderQueue::_getQueueGroupIterator | ( | void |  | ) |

Internal method, returns an iterator for the queue groups.

void Ogre::RenderQueue::setSplitPassesByLightingType | ( | bool | split | ) |

Sets whether or not the queue will split passes by their lighting type, ie ambient, per-light and decal.

void Ogre::RenderQueue::setSplitNoShadowPasses | ( | bool | split | ) |

Sets whether or not the queue will split passes which have shadow receive turned off (in their parent material), which is needed when certain shadow techniques are used.

void Ogre::RenderQueue::setShadowCastersCannotBeReceivers | ( | bool | ind | ) |

Sets whether or not objects which cast shadows should be treated as never receiving shadows.

void Ogre::RenderQueue::setRenderableListener | ( | RenderableListener * | listener | ) |

Set a renderable listener on the queue.

Remarks:
  There can only be a single renderable listener on the queue, since that listener has complete control over the techniques in use.

Definition at line 249 of file OgreRenderQueue.h.

RenderableListener* Ogre::RenderQueue::getRenderableListener | ( | void |  | ) | const

Definition at line 252 of file OgreRenderQueue.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func |
| ) |  |  | `[inherited]`

operator new, with debug line info

Definition at line 62 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | `[inherited]`

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr |
| ) |  |  | `[inherited]`

placement operator new

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func |
| ) |  |  | `[inherited]`

array operator new, with debug line info

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | `[inherited]`

Definition at line 84 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | `[inherited]`

Definition at line 89 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |  |
| ) |  |  | `[inherited]`

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |  |
| ) |  |  | `[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | `[inherited]`

Definition at line 106 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |  |
| ) |  |  | `[inherited]`

Definition at line 112 of file OgreMemoryAllocatedObject.h.

## Member Data Documentation

RenderQueueGroupMap Ogre::RenderQueue::mGroups`[protected]`

Definition at line 122 of file OgreRenderQueue.h.

uint8 Ogre::RenderQueue::mDefaultQueueGroup`[protected]`

The current default queue group.

Definition at line 124 of file OgreRenderQueue.h.

ushort Ogre::RenderQueue::mDefaultRenderablePriority`[protected]`

The default priority.

Definition at line 126 of file OgreRenderQueue.h.

bool Ogre::RenderQueue::mSplitPassesByLightingType`[protected]`

Definition at line 128 of file OgreRenderQueue.h.

bool Ogre::RenderQueue::mSplitNoShadowPasses`[protected]`

Definition at line 129 of file OgreRenderQueue.h.

bool Ogre::RenderQueue::mShadowCastersCannotBeReceivers`[protected]`

Definition at line 130 of file OgreRenderQueue.h.

RenderableListener* Ogre::RenderQueue::mRenderableListener`[protected]`

Definition at line 132 of file OgreRenderQueue.h.

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

- OgreRenderQueue.h

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 26 11:35:18 2009