RefCounted

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.RefCounted
Namespace	Electron2D
Kind	class
Category	Core

Overview

Represents the ref counted type.

Syntax

public class Electron2D.RefCounted : Electron2D.Object

Remarks

This type is part of the Electron2D 0.1.0 Preview public API.

Thread Safety

Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
Electron2D.RefCounted()	Constructor	Initializes a new instance of the RefCounted type.
GetReferenceCount()	Method	Gets the reference count value.
Reference()	Method	Executes the reference operation.
Unreference()	Method	Executes the unreference operation.

Member Details

Electron2D.RefCounted()

Kind: Constructor

public Electron2D.RefCounted()

Summary

Initializes a new instance of the RefCounted type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.RefCounted

GetReferenceCount()

Kind: Method

public System.Int32 GetReferenceCount()()

Summary

Gets the reference count value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The current reference count value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.RefCounted

Reference()

Kind: Method

public System.Boolean Reference()()

Summary

Executes the reference operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.RefCounted

Unreference()

Kind: Method

public System.Boolean Unreference()()

Summary

Executes the unreference operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.RefCounted