Issue : added js annotates to SimpleAudioEngine, CCVertexIndexBuffer.h, CCVertexIndexData.h

This commit is contained in:
dingpinglv 2015-03-19 20:20:16 +08:00
parent 7a50af4407
commit 1b179c2b02
3 changed files with 8 additions and 1 deletions

View File

@ -50,6 +50,7 @@ namespace CocosDenshion {
* @brief Offers a very simple interface to play background music & sound effects.
*
* @note Make sure to call SimpleAudioEngine::end() when the sound engine is not needed anymore to release allocated resources.
* @js cc.audioEngine
*/
class EXPORT_DLL SimpleAudioEngine
@ -57,6 +58,7 @@ class EXPORT_DLL SimpleAudioEngine
public:
/**
* Returns a shared instance of the SimpleAudioEngine.
* @js NA
*/
static SimpleAudioEngine* getInstance();
@ -78,7 +80,7 @@ public:
* Preload background music.
*
* @param filePath The path of the background music file.
* @js preloadMusic
* @js NA
* @lua preloadMusic
*/
virtual void preloadBackgroundMusic(const char* filePath);
@ -235,6 +237,7 @@ public:
* The compressed audio will be decoded to wave, then written into an internal buffer in SimpleAudioEngine.
*
* @param filePath The path of the effect file.
* @js NA
*/
virtual void preloadEffect(const char* filePath);

View File

@ -36,6 +36,7 @@ class EventListenerCustom;
/**
VertexBuffer is an abstraction of low level openGL Vertex Buffer Object.
It is used to save an array of vertices.
*@js NA
*/
class CC_DLL VertexBuffer : public Ref
{
@ -133,6 +134,7 @@ public:
/**
IndexBuffer is an abstraction of low level openGL Buffer Object.
It used to save an array of indices.
@js NA
*/
class CC_DLL IndexBuffer : public Ref
{

View File

@ -42,6 +42,7 @@ glVertexAttribPointer(GLuint indx, GLint size, GLenum type, GLboolean normalized
_offset is used to compute the start offset in a interleaved array, take a V3F_C4B_T2F array,
offset of vertex will be 0, offset of color would be 0 + sizeof(float) * 3 = 12,
offset of texture coord would be 12 + sizeof(char) * 4 = 16.
@js NA
*/
struct CC_DLL VertexStreamAttribute
{
@ -101,6 +102,7 @@ struct CC_DLL VertexStreamAttribute
VertexData is a class used for specify input streams for GPU rendering pipeline,
a VertexData will be composed by several streams, every stream will contain a VertexStreamAttribute
and the binding VertexBuffer. Streams will be identified by semantic.
@js NA
*/
class CC_DLL VertexData : public Ref