Cocos2d-x  v3.15
TrianglesCommand Class Reference

Command used to render one or more Triangles, which is similar to QuadCommand. More...

Inheritance diagram for TrianglesCommand:
RenderCommand QuadCommand

Classes

struct  Triangles
 The structure of Triangles. More...
 

Public Member Functions

 TrianglesCommand ()
 Constructor. More...
 
 ~TrianglesCommand ()
 Destructor. More...
 
void init (float globalOrder, GLuint textureID, GLProgramState *glProgramState, BlendFunc blendType, const Triangles &triangles, const Mat4 &mv, uint32_t flags)
 Initializes the command. More...
 
void init (float globalOrder, GLuint textureID, GLProgramState *glProgramState, BlendFunc blendType, const Triangles &triangles, const Mat4 &mv)
 Deprecated function, the params is similar as the upper init function, with flags equals 0. More...
 
void useMaterial () const
 Apply the texture, shaders, programs, blend functions to GPU pipeline. More...
 
uint32_t getMaterialID () const
 Get the material id of command. More...
 
GLuint getTextureID () const
 Get the openGL texture handle. More...
 
const TrianglesgetTriangles () const
 Get a const reference of triangles. More...
 
ssize_t getVertexCount () const
 Get the vertex count in the triangles. More...
 
ssize_t getIndexCount () const
 Get the index count of the triangles. More...
 
const V3F_C4B_T2FgetVertices () const
 Get the vertex data pointer. More...
 
const unsigned short * getIndices () const
 Get the index data pointer. More...
 
GLProgramStategetGLProgramState () const
 Get the glprogramstate. More...
 
BlendFunc getBlendType () const
 Get the blend function. More...
 
const Mat4getModelView () const
 Get the model view matrix. 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...
 
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 one or more Triangles, which is similar to QuadCommand.

Every TrianglesCommand will have generate material ID by give textureID, glProgramState, Blend function if the material id is the same, these TrianglesCommands could be batched to save draw call.

Constructor & Destructor Documentation

◆ TrianglesCommand()

Constructor.

◆ ~TrianglesCommand()

Destructor.

Member Function Documentation

◆ init() [1/2]

void init ( float  globalOrder,
GLuint  textureID,
GLProgramState glProgramState,
BlendFunc  blendType,
const Triangles triangles,
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.
trianglesRendered triangles for the command.
mvModelView matrix for the command.
flagsto indicate that the command is using 3D rendering or not.

◆ init() [2/2]

void init ( float  globalOrder,
GLuint  textureID,
GLProgramState glProgramState,
BlendFunc  blendType,
const Triangles triangles,
const Mat4 mv 
)

Deprecated function, the params is similar as the upper init function, with flags equals 0.

◆ useMaterial()

void useMaterial ( ) const

Apply the texture, shaders, programs, blend functions to GPU pipeline.

◆ getMaterialID()

uint32_t getMaterialID ( ) const
inline

Get the material id of command.

◆ getTextureID()

GLuint getTextureID ( ) const
inline

Get the openGL texture handle.

◆ getTriangles()

const Triangles& getTriangles ( ) const
inline

Get a const reference of triangles.

◆ getVertexCount()

ssize_t getVertexCount ( ) const
inline

Get the vertex count in the triangles.

◆ getIndexCount()

ssize_t getIndexCount ( ) const
inline

Get the index count of the triangles.

◆ getVertices()

const V3F_C4B_T2F* getVertices ( ) const
inline

Get the vertex data pointer.

◆ getIndices()

const unsigned short* getIndices ( ) const
inline

Get the index data pointer.

◆ getGLProgramState()

GLProgramState* getGLProgramState ( ) const
inline

Get the glprogramstate.

◆ getBlendType()

BlendFunc getBlendType ( ) const
inline

Get the blend function.

◆ getModelView()

const Mat4& getModelView ( ) const
inline

Get the model view matrix.


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