cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
QuadCommand Class Reference

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

#include <CCQuadCommand.h>

Inheritance diagram for QuadCommand:
RenderCommand

Public Member Functions

 QuadCommand ()
 Constructor. More...
 
 ~QuadCommand ()
 Destructor. More...
 
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...
 
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. More...
 
uint32_t getMaterialID () const
 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 seperately. More...
 
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...
 
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...
 

Protected Member Functions

void generateMaterialID ()
 Generate the material ID by textureID, glProgramState, and blend function. More...
 
- Protected Member Functions inherited from RenderCommand
 RenderCommand ()
 Constructor. More...
 
virtual ~RenderCommand ()
 Desctructor. More...
 
local ~RenderCommand ()
 Desctructor. More...
 
void printID ()

Protected Attributes

uint32_t _materialID
 Generated material id. More...
 
GLuint _textureID
 OpenGL handle for texture. More...
 
var _textureID
 OpenGL handle for texture. More...
 
local _textureID
 OpenGL handle for texture. More...
 
GLProgramState_glProgramState
 GLprogramstate for the commmand. More...
 
BlendFunc _blendType
 Blend function when rendering the triangles. More...
 
var _blendType
 Blend function when rendering the triangles. More...
 
local _blendType
 Blend function when rendering the triangles. More...
 
V3F_C4B_T2F_Quad_quads
 The pointer to the rendered quads. More...
 
var _quads
 The pointer to the rendered quads. More...
 
local _quads
 The pointer to the rendered quads. More...
 
ssize_t _quadsCount
 The number of quads for rendering. More...
 
Mat4 _mv
 Model view matrix when rendering the triangles. More...
 
- Protected Attributes inherited from RenderCommand
Type _type
 Type used in order to avoid dynamic cast, faster. More...
 
float _globalOrder
 Commands are sort by global Z order. More...
 
bool _isTransparent
 Transparent flag. More...
 
bool _skipBatching
 QuadCommand and TrianglesCommand could be auto batched if there material ID is the same, however, if a command is skip batching, it would be forced to draw in a seperate function call, and break the batch. More...
 
bool _is3D
 Is the command been rendered on 3D pass. More...
 
float _depth
 Depth from the 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.

Constructor & Destructor Documentation

Constructor.

var QuadCommand ( )

Constructor.

local QuadCommand ( )

Constructor.

Destructor.

var ~QuadCommand ( )

Destructor.

local ~QuadCommand ( )

Destructor.

Member Function Documentation

void generateMaterialID ( )
protected

Generate the material ID by textureID, glProgramState, and blend function.

var generateMaterialID ( )
protected

Generate the material ID by textureID, glProgramState, and blend function.

local generateMaterialID ( )
protected

Generate the material ID by textureID, glProgramState, and blend function.

BlendFunc getBlendType ( ) const
inline

Get the blend function.

var getBlendType ( )
inline

Get the blend function.

local getBlendType ( )
inline

Get the blend function.

GLProgramState* getGLProgramState ( ) const
inline

Get the glprogramstate.

var getGLProgramState ( )
inline

Get the glprogramstate.

local getGLProgramState ( )
inline

Get the glprogramstate.

uint32_t getMaterialID ( ) const
inline

Get the material id of command.

var getMaterialID ( )
inline

Get the material id of command.

local getMaterialID ( )
inline

Get the material id of command.

const Mat4& getModelView ( ) const
inline

Get the model view matrix.

var getModelView ( )
inline

Get the model view matrix.

local getModelView ( )
inline

Get the model view matrix.

ssize_t getQuadCount ( ) const
inline

Get the number of quads for rendering.

var getQuadCount ( )
inline

Get the number of quads for rendering.

local getQuadCount ( )
inline

Get the number of quads for rendering.

V3F_C4B_T2F_Quad* getQuads ( ) const
inline

Get the pointer of the rendered quads.

var getQuads ( )
inline

Get the pointer of the rendered quads.

local getQuads ( )
inline

Get the pointer of the rendered quads.

GLuint getTextureID ( ) const
inline

Get the openGL texture handle.

var getTextureID ( )
inline

Get the openGL texture handle.

local getTextureID ( )
inline

Get the openGL texture handle.

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.

Parameters
globalOrderGlobalZOrder of the command.
textureIDThe openGL handle of the used texture.
glProgramStateThe specified glProgram and its uniform.
blendTypeBlend function for the command.
quadsRendered quads for the command.
quadCountThe number of quads when rendering.
mvModelView matrix for the command.
flagsto 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.

Parameters
globalOrderGlobalZOrder of the command.
textureIDThe openGL handle of the used texture.
glProgramStateThe specified glProgram and its uniform.
blendTypeBlend function for the command.
quadsRendered quads for the command.
quadCountThe number of quads when rendering.
mvModelView matrix for the command.
flagsto 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.

Parameters
globalOrderGlobalZOrder of the command.
textureIDThe openGL handle of the used texture.
glProgramStateThe specified glProgram and its uniform.
blendTypeBlend function for the command.
quadsRendered quads for the command.
quadCountThe number of quads when rendering.
mvModelView matrix for the command.
flagsto 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.

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.

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.

void useMaterial ( ) const

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

var useMaterial ( )

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

local useMaterial ( )

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

Member Data Documentation

BlendFunc _blendType
protected

Blend function when rendering the triangles.

var _blendType
protected

Blend function when rendering the triangles.

local _blendType
protected

Blend function when rendering the triangles.

GLProgramState* _glProgramState
protected

GLprogramstate for the commmand.

encapsulate shaders and uniforms.

var _glProgramState
protected

GLprogramstate for the commmand.

encapsulate shaders and uniforms.

local _glProgramState
protected

GLprogramstate for the commmand.

encapsulate shaders and uniforms.

uint32_t _materialID
protected

Generated material id.

var _materialID
protected

Generated material id.

Mat4 _mv
protected

Model view matrix when rendering the triangles.

var _mv
protected

Model view matrix when rendering the triangles.

local _mv
protected

Model view matrix when rendering the triangles.

V3F_C4B_T2F_Quad* _quads
protected

The pointer to the rendered quads.

var _quads
protected

The pointer to the rendered quads.

local _quads
protected

The pointer to the rendered quads.

ssize_t _quadsCount
protected

The number of quads for rendering.

var _quadsCount
protected

The number of quads for rendering.

local _quadsCount
protected

The number of quads for rendering.

GLuint _textureID
protected

OpenGL handle for texture.

var _textureID
protected

OpenGL handle for texture.

local _textureID
protected

OpenGL handle for texture.


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