Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
TextureAtlas Class Reference

A class that implements a Texture Atlas. More...

Inherits Ref.

Public Member Functions

bool initWithFile (const std::string &file, ssize_t capacity)
 Initializes a TextureAtlas with a filename and with a certain capacity for Quads. More...
 
bool initWithTexture (Texture2D *texture, ssize_t capacity)
 Initializes a TextureAtlas with a previously initialized Texture2D object, and with an initial capacity for Quads. More...
 
void updateQuad (V3F_C4B_T2F_Quad *quad, ssize_t index)
 Updates a Quad (texture, vertex and color) at a certain index. More...
 
void insertQuad (V3F_C4B_T2F_Quad *quad, ssize_t index)
 Inserts a Quad (texture, vertex and color) at a certain index. More...
 
void insertQuads (V3F_C4B_T2F_Quad *quads, ssize_t index, ssize_t amount)
 Inserts a c array of quads at a given index. More...
 
void insertQuadFromIndex (ssize_t fromIndex, ssize_t newIndex)
 Removes the quad that is located at a certain index and inserts it at a new index. More...
 
void removeQuadAtIndex (ssize_t index)
 Removes a quad at a given index number. More...
 
void removeQuadsAtIndex (ssize_t index, ssize_t amount)
 Removes a amount of quads starting from index. More...
 
void removeAllQuads ()
 Removes all Quads. More...
 
var removeAllQuads ()
 Removes all Quads. More...
 
local removeAllQuads ()
 Removes all Quads. More...
 
bool resizeCapacity (ssize_t capacity)
 Resize the capacity of the TextureAtlas. More...
 
void increaseTotalQuadsWith (ssize_t amount)
 Used internally by ParticleBatchNode. More...
 
var increaseTotalQuadsWith ( var amount)
 Used internally by ParticleBatchNode. More...
 
local increaseTotalQuadsWith ( local amount)
 Used internally by ParticleBatchNode. More...
 
void moveQuadsFromIndex (ssize_t oldIndex, ssize_t amount, ssize_t newIndex)
 Moves an amount of quads from oldIndex at newIndex. More...
 
var moveQuadsFromIndex ( var oldIndex, var amount, var newIndex)
 Moves an amount of quads from oldIndex at newIndex. More...
 
local moveQuadsFromIndex ( local oldIndex, local amount, local newIndex)
 Moves an amount of quads from oldIndex at newIndex. More...
 
void moveQuadsFromIndex (ssize_t index, ssize_t newIndex)
 Moves quads from index till totalQuads to the newIndex. More...
 
void fillWithEmptyQuadsFromIndex (ssize_t index, ssize_t amount)
 Ensures that after a realloc quads are still empty. More...
 
void drawNumberOfQuads (ssize_t n)
 Draws n quads. More...
 
local drawNumberOfQuads ( local n)
 Draws n quads. More...
 
void drawNumberOfQuads (ssize_t numberOfQuads, ssize_t start)
 Draws n quads from an index (offset). More...
 
var drawNumberOfQuads ( var numberOfQuads, var start)
 Draws n quads from an index (offset). More...
 
local drawNumberOfQuads ( local numberOfQuads, local start)
 Draws n quads from an index (offset). More...
 
void drawQuads ()
 Draws all the Atlas's Quads.
 
void listenRendererRecreated (EventCustom *event)
 Listen the event that renderer was recreated on Android.
 
var listenRendererRecreated ( var event)
 Listen the event that renderer was recreated on Android.
 
local listenRendererRecreated ( local event)
 Listen the event that renderer was recreated on Android.
 
bool isDirty ()
 Whether or not the array buffer of the VBO needs to be updated. More...
 
void setDirty (bool bDirty)
 Specify if the array buffer of the VBO needs to be updated. More...
 
local setDirty ( local bDirty)
 Specify if the array buffer of the VBO needs to be updated. More...
 
