RenderCommand Class Reference

Base class of the RenderCommand hierarchy. More...

Inheritance diagram for RenderCommand:

Public Types
enum	Type {   UNKNOWN_COMMAND, QUAD_COMMAND, CUSTOM_COMMAND, BATCH_COMMAND,   GROUP_COMMAND, MESH_COMMAND, PRIMITIVE_COMMAND, TRIANGLES_COMMAND }
	Enum the type of render command. More...

Public Member Functions
void	init (float globalZOrder, const Mat4 &modelViewTransform, uint32_t flags)
	Init function, will be called by all the render commands. More...
float	getGlobalOrder () const
	Get global Z order. More...
Type	getType () const
	Returns the Command type. More...
bool	isTransparent () const
	Returns whether is transparent. More...
void	setTransparent (bool isTransparent)
	Set transparent flag. More...
bool	isSkipBatching () const
	Get skip batching status, if a rendering is skip batching, it will be forced to be rendering separately.
void	setSkipBatching (bool value)
	Set skip batching. More...
bool	is3D () const
	Whether the command should be rendered at 3D mode. More...
void	set3D (bool value)
	Set the command rendered in 3D mode or not. More...
float	getDepth () const
	Get the depth by current model view matrix. More...

Detailed Description

Base class of the RenderCommand hierarchy.

The Renderer knows how to render RenderCommands objects.

Member Enumeration Documentation

Type

enum Type

strong

Enum the type of render command.

Enumerator
UNKNOWN_COMMAND	Reserved type.
QUAD_COMMAND	Quad command, used for draw quad.
CUSTOM_COMMAND	Custom command, used for calling callback for rendering.
BATCH_COMMAND	Batch command, used for draw batches in texture atlas.
GROUP_COMMAND	Group command, which can group command in a tree hierarchy.
MESH_COMMAND	Mesh command, used to draw 3D meshes.
PRIMITIVE_COMMAND	Primitive command, used to draw primitives such as lines, points and triangles.
TRIANGLES_COMMAND	Triangles command, used to draw triangles.

Member Function Documentation

init()

void init	(	float	globalZOrder,
		const Mat4 &	modelViewTransform,
		uint32_t	flags
	)

Init function, will be called by all the render commands.

Parameters

globalZOrder	The global order of command, used for rendercommand sorting.
modelViewTransform	Modelview matrix when submitting the render command.
flags	Flag used to indicate whether the command should be draw at 3D mode or not.

getGlobalOrder()

float getGlobalOrder ( ) const

inline

Get global Z order.

getType()

Type getType ( ) const

inline

Returns the Command type.

isTransparent()

bool isTransparent ( ) const

inline

Returns whether is transparent.

setTransparent()

void setTransparent ( bool  isTransparent )

inline

Set transparent flag.

setSkipBatching()

void setSkipBatching ( bool  value )

inline

Set skip batching.

is3D()

bool is3D ( ) const

inline

Whether the command should be rendered at 3D mode.

set3D()

void set3D ( bool  value )

inline

Set the command rendered in 3D mode or not.

getDepth()

float getDepth ( ) const

inline

Get the depth by current model view matrix.

---

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

• CCRenderCommand.h