1/**************************************************************************/
2/* rid.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef RID_H
32#define RID_H
33
34#include "core/typedefs.h"
35
36class RID_AllocBase;
37
38class RID {
39 friend class RID_AllocBase;
40 uint64_t _id = 0;
41
42public:
43 _ALWAYS_INLINE_ bool operator==(const RID &p_rid) const {
44 return _id == p_rid._id;
45 }
46 _ALWAYS_INLINE_ bool operator<(const RID &p_rid) const {
47 return _id < p_rid._id;
48 }
49 _ALWAYS_INLINE_ bool operator<=(const RID &p_rid) const {
50 return _id <= p_rid._id;
51 }
52 _ALWAYS_INLINE_ bool operator>(const RID &p_rid) const {
53 return _id > p_rid._id;
54 }
55 _ALWAYS_INLINE_ bool operator>=(const RID &p_rid) const {
56 return _id >= p_rid._id;
57 }
58 _ALWAYS_INLINE_ bool operator!=(const RID &p_rid) const {
59 return _id != p_rid._id;
60 }
61 _ALWAYS_INLINE_ bool is_valid() const { return _id != 0; }
62 _ALWAYS_INLINE_ bool is_null() const { return _id == 0; }
63
64 _ALWAYS_INLINE_ uint32_t get_local_index() const { return _id & 0xFFFFFFFF; }
65
66 static _ALWAYS_INLINE_ RID from_uint64(uint64_t p_id) {
67 RID _rid;
68 _rid._id = p_id;
69 return _rid;
70 }
71 _ALWAYS_INLINE_ uint64_t get_id() const { return _id; }
72
73 _ALWAYS_INLINE_ RID() {}
74};
75
76#endif // RID_H
77