BatchCommand Class Reference

Command used to draw batches in one TextureAtlas. More...

Inherits RenderCommand.

Public Member Functions
	BatchCommand ()
	Constructor. More...
	~BatchCommand ()
	Destructor. More...
	~BatchCommand ()
	Destructor. More...
void	init (float globalZOrder, GLProgram *shader, BlendFunc blendType, TextureAtlas *textureAtlas, const Mat4 &modelViewTransform, uint32_t flags)
	Init the batch command. More...
void	execute ()
	Execute the command, which will call openGL function to draw the texture atlas. More...
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...
var	init ( var globalZOrder, var modelViewTransform, var flags)
	Init function, will be called by all the render commands. More...
local	init ( local globalZOrder, local modelViewTransform, local flags)
	Init function, will be called by all the render commands. More...
float	getGlobalOrder () const
	Get global Z order. More...
local	getGlobalOrder ()
	Get global Z order. More...
Type	getType () const
	Returns the Command type. More...
local	getType ()
	Returns the Command type. More...
bool	isTransparent () const
	Returns whether is transparent. More...
local	isTransparent ()
	Returns whether is transparent. More...
void	setTransparent (bool isTransparent)
	Set transparent flag. More...
var	setTransparent ( var isTransparent)
	Set transparent flag. More...
local	setTransparent ( local 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...
local	setSkipBatching ( local value)
	Set skip batching. More...
bool	is3D () const
	Whether the command should be rendered at 3D mode. More...
var	is3D ()
	Whether the command should be rendered at 3D mode. More...
local	is3D ()
	Whether the command should be rendered at 3D mode. More...
void	set3D (bool value)
	Set the command rendered in 3D mode or not. More...
var	set3D ( var value)
	Set the command rendered in 3D mode or not. More...
local	set3D ( local value)
	Set the command rendered in 3D mode or not. More...
float	getDepth () const
	Get the depth by current model view matrix. More...
local	getDepth ()
	Get the depth by current model view matrix. More...

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

Command used to draw batches in one TextureAtlas.

Constructor & Destructor Documentation

BatchCommand

(

)

Constructor.

var BatchCommand

(

)

Constructor.

local BatchCommand

(

)

Constructor.

~BatchCommand

(

)

Destructor.

var ~BatchCommand

(

)

Destructor.

local ~BatchCommand

(

)

Destructor.

Member Function Documentation

void init	(	float	globalZOrder,
		GLProgram *	shader,
		BlendFunc	blendType,
		TextureAtlas *	textureAtlas,
		const Mat4 &	modelViewTransform,
		uint32_t	flags
	)

Init the batch command.

Parameters

globalZOrder	GlobalZOrder of the render command.
shader	Shader used for draw the texture atlas.
blendType	Blend function for texture atlas.
textureAtlas	Texture atlas, will contain both quads and texture for rendering.
modelViewTransform	Model view transform used for rendering.
flags	Indicate the render command should be rendered in 3D mode or not.

var init	(	var	globalZOrder,
		var	shader,
		var	blendType,
		var	textureAtlas,
		var	modelViewTransform,
		var	flags
	)

Init the batch command.

Parameters

globalZOrder	GlobalZOrder of the render command.
shader	Shader used for draw the texture atlas.
blendType	Blend function for texture atlas.
textureAtlas	Texture atlas, will contain both quads and texture for rendering.
modelViewTransform	Model view transform used for rendering.
flags	Indicate the render command should be rendered in 3D mode or not.

local init	(	local	globalZOrder,
		local	shader,
		local	blendType,
		local	textureAtlas,
		local	modelViewTransform,
		local	flags
	)

Init the batch command.

Parameters

globalZOrder	GlobalZOrder of the render command.
shader	Shader used for draw the texture atlas.
blendType	Blend function for texture atlas.
textureAtlas	Texture atlas, will contain both quads and texture for rendering.
modelViewTransform	Model view transform used for rendering.
flags	Indicate the render command should be rendered in 3D mode or not.

void execute

(

)

Execute the command, which will call openGL function to draw the texture atlas.

var execute

(

)

Execute the command, which will call openGL function to draw the texture atlas.

local execute

(

)

Execute the command, which will call openGL function to draw the texture atlas.

---

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

• CCBatchCommand.h