ramses::resourceId_t Struct Reference

Resource identifier used to refer to a resource. More...

#include <RamsesFrameworkTypes.h>

Public Member Functions
constexpr	resourceId_t ()
	Default constructor initialized to Invalid. More...
constexpr	resourceId_t (uint64_t low, uint64_t high)
	Construct with low and high part. More...
constexpr bool	isValid () const
	Check if resource is valid. More...
constexpr bool	operator== (const resourceId_t &other) const
	Equal compare operator. More...
constexpr bool	operator!= (const resourceId_t &other) const
	Unequal compare operator. More...

Static Public Member Functions
static constexpr resourceId_t	Invalid ()
	Create invalid resource Id. More...

Public Attributes
uint64_t	lowPart
	Low bits. More...
uint64_t	highPart
	High bits. More...

Detailed Description

Resource identifier used to refer to a resource.

Constructor & Destructor Documentation

resourceId_t() [1/2]

constexpr ramses::resourceId_t::resourceId_t ( )

inlineconstexpr

Default constructor initialized to Invalid.

resourceId_t() [2/2]

constexpr ramses::resourceId_t::resourceId_t ( uint64_t  low, uint64_t  high  )

inlineconstexpr

Construct with low and high part.

Parameters

low	low part of resource id
high	high part of resource id

Member Function Documentation

Invalid()

static constexpr resourceId_t ramses::resourceId_t::Invalid ( )

inlinestaticconstexpr

Create invalid resource Id.

Returns

Invalid resource id

isValid()

constexpr bool ramses::resourceId_t::isValid ( ) const

inlineconstexpr

Check if resource is valid.

Returns

true when resource id has a valid value, false otherwise

operator!=()

constexpr bool ramses::resourceId_t::operator!= ( const resourceId_t &  other ) const

inlineconstexpr

Unequal compare operator.

Parameters

[in]

other

resourceId to compare to

Returns

true of resourceId is not the same as other resourceId

operator==()

constexpr bool ramses::resourceId_t::operator== ( const resourceId_t &  other ) const

inlineconstexpr

Equal compare operator.

Parameters

[in]

other

resourceId to compare to

Returns

true of resourceId is the same as other resourceId

Member Data Documentation

highPart

uint64_t ramses::resourceId_t::highPart

High bits.

lowPart

uint64_t ramses::resourceId_t::lowPart

Low bits.

---

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

• /home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/RamsesFrameworkTypes.h