OpenSiv3D  v0.6.5
C++20 framework for creative coding
s3d::AssetID< AssetTag > Class Template Reference

アセット ID を表現する型 More...

#include <AssetID.hpp>

Public Types

using value_type = size_t
 アセット ID に使う整数型 More...
 

Public Member Functions

SIV3D_NODISCARD_CXX20 AssetID ()=default
 デフォルトコンストラクタ More...
 
constexpr SIV3D_NODISCARD_CXX20 AssetID (value_type id) noexcept
 指定した数値でアセット ID を作成します。 More...
 
constexpr bool operator== (const AssetID &other) const noexcept
 
constexpr bool operator!= (const AssetID &other) const noexcept
 
constexpr bool operator< (const AssetID &other) const noexcept
 
constexpr bool operator<= (const AssetID &other) const noexcept
 
constexpr bool operator> (const AssetID &other) const noexcept
 
constexpr bool operator>= (const AssetID &other) const noexcept
 
constexpr value_type value () const noexcept
 アセット ID の数値を返します。 More...
 
constexpr bool isNull () const noexcept
 アセット ID が Null であるかを返します。 More...
 
constexpr bool isInvalid () const noexcept
 アセット ID が Invalid であるかを返します。 More...
 

Static Public Member Functions

static constexpr AssetID NullAsset () noexcept
 Null アセット ID を作成します。 More...
 
static constexpr AssetID InvalidValue () noexcept
 Invalid アセット ID を作成します。 More...
 

Static Public Attributes

static constexpr value_type NullID = 0
 Null アセットに使うアセット ID. More...
 
static constexpr value_type InvalidID = Largest<value_type>
 Invalid アセットに使うアセット ID. More...
 

Detailed Description

template<class AssetTag>
class s3d::AssetID< AssetTag >

アセット ID を表現する型

Template Parameters
AssetTagアセットタグ

Member Typedef Documentation

◆ value_type

template<class AssetTag >
using s3d::AssetID< AssetTag >::value_type = size_t

アセット ID に使う整数型

Constructor & Destructor Documentation

◆ AssetID() [1/2]

template<class AssetTag >
SIV3D_NODISCARD_CXX20 s3d::AssetID< AssetTag >::AssetID ( )
default

デフォルトコンストラクタ

◆ AssetID() [2/2]

template<class AssetTag >
constexpr SIV3D_NODISCARD_CXX20 s3d::AssetID< AssetTag >::AssetID ( value_type  id)
explicitconstexprnoexcept

指定した数値でアセット ID を作成します。

Parameters
idアセット ID に使う数値

Member Function Documentation

◆ InvalidValue()

template<class AssetTag >
static constexpr AssetID s3d::AssetID< AssetTag >::InvalidValue ( )
staticconstexprnoexcept

Invalid アセット ID を作成します。

Returns
Invalid アセット ID

◆ isInvalid()

template<class AssetTag >
constexpr bool s3d::AssetID< AssetTag >::isInvalid ( ) const
constexprnoexcept

アセット ID が Invalid であるかを返します。

Returns
アセット ID が Invalid である場合 true, それ以外の場合は false

◆ isNull()

template<class AssetTag >
constexpr bool s3d::AssetID< AssetTag >::isNull ( ) const
constexprnoexcept

アセット ID が Null であるかを返します。

Returns
アセット ID が Null である場合 true, それ以外の場合は false

◆ NullAsset()

template<class AssetTag >
static constexpr AssetID s3d::AssetID< AssetTag >::NullAsset ( )
staticconstexprnoexcept

Null アセット ID を作成します。

Returns
Null アセット ID

◆ operator!=()

template<class AssetTag >
constexpr bool s3d::AssetID< AssetTag >::operator!= ( const AssetID< AssetTag > &  other) const
constexprnoexcept

◆ operator<()

template<class AssetTag >
constexpr bool s3d::AssetID< AssetTag >::operator< ( const AssetID< AssetTag > &  other) const
constexprnoexcept

◆ operator<=()

template<class AssetTag >
constexpr bool s3d::AssetID< AssetTag >::operator<= ( const AssetID< AssetTag > &  other) const
constexprnoexcept

◆ operator==()

template<class AssetTag >
constexpr bool s3d::AssetID< AssetTag >::operator== ( const AssetID< AssetTag > &  other) const
constexprnoexcept

◆ operator>()

template<class AssetTag >
constexpr bool s3d::AssetID< AssetTag >::operator> ( const AssetID< AssetTag > &  other) const
constexprnoexcept

◆ operator>=()

template<class AssetTag >
constexpr bool s3d::AssetID< AssetTag >::operator>= ( const AssetID< AssetTag > &  other) const
constexprnoexcept

◆ value()

template<class AssetTag >
constexpr value_type s3d::AssetID< AssetTag >::value ( ) const
constexprnoexcept

アセット ID の数値を返します。

Returns
アセット ID の数値

Member Data Documentation

◆ InvalidID

template<class AssetTag >
constexpr value_type s3d::AssetID< AssetTag >::InvalidID = Largest<value_type>
staticconstexpr

Invalid アセットに使うアセット ID.

◆ NullID

template<class AssetTag >
constexpr value_type s3d::AssetID< AssetTag >::NullID = 0
staticconstexpr

Null アセットに使うアセット ID.


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