Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
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. More...
 
 ~CustomCommand ()
 Destructor. More...
 
 ~CustomCommand ()
 Destructor. More...
 
void init (float globalZOrder, const Mat4 &modelViewTransform, uint32_t flags)
 Init function. More...
 
var init ( var globalZOrder, var modelViewTransform, var flags)
 Init function. More...
 
local init ( local globalZOrder, local modelViewTransform, local 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...
 
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...
 

Public Attributes

std::function< void()> func
 Callback function. More...
 
local func
 Callback function. 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

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.

Constructor & Destructor Documentation

Constructor.

var CustomCommand ( )

Constructor.

local CustomCommand ( )

Constructor.

Destructor.

var ~CustomCommand ( )

Destructor.

local ~CustomCommand ( )

Destructor.

Member Function Documentation

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

Init function.

Parameters
globalZOrderGlobalZOrder of the render command.
modelViewTransformWhen in 3D mode, depth sorting needs modelViewTransform.
flagsUse to identify that the render command is 3D mode or not.
var init ( var  globalZOrder,
var  modelViewTransform,
var  flags 
)

Init function.

Parameters
globalZOrderGlobalZOrder of the render command.
modelViewTransformWhen in 3D mode, depth sorting needs modelViewTransform.
flagsUse to identify that the render command is 3D mode or not.
local init ( local  globalZOrder,
local  modelViewTransform,
local  flags 
)

Init function.

Parameters
globalZOrderGlobalZOrder of the render command.
modelViewTransformWhen in 3D mode, depth sorting needs modelViewTransform.
flagsUse 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.

Parameters
globalZOrderGlobalZOrder of the render command.
var init ( var  globalZOrder)

Init function.

The render command will be in 2D mode.

Parameters
globalZOrderGlobalZOrder of the render command.
local init ( local  globalZOrder)

Init function.

The render command will be in 2D mode.

Parameters
globalZOrderGlobalZOrder of the render command.

Member Data Documentation

std::function<void()> func

Callback function.

var func

Callback function.

local func

Callback function.


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