virtual std::string getDescription () const
 Get quads total amount.
 
ssize_t getTotalQuads () const
 Gets the quantity of quads that are going to be drawn. More...
 
local getTotalQuads ()
 Gets the quantity of quads that are going to be drawn. More...
 
ssize_t getCapacity () const
 Gets the quantity of quads that can be stored with the current texture atlas size. More...
 
Texture2DgetTexture () const
 Gets the texture of the texture atlas. More...
 
local getTexture ()
 Gets the texture of the texture atlas. More...
 
void setTexture (Texture2D *texture)
 Sets the texture for the texture atlas. More...
 
var setTexture ( var texture)
 Sets the texture for the texture atlas. More...
 
local setTexture ( local texture)
 Sets the texture for the texture atlas. More...
 
V3F_C4B_T2F_QuadgetQuads ()
 Gets the quads that are going to be rendered. More...
 
local getQuads ()
 Gets the quads that are going to be rendered. More...
 
void setQuads (V3F_C4B_T2F_Quad *quads)
 Sets the quads that are going to be rendered. More...
 
var setQuads ( var quads)
 Sets the quads that are going to be rendered. More...
 
local setQuads ( local quads)
 Sets the quads that are going to be rendered. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
local release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 

Static Public Member Functions

static TextureAtlascreate (const std::string &file, ssize_t capacity)
 Creates a TextureAtlas with an filename and with an initial capacity for Quads. More...
 
static TextureAtlascreateWithTexture (Texture2D *texture, ssize_t capacity)
 Creates a TextureAtlas with a previously initialized Texture2D object, and with an initial capacity for n Quads. More...
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 

Detailed Description

A class that implements a Texture Atlas.

Supported features: The atlas file can be a PVRTC, PNG or any other format supported by Texture2D 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 OpenGL component: V3F, C4B, T2F. The quads are rendered using an OpenGL ES VBO. To render the quads using an interleaved vertex array list, you should modify the ccConfig.h file

Warning
If you want to use TextureAtlas, you'd better setup GL status before it's rendered. Otherwise, the effect of TextureAtlas will be affected by the GL status of other nodes.

Member Function Documentation

static TextureAtlas* create ( const std::string &  file,
ssize_t  capacity 
)
static

Creates a TextureAtlas with an filename and with an initial capacity for Quads.

The TextureAtlas capacity can be increased in runtime.

Parameters
fileA null terminated string contains the file path.
capacityCapacity for Quads.
var create ( var  file,
var  capacity 
)
static

Creates a TextureAtlas with an filename and with an initial capacity for Quads.

The TextureAtlas capacity can be increased in runtime.

Parameters
fileA null terminated string contains the file path.
capacityCapacity for Quads.
local create ( local  file,
local  capacity 
)
static

Creates a TextureAtlas with an filename and with an initial capacity for Quads.

The TextureAtlas capacity can be increased in runtime.

Parameters
fileA null terminated string contains the file path.
capacityCapacity for Quads.
static TextureAtlas*
createWithTexture
( Texture2D texture,
ssize_t  capacity 
)
static

Creates a TextureAtlas with a previously initialized Texture2D object, and with an initial capacity for n Quads.

The TextureAtlas capacity can be increased in runtime.

Parameters
textureA texture2D object pointer.
capacityCapacity for Quads.
var createWithTexture ( var  texture,
var  capacity 
)
static

Creates a TextureAtlas with a previously initialized Texture2D object, and with an initial capacity for n Quads.

The TextureAtlas capacity can be increased in runtime.

Parameters
textureA texture2D object pointer.
capacityCapacity for Quads.
local createWithTexture ( local  texture,
local  capacity 
)
static

Creates a TextureAtlas with a previously initialized Texture2D object, and with an initial capacity for n Quads.

The TextureAtlas capacity can be increased in runtime.

Parameters
textureA texture2D object pointer.
capacityCapacity for Quads.
bool initWithFile ( const std::string &  file,
ssize_t  capacity 
)

