Cocos Creator API

1.0.0

Cocos Creator is a highly customizable game development tool that utilizes the power of cocos2d-x.

TextureAtlas

Module: cc

A class that implements a Texture Atlas.
Supported features:
The atlas file can be a PNG, JPG.
Quads can be updated in runtime
Quads can be added in runtime
Quads can be removed in runtime
Quads can be re-ordered in runtime
The TextureAtlas capacity can be increased or decreased in runtime.

Properties

dirty Boolean

Indicates whether or not the array buffer of the VBO needs to be updated.

texture Image

Image texture for cc.TextureAtlas.

capacity Number readOnly

Quantity of quads that can be stored with the current texture atlas size.

totalQuads Number readOnly

Quantity of quads that are going to be drawn.

quads Array readOnly

Quads that are going to be rendered.

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Methods

TextureAtlas
(
  • fileName
  • capacity
)

Creates a TextureAtlas with an filename and with an initial capacity for Quads.
The TextureAtlas capacity can be increased in runtime.

Constructor of cc.TextureAtlas

name type description
fileName String | Texture2D
capacity Number

examples:

--------------------------
1. //creates a TextureAtlas with  filename
var textureAtlas = new cc.TextureAtlas("res/hello.png", 3);

2. //creates a TextureAtlas with texture
var texture = cc.textureCache.addImage("hello.png");
var textureAtlas = new cc.TextureAtlas(texture, 3);

getTotalQuads ( ) Number

Quantity of quads that are going to be drawn.

returns:

type: Number

getCapacity ( ) Number

Quantity of quads that can be stored with the current texture atlas size.

returns:

type: Number

getTexture ( ) Image

Texture of the texture atlas.

returns:

type: Image

setTexture
(
  • texture
)

Set texture for texture atlas.

name type description
texture Image

setDirty
(
  • dirty
)

specify if the array buffer of the VBO needs to be updated.

name type description
dirty Boolean

isDirty ( ) Boolean

whether or not the array buffer of the VBO needs to be updated.

returns:

type: Boolean

getQuads ( ) Array

Quads that are going to be rendered.

returns:

type: Array

setQuads
(
  • quads
)

name type description
quads Array

initWithFile
(
  • file
  • capacity
)
Boolean

Initializes a TextureAtlas with a filename and with a certain capacity for Quads.
The TextureAtlas capacity can be increased in runtime.
WARNING: Do not reinitialize the TextureAtlas because it will leak memory.

name type description
file String
capacity Number

returns:

type: Boolean

examples:

--------------------------------------------------
var textureAtlas = new cc.TextureAtlas();
textureAtlas.initWithTexture("hello.png", 3);

initWithTexture
(
  • texture
  • capacity
)
Boolean

Initializes a TextureAtlas with a previously initialized Texture2D object, and
with an initial capacity for Quads.
The TextureAtlas capacity can be increased in runtime.
WARNING: Do not reinitialize the TextureAtlas because it will leak memory

name type description
texture Image
capacity Number

returns:

type: Boolean

examples:

---------------------------
var texture = cc.textureCache.addImage("hello.png");
var textureAtlas = new cc.TextureAtlas();
textureAtlas.initWithTexture(texture, 3);

updateQuad
(
  • quad
  • index
)

Updates a Quad (texture, vertex and color) at a certain index
index must be between 0 and the atlas capacity - 1

name type description
quad V3F_C4B_T2F_Quad
index Number

insertQuad
(
  • quad
  • index
)

Inserts a Quad (texture, vertex and color) at a certain index
index must be between 0 and the atlas capacity - 1

name type description
quad V3F_C4B_T2F_Quad
index Number

insertQuads
(
  • quads
  • index
  • amount
)

Inserts a c array of quads at a given index
index must be between 0 and the atlas capacity - 1
this method doesn't enlarge the array when amount + index > totalQuads

name type description
quads Array
index Number
amount Number

insertQuadFromIndex
(
  • fromIndex
  • newIndex
)

Removes the quad that is located at a certain index and inserts it at a new index
This operation is faster than removing and inserting in a quad in 2 different steps

name type description
fromIndex Number
newIndex Number

removeQuadAtIndex
(
  • index
)

Removes a quad at a given index number.
The capacity remains the same, but the total number of quads to be drawn is reduced in 1

name type description
index Number

removeQuadsAtIndex
(
  • index
  • amount
)

Removes a given number of quads at a given index.

name type description
index Number
amount Number

removeAllQuads ( )

Removes all Quads.
The TextureAtlas capacity remains untouched. No memory is freed.
The total number of quads to be drawn will be 0

resizeCapacity
(
  • newCapacity
)
Boolean

Resize the capacity of the CCTextureAtlas.
The new capacity can be lower or higher than the current one
It returns YES if the resize was successful.
If it fails to resize the capacity it will return NO with a new capacity of 0.
no used for js

name type description
newCapacity Number

returns:

type: Boolean

increaseTotalQuadsWith
(
  • amount
)

Used internally by CCParticleBatchNode
don't use this unless you know what you're doing.

name type description
amount Number

moveQuadsFromIndex
(
  • oldIndex
  • amount
  • newIndex
)

Moves an amount of quads from oldIndex at newIndex.

name type description
oldIndex Number
amount Number
newIndex Number

fillWithEmptyQuadsFromIndex
(
  • index
  • amount
)

Ensures that after a realloc quads are still empty
Used internally by CCParticleBatchNode.

name type description
index Number
amount Number

drawNumberOfQuads
(
  • n
  • start
)

Draws n quads from an index (offset).
n + start can't be greater than the capacity of the atlas

name type description
n Number
start Number

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index