Ref Class Reference

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

Inherited by Acceleration, Action, ActionManager, Animation, Animation3D, AnimationCache, AnimationCurve< componentSize >, AnimationFrame, Bone3D, BundleReader, CameraBackgroundBrush, Configuration, Director, Event, EventDispatcher, EventListener, AudioEngineImpl, FrameBuffer, RenderTargetBase, GLProgram, GLProgramCache, GLProgramState, GLView, Grabber, GridBase, GroupCommandManager, 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, MinXmlHttpRequest, and SimpleRunLoop.

Public Member Functions
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
local	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	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...

Public Attributes
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

Ref is used for reference count management.

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

Constructor & Destructor Documentation

virtual ~Ref ( )

virtual

Destructor.

Member Function Documentation

void retain

(

)

Retains the ownership.

This increases the Ref's reference count.

See also

release, autorelease

local retain

(

)

Retains the ownership.

This increases the Ref's reference count.

See also

release, autorelease

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

local 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

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

unsigned int getReferenceCount

(

)

const

Returns the Ref's current reference count.

Returns

The Ref's reference count.

local getReferenceCount

(

)

Returns the Ref's current reference count.

Returns

The Ref's reference count.

---

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

• CCRef.h