RID

Handle for a Resource's unique ID.

Description

The RID Variant type is used to access a low-level resource by its unique ID. RIDs are opaque, which means they do not grant access to the resource by themselves. They are used by the low-level server classes, such as DisplayServer, RenderingServer, TextServer, etc.

A low-level resource may correspond to a high-level Resource, such as Texture or Mesh.

Constructors

RID

RID ( )

RID

RID ( RID from )

Methods

int

get_id ( ) const

bool

is_valid ( ) const

Operators

bool

operator != ( RID right )

bool

operator < ( RID right )

bool

operator <= ( RID right )

bool

operator == ( RID right )

bool

operator > ( RID right )

bool

operator >= ( RID right )


Constructor Descriptions

RID RID ( )

Constructs an empty RID with the invalid ID 0.


RID RID ( RID from )

Constructs a RID as a copy of the given RID.


Method Descriptions

int get_id ( ) const

Returns the ID of the referenced low-level resource.


bool is_valid ( ) const

Returns true if the RID is not 0.


Operator Descriptions

bool operator != ( RID right )

Returns true if the RIDs are not equal.


bool operator < ( RID right )

Returns true if the RID's ID is less than right's ID.


bool operator <= ( RID right )

Returns true if the RID's ID is less than or equal to right's ID.


bool operator == ( RID right )

Returns true if both RIDs are equal, which means they both refer to the same low-level resource.


bool operator > ( RID right )

Returns true if the RID's ID is greater than right's ID.


bool operator >= ( RID right )

Returns true if the RID's ID is greater than or equal to right's ID.