Object Class Reference

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

#include <Object.h>

Inherited by AnimationCurve< 3 >, AnimationCurve< 4 >, ActionManager, Animation, Animation3D, AnimationCurve< componentSize >, AnimationFrame, , Bone3D, CameraBackgroundBrush, Collider2D, Event, EventDispatcher, EventListener, GridBase, , Image, Material, Mesh, MeshIndexData, MeshSkin, MeshVertexData, Node, , PhysicsWorld3D, PointArray, RenderState, RenderTexturePass, RenderViewCore, Scheduler, ScriptHandlerEntry, Skeleton3D, SpriteFrame, TMXObjectGroup, TMXTileAnimManager, TMXTileAnimTask, Technique, Texture2D, TextureAtlas, TextureCache, TextureCube, VertexInputBinding, , Buffer, ComputePipeline, DepthStencilState, GraphicsContext, GraphicsPipeline, Program, ProgramState, RenderTarget, ShaderModule, and Texture.

Public Member Functions
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Object *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Object's current reference count.
uint64_t	getObjectID () const noexcept
	Returns the process-local diagnostic identifier assigned at construction.
virtual	~Object ()
	Destructor.

Detailed Description

Object is used for reference count management.

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

Constructor & Destructor Documentation

~Object()

virtual ~Object ( )

virtual

Destructor.

@lua NA

Member Function Documentation

retain()

void retain

(

)

Retains the ownership.

This increases the Object's reference count.

See also

release, autorelease

release()

void release

(

)

Releases the ownership immediately.

This decrements the Object's reference count.

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

See also

retain, autorelease

autorelease()

Object * autorelease

(

)

Releases the ownership sometime soon automatically.

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

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

Returns

The Object itself.

See also

AutoreleasePool, retain, release @lua NA

getReferenceCount()

unsigned int getReferenceCount

(

)

const

Returns the Object's current reference count.

Returns

The Object's reference count.

getObjectID()

uint64_t getObjectID ( ) const

inlinenoexcept

Returns the process-local diagnostic identifier assigned at construction.

This value is for logging and debugging only. It is not an object identity key and must not be used for ownership, lifetime, or scripting registries.

---

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

• Object.h