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

A pool for managing autorelease objects. More...

Public Member Functions

 AutoreleasePool ()
 AutoreleasePool (const std::string &name)
 Create an autorelease pool with specific name. More...
 
void addObject (Ref *object)
 Add a given object to this autorelease pool. More...
 
void clear ()
 Clear the autorelease pool. More...
 
bool contains (Ref *object) const
 Checks whether the autorelease pool contains the specified object. More...
 
void dump ()
 Dump the objects that are put into the autorelease pool. More...
 

Detailed Description

A pool for managing autorelease objects.

Constructor & Destructor Documentation

Warning
Don't create an autorelease pool in heap, create it in stack.
AutoreleasePool ( const std::string &  name)

Create an autorelease pool with specific name.

This name is useful for debugging.

Warning
Don't create an autorelease pool in heap, create it in stack.

@

Member Function Documentation

void addObject ( Ref object)

Add a given object to this autorelease pool.

The same object may be added several times to an autorelease pool. When the pool is destructed, the object's Ref::release() method will be called the same times as it was added.

Parameters
objectThe object to be added into the autorelease pool.
void clear ( )

Clear the autorelease pool.

It will invoke each element's release() function.

bool contains ( Ref object) const

Checks whether the autorelease pool contains the specified object.

Parameters
objectThe object to be checked.
Returns
True if the autorelease pool contains the object, false if not
void dump ( )

Dump the objects that are put into the autorelease pool.

It is used for debugging.

The result will look like: Object pointer address object id reference count


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