Cocos2d-x  v3.15
PrimitiveCommand Class Reference

Command used to render primitive, similar to QuadCommand. More...

Inheritance diagram for PrimitiveCommand:
RenderCommand

Public Member Functions

void init (float globalOrder, GLuint textureID, GLProgramState *glProgramState, BlendFunc blendType, Primitive *primitive, const Mat4 &mv, uint32_t flags)
 Initializes the command. More...
 
uint32_t getMaterialID () const
 Get the generated material ID. More...
 
GLuint getTextureID () const
 Get the texture ID used for drawing. More...
 
GLProgramStategetGLProgramState () const
 Get the glprogramstate used for drawing. More...
 
BlendFunc getBlendType () const
 Get the blend function for drawing. More...
 
const Mat4getModelView () const
 Get the modelview matrix when draw the primitive. More...
 
void execute () const
 Execute and draw the command, called by renderer. More...
 
 PrimitiveCommand ()
 
- 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
 Returns 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.
 
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...
 

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 render primitive, similar to QuadCommand.

Every QuadCommand will have generate material ID by give textureID, glProgramState, Blend function. However, primitive command could not be batched.

Constructor & Destructor Documentation

◆ PrimitiveCommand()

Constructor and Destructor.

Member Function Documentation

◆ init()

void init ( float  globalOrder,
GLuint  textureID,
GLProgramState glProgramState,
BlendFunc  blendType,
Primitive primitive,
const Mat4 mv,
uint32_t  flags 
)

Initializes the command.

Parameters
globalOrderGlobalZOrder of the command.
textureIDThe openGL handle of the used texture.
glProgramStateThe specified glProgram and its uniform.
blendTypeBlend function for the command.
primitiveRendered primitive for the command.
mvModelView matrix for the command.
flagsto indicate that the command is using 3D rendering or not.

◆ getMaterialID()

uint32_t getMaterialID ( ) const
inline

Get the generated material ID.

◆ getTextureID()

GLuint getTextureID ( ) const
inline

Get the texture ID used for drawing.

◆ getGLProgramState()

GLProgramState* getGLProgramState ( ) const
inline

Get the glprogramstate used for drawing.

◆ getBlendType()

BlendFunc getBlendType ( ) const
inline

Get the blend function for drawing.

◆ getModelView()

const Mat4& getModelView ( ) const
inline

Get the modelview matrix when draw the primitive.

◆ execute()

void execute ( ) const

Execute and draw the command, called by renderer.


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