RenderCommand Class Reference

Base class of the RenderCommand hierarchy. More...

#include <CCRenderCommand.h>

Inheritance diagram for RenderCommand:

Public Types
enum	Type {   UNKNOWN_COMMAND, QUAD_COMMAND, CUSTOM_COMMAND, BATCH_COMMAND,   GROUP_COMMAND, MESH_COMMAND, PRIMITIVE_COMMAND, TRIANGLES_COMMAND }

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 Render Command Id. More...
Type	getType () const
	Returns the Command type. More...
bool	isTransparent () const
	Retruns whether is transparent. More...
void	setTransparent (bool isTransparent)
	set transparent flag More...
bool	isSkipBatching () const
void	setSkipBatching (bool value)
bool	is3D () const
void	set3D (bool value)
float	getDepth () const

Protected Member Functions
	RenderCommand ()
virtual	~RenderCommand ()
local	~RenderCommand ()
void	printID ()

Protected Attributes
Type	_type
float	_globalOrder
bool	_isTransparent
bool	_skipBatching
bool	_is3D
float	_depth

Detailed Description

Base class of the RenderCommand hierarchy.

The Renderer knows how to render RenderCommands objects.

Member Enumeration Documentation

enum Type

strong

Enumerator
UNKNOWN_COMMAND
QUAD_COMMAND
CUSTOM_COMMAND
BATCH_COMMAND
GROUP_COMMAND
MESH_COMMAND
PRIMITIVE_COMMAND
TRIANGLES_COMMAND

var Type

strong

Enumerator
UNKNOWN_COMMAND
QUAD_COMMAND
CUSTOM_COMMAND
BATCH_COMMAND
GROUP_COMMAND
MESH_COMMAND
PRIMITIVE_COMMAND
TRIANGLES_COMMAND

local Type

strong

Enumerator
UNKNOWN_COMMAND
QUAD_COMMAND
CUSTOM_COMMAND
BATCH_COMMAND
GROUP_COMMAND
MESH_COMMAND
PRIMITIVE_COMMAND
TRIANGLES_COMMAND

Constructor & Destructor Documentation

RenderCommand ( )

protected

var RenderCommand ( )

protected

local RenderCommand ( )

protected

virtual ~RenderCommand ( )

protectedvirtual

var ~RenderCommand ( )

protectedvirtual

local ~RenderCommand ( )

protectedvirtual

Member Function Documentation

float getDepth ( ) const

inline

var getDepth ( )

inline

local getDepth ( )

inline

float getGlobalOrder ( ) const

inline

Get Render Command Id.

var getGlobalOrder ( )

inline

Get Render Command Id.

local getGlobalOrder ( )

inline

Get Render Command Id.

Type getType ( ) const

inline

Returns the Command type.

var getType ( )

inline

Returns the Command type.

local getType ( )

inline

Returns the Command type.

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

init function, will be called by all the render commands

bool is3D ( ) const

inline

var is3D ( )

inline

local is3D ( )

inline

bool isSkipBatching ( ) const

inline

var isSkipBatching ( )

inline

local isSkipBatching ( )

inline

bool isTransparent ( ) const

inline

Retruns whether is transparent.

var isTransparent ( )

inline

Retruns whether is transparent.

local isTransparent ( )

inline

Retruns whether is transparent.

void printID ( )

protected

var printID ( )

protected

local printID ( )

protected

void set3D ( bool  value )

inline

var set3D ( var  value )

inline

local set3D ( local  value )

inline

void setSkipBatching ( bool  value )

inline

var setSkipBatching ( var  value )

inline

local setSkipBatching ( local  value )

inline

void setTransparent ( bool  isTransparent )

inline

set transparent flag

var setTransparent ( var  isTransparent )

inline

set transparent flag

local setTransparent ( local  isTransparent )

inline

set transparent flag

Member Data Documentation

float _depth

protected

var _depth

protected

local _depth

protected

float _globalOrder

protected

var _globalOrder

protected

local _globalOrder

protected

bool _is3D

protected

var _is3D

protected

local _is3D

protected

bool _isTransparent

protected

var _isTransparent

protected

local _isTransparent

protected

bool _skipBatching

protected

var _skipBatching

protected

local _skipBatching

protected

Type _type

protected

var _type

protected

local _type

protected

---

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

• /Users/huabingxu/work/cocos2d-x/cocos/renderer/CCRenderCommand.h