ezEngine  Release 25.03
ezUuid Class Reference

This data type is the abstraction for 128-bit Uuid (also known as GUID) instances. More...

#include <Uuid.h>

Public Member Functions

 EZ_DECLARE_POD_TYPE ()
 
EZ_ALWAYS_INLINE ezUuid ()=default
 Default constructor. Constructed Uuid will be invalid.
 
constexpr EZ_ALWAYS_INLINE ezUuid (ezUInt64 uiLow, ezUInt64 uiHigh)
 Constructs the Uuid from existing values.
 
EZ_ALWAYS_INLINE bool operator== (const ezUuid &other) const
 Comparison operator. [tested].
 
EZ_ALWAYS_INLINE bool operator!= (const ezUuid &other) const
 Comparison operator. [tested].
 
EZ_ALWAYS_INLINE bool operator< (const ezUuid &other) const
 Comparison operator.
 
EZ_ALWAYS_INLINE bool IsValid () const
 Returns true if this is a valid Uuid.
 
void GetValues (ezUInt64 &ref_uiLow, ezUInt64 &ref_uiHigh) const
 Returns the internal 128 Bit of data.
 
EZ_ALWAYS_INLINE void CombineWithSeed (const ezUuid &seed)
 Adds the given seed value to this guid, creating a new guid. The process is reversible.
 
EZ_ALWAYS_INLINE void RevertCombinationWithSeed (const ezUuid &seed)
 Subtracts the given seed from this guid, restoring the original guid.
 
EZ_ALWAYS_INLINE void HashCombine (const ezUuid &hash)
 Combines two guids using hashing, irreversible and order dependent.
 

Static Public Member Functions

static EZ_ALWAYS_INLINE ezUuid MakeInvalid ()
 Returns an invalid UUID.
 
static ezUuid MakeUuid ()
 Returns a new Uuid.
 
static ezUuid MakeStableUuidFromString (ezStringView sString)
 Creates a uuid from a string. The result is always the same for the same string.
 
static ezUuid MakeStableUuidFromInt (ezInt64 iInt)
 Creates a uuid from an integer. The result is always the same for the same input.
 

Friends

EZ_FOUNDATION_DLL_FRIEND void operator>> (ezStreamReader &inout_stream, ezUuid &ref_value)
 Operator to serialize ezUuid objects. [tested].
 
EZ_FOUNDATION_DLL_FRIEND void operator<< (ezStreamWriter &inout_stream, const ezUuid &value)
 Operator to serialize ezUuid objects. [tested].
 

Detailed Description

This data type is the abstraction for 128-bit Uuid (also known as GUID) instances.


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