Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
QuadCommand Class Reference

Command used to render one or more Quads, similar to TrianglesCommand. More...

Inherits RenderCommand.

Public Member Functions

 QuadCommand ()
 Constructor.
 
 ~QuadCommand ()
 Destructor.
 
void init (float globalOrder, GLuint textureID, GLProgramState *shader, const BlendFunc &blendType, V3F_C4B_T2F_Quad *quads, ssize_t quadCount, const Mat4 &mv, uint32_t flags)
 Initializes the command. More...
 
local init ( local globalOrder, local textureID, local shader, local blendType, local quads, local quadCount, local mv, local flags)
 Initializes the command. More...
 
void init (float globalOrder, GLuint textureID, GLProgramState *shader, const BlendFunc &blendType, V3F_C4B_T2F_Quad *quads, ssize_t quadCount, 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.
 
uint32_t getMaterialID () const
 Get the material id of command. More...
 
local getMaterialID ()
 Get the material id of command. More...
 
GLuint getTextureID () const
 Get the openGL texture handle. More...
 
V3F_C4B_T2F_QuadgetQuads () const
 Get the pointer of the rendered quads. More...
 
local getQuads ()
 Get the pointer of the rendered quads. More...
 
ssize_t getQuadCount () const
 Get the number of quads for rendering. 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
 Retruns 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. More...
 
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 Quads, similar to TrianglesCommand.

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

Member Function Documentation

void init ( float  globalOrder,
GLuint  textureID,
GLProgramState shader,
const BlendFunc blendType,
V3F_C4B_T2F_Quad quads,
ssize_t  quadCount,
const Mat4 mv,
uint32_t  flags 
)

Initializes the command.

GlobalZOrder of the command. The openGL handle of the used texture. The specified glProgram and its uniform. Blend function for the command. Rendered quads for the command. The number of quads when rendering. ModelView matrix for the command. to indicate that the command is using 3D rendering or not.

var init ( var  globalOrder,
var  textureID,
var  shader,
var  blendType,
var  quads,
var  quadCount,
var  mv,
var  flags 
)

Initializes the command.

GlobalZOrder of the command. The openGL handle of the used texture. The specified glProgram and its uniform. Blend function for the command. Rendered quads for the command. The number of quads when rendering. ModelView matrix for the command. to indicate that the command is using 3D rendering or not.

local init ( local  globalOrder,
local  textureID,
local  shader,
local  blendType,
local  quads,
local  quadCount,
local  mv,
local  flags 
)

Initializes the command.

GlobalZOrder of the command. The openGL handle of the used texture. The specified glProgram and its uniform. Blend function for the command. Rendered quads for the command. The number of quads when rendering. ModelView matrix for the command. to indicate that the command is using 3D rendering or not.

void init ( float  globalOrder,
GLuint  textureID,
GLProgramState shader,
const BlendFunc blendType,
V3F_C4B_T2F_Quad quads,
ssize_t  quadCount,
const Mat4 mv 
)

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

GlobalZOrder of the command. The openGL handle of the used texture. The specified glProgram and its uniform. Blend function for the command. Rendered quads for the command. The number of quads when rendering. ModelView matrix for the command.

var init ( var  globalOrder,
var  textureID,
var  shader,
var  blendType,
var  quads,
var  quadCount,
var  mv 
)

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

GlobalZOrder of the command. The openGL handle of the used texture. The specified glProgram and its uniform. Blend function for the command. Rendered quads for the command. The number of quads when rendering. ModelView matrix for the command.

local init ( local  globalOrder,
local  textureID,
local  shader,
local  blendType,
local  quads,
local  quadCount,
local  mv 
)

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

GlobalZOrder of the command. The openGL handle of the used texture. The specified glProgram and its uniform. Blend function for the command. Rendered quads for the command. The number of quads when rendering. ModelView matrix for the command.

uint32_t getMaterialID ( ) const
inline

Get the material id of command.

the material id.

var getMaterialID ( )
inline

Get the material id of command.

the material id.

local getMaterialID ( )
inline

Get the material id of command.

the material id.

GLuint getTextureID ( ) const
inline

Get the openGL texture handle.

openGL texture handle.

var getTextureID ( )
inline

Get the openGL texture handle.

openGL texture handle.

local getTextureID ( )
inline

Get the openGL texture handle.

openGL texture handle.

V3F_C4B_T2F_Quad* getQuads ( ) const
inline

Get the pointer of the rendered quads.

the pointer of the rendered quads.

var getQuads ( )
inline

Get the pointer of the rendered quads.

the pointer of the rendered quads.

local getQuads ( )
inline

Get the pointer of the rendered quads.

the pointer of the rendered quads.

ssize_t getQuadCount ( ) const
inline

Get the number of quads for rendering.

the number of quads.

var getQuadCount ( )
inline

Get the number of quads for rendering.

the number of quads.

local getQuadCount ( )
inline

Get the number of quads for rendering.

the number of quads.

GLProgramState* getGLProgramState ( ) const
inline

Get the glprogramstate.

glprogramstate.

var getGLProgramState ( )
inline

Get the glprogramstate.

glprogramstate.

local getGLProgramState ( )
inline

Get the glprogramstate.

glprogramstate.

BlendFunc getBlendType ( ) const
inline

Get the blend function.

blend function.

var getBlendType ( )
inline

Get the blend function.

blend function.

local getBlendType ( )
inline

Get the blend function.

blend function.

const Mat4& getModelView ( ) const
inline

Get the model view matrix.

model view matrix.

var getModelView ( )
inline

Get the model view matrix.

model view matrix.

local getModelView ( )
inline

Get the model view matrix.

model view matrix.


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