Cocos2d-x  v4
RenderCommand Class Reference

Base class of the RenderCommand hierarchy. More...

Inherited by CallbackCommand, CaptureScreenCallbackCommand, CustomCommand, GroupCommand, and TrianglesCommand.

Public Types

enum  Type {
  UNKNOWN_COMMAND, QUAD_COMMAND, CUSTOM_COMMAND, GROUP_COMMAND,
  MESH_COMMAND, TRIANGLES_COMMAND, CALLBACK_COMMAND
}
 Enum the type of render command. More...
 

Public Member Functions

void init (float globalZOrder, const Mat4 &modelViewTransform, unsigned int flags)
 Init function, will be called by all the render commands. More...
 
float getGlobalOrder () const
 Get global Z order.
 
Type getType () const
 Returns the Command type.
 
bool isTransparent () const
 Returns whether is transparent.
 
void setTransparent (bool isTransparent)
 Set transparent flag.
 
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.
 
bool is3D () const
 Whether the command should be rendered at 3D mode.
 
void set3D (bool value)
 Set the command rendered in 3D mode or not.
 
float getDepth () const
 Get the depth by current model view matrix.
 
PipelineDescriptor & getPipelineDescriptor ()
 Can use the result to change the descriptor content.
 

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 to draw things other then TRIANGLES_COMMAND.

GROUP_COMMAND 

Group command, which can group command in a tree hierarchy.

MESH_COMMAND 

Mesh command, used to draw 3D meshes.

TRIANGLES_COMMAND 

Triangles command, used to draw triangles.

CALLBACK_COMMAND 

Callback command, used for calling callback for rendering.

Member Function Documentation

◆ init()

void init ( float  globalZOrder,
const Mat4 modelViewTransform,
unsigned int  flags 
)

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

Parameters
globalZOrderThe global order of command, used for rendercommand sorting.
modelViewTransformModelview matrix when submitting the render command.
flagsFlag used to indicate whether the command should be draw at 3D mode or not.

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