Cocos2d-x  v3.15
Ref Class Reference

Ref is used for reference count management. More...

Inheritance diagram for Ref:
Acceleration Action ActionManager Animation Animation3D AnimationCache AnimationCurve< componentSize > AnimationFrame Bone3D BundleReader CameraBackgroundBrush Configuration Director Event EventDispatcher EventListener GLProgram GLProgramCache GLProgramState GLView Grabber GridBase IndexBuffer LuaStack Mesh MeshIndexData MeshSkin MeshVertexData HttpRequest HttpResponse SIOClient Node PhysicsShape PointArray Primitive RenderState RenderState::StateBlock Scheduler ScriptHandlerEntry Skeleton3D SpriteFrame SpriteFrameCache Texture2D TextureAtlas TextureCache TMXObjectGroup Touch LayoutManager LayoutParameter RichElement VertexAttribBinding VertexBuffer VertexData

Public Member Functions

void retain ()
 Retains the ownership. More...
 
void 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...
 
virtual ~Ref ()
 Destructor. More...
 

Public Attributes

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

Detailed Description

Ref is used for reference count management.

If a class inherits from Ref, then it is easy to be shared in different places. NA

Constructor & Destructor Documentation

◆ ~Ref()

virtual ~Ref ( )
virtual

Destructor.

NA NA

Member Function Documentation

◆ retain()

void retain ( )

Retains the ownership.

This increases the Ref's reference count.

See also
release, autorelease NA

◆ release()

void release ( )

Releases the ownership immediately.

This decrements the Ref's reference count.

If the reference count reaches 0 after the decrement, this Ref is destructed.

See also
retain, autorelease NA

◆ autorelease()

Ref* autorelease ( )

Releases the ownership sometime soon automatically.

This decrements the Ref's reference count at the end of current autorelease pool block.

If the reference count reaches 0 after the decrement, this Ref is destructed.

Returns
The Ref itself.
See also
AutoreleasePool, retain, release NA NA

◆ getReferenceCount()

unsigned int getReferenceCount ( ) const

Returns the Ref's current reference count.

Returns
The Ref's reference count. NA

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