CustomCommand Class Reference

Custom command is used for call custom openGL command which can not be done by other commands, such as stencil function, depth functions etc. More...

Inherits RenderCommand.

Public Member Functions
	CustomCommand ()
	Constructor.
	~CustomCommand ()
	Destructor.
void	init (float globalZOrder, const Mat4 &modelViewTransform, uint32_t flags)
	Init function. More...
void	init (float globalZOrder)
	Init function. More...
void	execute ()
	Execute the render command and call callback functions.
Public Member Functions inherited from RenderCommand
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
	Retruns 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. More...
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...

Public Attributes
std::function< void()>	func
	Callback function.
local	func
	Callback function.

Additional Inherited Members
Public Types inherited from RenderCommand
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...

Detailed Description

Custom command is used for call custom openGL command which can not be done by other commands, such as stencil function, depth functions etc.

The render command is executed by calling a call back function.

Member Function Documentation

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

Init function.

GlobalZOrder of the render command. When in 3D mode, depth sorting needs modelViewTransform. Use to identify that the render command is 3D mode or not.

var init	(	var	globalZOrder,
		var	modelViewTransform,
		var	flags
	)

Init function.

GlobalZOrder of the render command. When in 3D mode, depth sorting needs modelViewTransform. Use to identify that the render command is 3D mode or not.

local init	(	local	globalZOrder,
		local	modelViewTransform,
		local	flags
	)

Init function.

GlobalZOrder of the render command. When in 3D mode, depth sorting needs modelViewTransform. Use to identify that the render command is 3D mode or not.

void init

(

float

globalZOrder

)

Init function.

The render command will be in 2D mode. GlobalZOrder of the render command.

var init

(

var

globalZOrder

)

Init function.

The render command will be in 2D mode. GlobalZOrder of the render command.

local init

(

local

globalZOrder

)

Init function.

The render command will be in 2D mode. GlobalZOrder of the render command.

---

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

• CCCustomCommand.h