nw::gfx::BasicRenderQueue Class

Syntax

template <typename TElement, typename TElementList, typename TElementKeyFactory>
class BasicRenderQueue : public nw::gfx::GfxObject

Template Arguments

Name Description
TElement Class serving as the render unit.
TElementList Container used to store the class serving as the render unit.
TElementKeyFactory Class that creates the keys used to sort the render units.

Description

Queue class that stores render elements.

Classes

nw::gfx::BasicRenderQueue::Builder Class for creating BasicRenderQueues.

Structures

nw::gfx::BasicRenderQueue::AlwaysCalculatingFunctor Always calculates the depth.
nw::gfx::BasicRenderQueue::BasicEnqueueModelFunctor Functor for adding models to the render queue.
nw::gfx::BasicRenderQueue::BasicEnqueueModelTranslucentModelBaseFunctor Functor for adding models to the render queue.
nw::gfx::BasicRenderQueue::CalculateDepthFunctor Function object that calculates depth in the clip coordinate system.
nw::gfx::BasicRenderQueue::CalculateDepthOfSkeletalModelFunctor Function object that calculates depth in the clip coordinate system used for skeletal models.
nw::gfx::BasicRenderQueue::IsCalculatingOnlyLayer1Functor Function object that calculates depth only when the render layer is 1 (translucent).
nw::gfx::BasicRenderQueue::ReportFunctor Function object for reporting render queue status to log output.

typedef Definitions

ElementType
ElementListType
ElementKeyFactoryType
ElementKeyType
reference
difference_type
value_type
iterator
const_iterator
reverse_iterator
const_reverse_iterator
EnqueueModelFunctor Functor for adding models to the render queue.
EnqueueSkeletalModelFunctor The functor for adding skeletal models to the render queue.
FastEnqueueModelFunctor Functor for adding models to the render queue. Depth is calculated only when the render layer is 1 (translucent).
FastEnqueueSkeletalModelFunctor The functor for adding skeletal models to the render queue. Depth is calculated only when the render layer is 1 (translucent).
EnqueueModelTranslucentModelBaseFunctor Functor for adding models to the render queue.
EnqueueSkeletalModelTranslucentModelBaseFunctor The functor for adding skeletal models to the render queue.
FastEnqueueModelTranslucentModelBaseFunctor Functor for adding models to the render queue. Depth is calculated only when the render layer is 1 (translucent).
FastEnqueueSkeletalModelTranslucentModelBaseFunctor The functor for adding skeletal models to the render queue. Depth is calculated only when the render layer is 1 (translucent).

Member Constants

S PRIORITY_END Definition representing the last (highest value) priority.

Member Variables

NW_UT_RUNTIME_TYPEINFO

Member Functions

Key Operations
EnqueueElement Adds a render element to the queue.
EnqueueMesh Adds a mesh to the queue.
EnqueueModel Adds mesh elements included in the model to the queue.
EnqueueSkeletalModel Adds mesh elements included in the skeletal model to the queue.
EnqueueCommand Adds a command to the queue.
Reset Deletes all items in the queue.
Set/Get
Size Gets the number of elements.
Empty Returns true if there are no elements.
Peek Accesses the first element.
Begin Gets an iterator to the start.
END Gets an iterator to the end.
ReverseBegin Gets an reverse iterator to the start.
ReverseEnd Gets a reverse iterator to the end.
Utilities
NW_DEPRECATED_FUNCTION Calculates the depth in clip coordinates. (Deprecated)
Create/Destroy
Destroy Destroys an object.(Derived from GfxObject.

Class Hierarchy

nw::gfx::GfxObject
  nw::gfx::BasicRenderQueue


CONFIDENTIAL