Initializes a TextureAtlas with a filename and with a certain capacity for Quads.

The TextureAtlas capacity can be increased in runtime.

Attention
Do not reinitialize the TextureAtlas because it will leak memory (issue #706).
Parameters
fileA null terminated string contains the file path.
capacityCapacity for Quads.
var initWithFile ( var  file,
var  capacity 
)

Initializes a TextureAtlas with a filename and with a certain capacity for Quads.

The TextureAtlas capacity can be increased in runtime.

Attention
Do not reinitialize the TextureAtlas because it will leak memory (issue #706).
Parameters
fileA null terminated string contains the file path.
capacityCapacity for Quads.
local initWithFile ( local  file,
local  capacity 
)

Initializes a TextureAtlas with a filename and with a certain capacity for Quads.

The TextureAtlas capacity can be increased in runtime.

Attention
Do not reinitialize the TextureAtlas because it will leak memory (issue #706).
Parameters
fileA null terminated string contains the file path.
capacityCapacity for Quads.
bool initWithTexture ( Texture2D texture,
ssize_t  capacity 
)

Initializes a TextureAtlas with a previously initialized Texture2D object, and with an initial capacity for Quads.

The TextureAtlas capacity can be increased in runtime.

Attention
: Do not reinitialize the TextureAtlas because it will leak memory (issue #706).
Parameters
textureA texture2D object pointer.
capacityCapacity for Quads.
var initWithTexture ( var  texture,
var  capacity 
)

Initializes a TextureAtlas with a previously initialized Texture2D object, and with an initial capacity for Quads.

The TextureAtlas capacity can be increased in runtime.

Attention
: Do not reinitialize the TextureAtlas because it will leak memory (issue #706).
Parameters
textureA texture2D object pointer.
capacityCapacity for Quads.
local initWithTexture ( local  texture,
local  capacity 
)

Initializes a TextureAtlas with a previously initialized Texture2D object, and with an initial capacity for Quads.

The TextureAtlas capacity can be increased in runtime.

Attention
: Do not reinitialize the TextureAtlas because it will leak memory (issue #706).
Parameters
textureA texture2D object pointer.
capacityCapacity for Quads.
void updateQuad ( V3F_C4B_T2F_Quad quad,
ssize_t  index 
)

Updates a Quad (texture, vertex and color) at a certain index.

Parameters
quadQuad that are going to be rendered.
indexIndex must be between 0 and the atlas capacity - 1.
Since
v0.8
var updateQuad ( var  quad,
var  index 
)

Updates a Quad (texture, vertex and color) at a certain index.

Parameters
quadQuad that are going to be rendered.
indexIndex must be between 0 and the atlas capacity - 1.
Since
v0.8
local updateQuad ( local  quad,
local  index 
)

Updates a Quad (texture, vertex and color) at a certain index.

Parameters
quadQuad that are going to be rendered.
indexIndex must be between 0 and the atlas capacity - 1.
Since
v0.8
void insertQuad ( V3F_C4B_T2F_Quad quad,
ssize_t  index 
)

Inserts a Quad (texture, vertex and color) at a certain index.

Parameters
quadQuad that are going to be rendered.
indexIndex must be between 0 and the atlas capacity - 1.
Since
v0.8
var insertQuad ( var  quad,
var  index 
)

Inserts a Quad (texture, vertex and color) at a certain index.

Parameters
quadQuad that are going to be rendered.
indexIndex must be between 0 and the atlas capacity - 1.
Since
v0.8
local insertQuad ( local  quad,
local  index 
)

Inserts a Quad (texture, vertex and color) at a certain index.

Parameters
quadQuad that are going to be rendered.
indexIndex must be between 0 and the atlas capacity - 1.
Since
v0.8
void insertQuads ( V3F_C4B_T2F_Quad quads,
ssize_t  index,
ssize_t  amount 
)

Inserts a c array of quads at a given index.

Parameters
quadsQuad that are going to be rendered.
indexIndex must be between 0 and the atlas capacity - 1.
amountThe quads array amount.
Attention
This method doesn't enlarge the array when amount + index > totalQuads.
Since
v1.1
var insertQuads ( var  quads,
var  index,
var  amount 
)

Inserts a c array of quads at a given index.

Parameters
quadsQuad that are going to be rendered.
indexIndex must be between 0 and the atlas capacity - 1.
amountThe quads array amount.
Attention
This method doesn't enlarge the array when amount + index > totalQuads.
Since
v1.1
local insertQuads ( local  quads,
local  index,
local  amount 
)

Inserts a c array of quads at a given index.

Parameters
quadsQuad that are going to be rendered.
indexIndex must be between 0 and the atlas capacity - 1.
amountThe quads array amount.
Attention
This method doesn't enlarge the array when amount + index > totalQuads.
Since
v1.1
void insertQuadFromIndex ( ssize_t  fromIndex,
ssize_t  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.

Since
v0.7.2
var insertQuadFromIndex ( var  fromIndex,
var  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.

Since
v0.7.2
local insertQuadFromIndex ( local  fromIndex,
local  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.

Since
v0.7.2
void removeQuadAtIndex ( ssize_t  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.

Since
v0.7.2
var removeQuadAtIndex ( var  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.

Since
v0.7.2
local removeQuadAtIndex ( local  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.

Since
v0.7.2
void removeQuadsAtIndex ( ssize_t  index,
ssize_t  amount 
)

Removes a amount of quads starting from index.

Since
1.1
var removeQuadsAtIndex ( var  index,
var  amount 
)

Removes a amount of quads starting from index.

Since
1.1
local removeQuadsAtIndex ( local  index,
local  amount 
)

Removes a amount of quads starting from index.

Since
1.1
void removeAllQuads ( )

Removes all Quads.

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

Since
v0.7.2
var removeAllQuads ( )

Removes all Quads.

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

Since
v0.7.2
local removeAllQuads ( )

Removes all Quads.

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

Since
v0.7.2
bool resizeCapacity ( ssize_t  capacity)

Resize the capacity of the TextureAtlas.

The new capacity can be lower or higher than the current one. It returns true if the resize was successful. If it fails to resize the capacity it will return false with a new capacity of 0.

Parameters
capacityCapacity for Quads.
var resizeCapacity ( var  capacity)

Resize the capacity of the TextureAtlas.

The new capacity can be lower or higher than the current one. It returns true if the resize was successful. If it fails to resize the capacity it will return false with a new capacity of 0.

Parameters
capacityCapacity for Quads.
local resizeCapacity ( local  capacity)

Resize the capacity of the TextureAtlas.

The new capacity can be lower or higher than the current one. It returns true if the resize was successful. If it fails to resize the capacity it will return false with a new capacity of 0.

Parameters
capacityCapacity for Quads.
void increaseTotalQuadsWith ( ssize_t  amount)

Used internally by ParticleBatchNode.

don't use this unless you know what you're doing.

Since
1.1
var increaseTotalQuadsWith ( var  amount)

Used internally by ParticleBatchNode.

don't use this unless you know what you're doing.

Since
1.1
local increaseTotalQuadsWith ( local  amount)

Used internally by ParticleBatchNode.

don't use this unless you know what you're doing.

Since
1.1
void moveQuadsFromIndex ( ssize_t  oldIndex,
ssize_t  amount,
ssize_t  newIndex 
)

Moves an amount of quads from oldIndex at newIndex.

Since
v1.1
var moveQuadsFromIndex ( var  oldIndex,
var  amount,
var  newIndex 
)

Moves an amount of quads from oldIndex at newIndex.

Since
v1.1
local moveQuadsFromIndex ( local  oldIndex,
local  amount,
local  newIndex 
)

Moves an amount of quads from oldIndex at newIndex.

Since
v1.1
void moveQuadsFromIndex ( ssize_t  index,
ssize_t  newIndex 
)

Moves quads from index till totalQuads to the newIndex.

Used internally by ParticleBatchNode. This method doesn't enlarge the array if newIndex + quads to be moved > capacity.

Since
1.1
var moveQuadsFromIndex ( var  index,
var  newIndex 
)

Moves quads from index till totalQuads to the newIndex.

Used internally by ParticleBatchNode. This method doesn't enlarge the array if newIndex + quads to be moved > capacity.

Since
1.1
local moveQuadsFromIndex ( local  index,
local  newIndex 
)

Moves quads from index till totalQuads to the newIndex.

Used internally by ParticleBatchNode. This method doesn't enlarge the array if newIndex + quads to be moved > capacity.

Since
1.1
void fillWithEmptyQuadsFromIndex ( ssize_t  index,
ssize_t  amount 
)

Ensures that after a realloc quads are still empty.

Used internally by ParticleBatchNode.

Since
1.1
var fillWithEmptyQuadsFromIndex ( var  index,
var  amount 
)

Ensures that after a realloc quads are still empty.

Used internally by ParticleBatchNode.

Since
1.1
local fillWithEmptyQuadsFromIndex ( local  index,
local  amount 
)

Ensures that after a realloc quads are still empty.

Used internally by ParticleBatchNode.

Since
1.1
void drawNumberOfQuads ( ssize_t  n)

Draws n quads.

N can't be greater than the capacity of the Atlas.

var drawNumberOfQuads ( var  n)

Draws n quads.

N can't be greater than the capacity of the Atlas.

local drawNumberOfQuads ( local  n)

Draws n quads.

N can't be greater than the capacity of the Atlas.

void drawNumberOfQuads ( ssize_t  numberOfQuads,
ssize_t  start 
)

Draws n quads from an index (offset).

N + start can't be greater than the capacity of the atlas.

Since
v1.0
var drawNumberOfQuads ( var  numberOfQuads,
var  start 
)

Draws n quads from an index (offset).

N + start can't be greater than the capacity of the atlas.

Since
v1.0
local drawNumberOfQuads ( local  numberOfQuads,
local  start 
)

Draws n quads from an index (offset).

N + start can't be greater than the capacity of the atlas.

Since
v1.0
bool isDirty ( )
inline

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

var isDirty ( )
inline

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

local isDirty ( )
inline

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

void setDirty ( bool  bDirty)
inline

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

var setDirty ( var  bDirty)
inline

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

local setDirty ( local  bDirty)
inline

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

ssize_t getTotalQuads ( ) const

Gets the quantity of quads that are going to be drawn.

var getTotalQuads ( )

Gets the quantity of quads that are going to be drawn.

local getTotalQuads ( )

Gets the quantity of quads that are going to be drawn.

ssize_t getCapacity ( ) const

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

var getCapacity ( )

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

local getCapacity ( )

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

Texture2D* getTexture ( ) const

Gets the texture of the texture atlas.

var getTexture ( )

Gets the texture of the texture atlas.

local getTexture ( )

Gets the texture of the texture atlas.

void setTexture ( Texture2D texture)

Sets the texture for the texture atlas.

var setTexture ( var  texture)

Sets the texture for the texture atlas.

local setTexture ( local  texture)

Sets the texture for the texture atlas.

V3F_C4B_T2F_Quad* getQuads ( )

Gets the quads that are going to be rendered.

var getQuads ( )

Gets the quads that are going to be rendered.

local getQuads ( )

Gets the quads that are going to be rendered.

void setQuads ( V3F_C4B_T2F_Quad quads)

Sets the quads that are going to be rendered.

var setQuads ( var  quads)

Sets the quads that are going to be rendered.

local setQuads ( local  quads)

Sets the quads that are going to be rendered.


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