Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
RenderQueue Class Reference

Class that knows how to sort RenderCommand objects. More...

Public Types

enum  QUEUE_GROUP {
  GLOBALZ_NEG = 0, OPAQUE_3D = 1, TRANSPARENT_3D = 2, GLOBALZ_ZERO = 3,
  GLOBALZ_POS = 4
}
 RenderCommand will be divided into Queue Groups. More...
 

Public Member Functions

 RenderQueue ()
 Constructor. More...
 
 RenderQueue ()
 Constructor. More...
 
 RenderQueue ()
 Constructor. More...
 
void push_back (RenderCommand *command)
 Push a renderCommand into current renderqueue. More...
 
var push_back ( var command)
 Push a renderCommand into current renderqueue. More...
 
local push_back ( local command)
 Push a renderCommand into current renderqueue. More...
 
ssize_t size () const
 Return the number of render commands. More...
 
var size ()
 Return the number of render commands. More...
 
local size ()
 Return the number of render commands. More...
 
void sort ()
 Sort the render commands. More...
 
var sort ()
 Sort the render commands. More...
 
local sort ()
 Sort the render commands. More...
 
RenderCommandoperator[] (ssize_t index) const
 Treat sorted commands as an array, access them one by one. More...
 
void clear ()
 Clear all rendered commands. More...
 
var clear ()
 Clear all rendered commands. More...
 
local clear ()
 Clear all rendered commands. More...
 
void realloc (size_t reserveSize)
 Realloc command queues and reserve with given size. More...
 
var realloc ( var reserveSize)
 Realloc command queues and reserve with given size. More...
 
local realloc ( local reserveSize)
 Realloc command queues and reserve with given size. More...
 
std::vector< RenderCommand * > & getSubQueue (QUEUE_GROUP group)
 Get a sub group of the render queue. More...
 
local getSubQueue ( local group)
 Get a sub group of the render queue. More...
 
ssize_t getSubQueueSize (QUEUE_GROUP group) const
 Get the number of render commands contained in a subqueue. More...
 
var getSubQueueSize ( var group)
 Get the number of render commands contained in a subqueue. More...
 
local getSubQueueSize ( local group)
 Get the number of render commands contained in a subqueue. More...
 
void saveRenderState ()
 Save the current DepthState, CullState, DepthWriteState render state. More...
 
void restoreRenderState ()
 Restore the saved DepthState, CullState, DepthWriteState render state. More...
 

Detailed Description

Class that knows how to sort RenderCommand objects.

Since the commands that have z == 0 are "pushed back" in the correct order, the only RenderCommand objects that need to be sorted, are the ones that have z < 0 and z > 0.

Constructor & Destructor Documentation

Constructor.

var RenderQueue ( )

Constructor.

local RenderQueue ( )

Constructor.

Member Function Documentation

void push_back ( RenderCommand command)

Push a renderCommand into current renderqueue.

var push_back ( var  command)

Push a renderCommand into current renderqueue.

local push_back ( local  command)

Push a renderCommand into current renderqueue.

ssize_t size ( ) const

Return the number of render commands.

var size ( )

Return the number of render commands.

local size ( )

Return the number of render commands.

void sort ( )

Sort the render commands.

var sort ( )

Sort the render commands.

local sort ( )

Sort the render commands.

RenderCommand* operator[] ( ssize_t  index) const

Treat sorted commands as an array, access them one by one.

RenderCommand* operator[] ( var  index)

Treat sorted commands as an array, access them one by one.

RenderCommand* operator[] ( local  index)

Treat sorted commands as an array, access them one by one.

void clear ( )

Clear all rendered commands.

var clear ( )

Clear all rendered commands.

local clear ( )

Clear all rendered commands.

void realloc ( size_t  reserveSize)

Realloc command queues and reserve with given size.

Note: this clears any existing commands.

var realloc ( var  reserveSize)

Realloc command queues and reserve with given size.

Note: this clears any existing commands.

local realloc ( local  reserveSize)

Realloc command queues and reserve with given size.

Note: this clears any existing commands.

std::vector<RenderCommand*>
& getSubQueue
( QUEUE_GROUP  group)
inline

Get a sub group of the render queue.

var getSubQueue ( var  group)
inline

Get a sub group of the render queue.

local getSubQueue ( local  group)
inline

Get a sub group of the render queue.

ssize_t getSubQueueSize ( QUEUE_GROUP  group) const
inline

Get the number of render commands contained in a subqueue.

var getSubQueueSize ( var  group)
inline

Get the number of render commands contained in a subqueue.

local getSubQueueSize ( local  group)
inline

Get the number of render commands contained in a subqueue.

void saveRenderState ( )

Save the current DepthState, CullState, DepthWriteState render state.

var saveRenderState ( )

Save the current DepthState, CullState, DepthWriteState render state.

local saveRenderState ( )

Save the current DepthState, CullState, DepthWriteState render state.

void restoreRenderState ( )

Restore the saved DepthState, CullState, DepthWriteState render state.

var restoreRenderState ( )

Restore the saved DepthState, CullState, DepthWriteState render state.

local restoreRenderState ( )

Restore the saved DepthState, CullState, DepthWriteState render state.


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