MGL テクスチャクラス [詳解]

#include <mgl_texture.h>

公開メンバ関数
constexpr	Texture () noexcept
	コンストラクタ

	Texture (SharedTextureResource resource) noexcept
	コンストラクタ

	Texture (TextureKey key) noexcept
	コンストラクタ（取得のみ）

	Texture (TextureKey key, const File::PathView &imagePath, bool isAsync, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	コンストラクタ（ファイルから読み込み）

	Texture (TextureKey key, const void *imageData, size_t dataSize, bool isAsync, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	コンストラクタ（メモリから読み込み）

	Texture (const File::PathView &imagePath, bool isAsync, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	コンストラクタ（ファイルから読み込み）

	Texture (const void *imageData, size_t dataSize, bool isAsync, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	コンストラクタ（メモリから読み込み）

bool	Load (TextureKey key) noexcept
	テクスチャをテクスチャストレージから読み込み

bool	Load (TextureKey key, const File::PathView &imagePath, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	テクスチャをファイルから読み込み

bool	LoadAsync (TextureKey key, const File::PathView &imagePath, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	テクスチャをファイルから非同期で読み込み

bool	Load (TextureKey key, const void *imageData, size_t dataSize, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	テクスチャをメモリから読み込み

bool	LoadAsync (TextureKey key, const void *imageData, size_t dataSize, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	テクスチャをメモリから非同期で読み込み

bool	Load (const File::PathView &imagePath, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	テクスチャをファイルから読み込み

bool	LoadAsync (const File::PathView &imagePath, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	テクスチャをファイルから非同期で読み込み

bool	Load (const void *imageData, size_t dataSize, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	テクスチャをメモリから読み込み

bool	LoadAsync (const void *imageData, size_t dataSize, TextureLoaderKey loaderKey=TextureStorage::kDefaultLoaderKey) noexcept
	テクスチャをメモリから非同期で読み込み

bool	Create (TextureKey key, const void *pixelData, PixelFormat pixelFormat, uint32_t width, uint32_t height) noexcept
	テクスチャをピクセルデータから生成

bool	Create (const void *pixelData, PixelFormat pixelFormat, uint32_t width, uint32_t height) noexcept
	テクスチャをピクセルデータから生成

bool	CreateRenderTarget (TextureKey key, uint32_t width, uint32_t height) noexcept
	レンダーターゲットの生成

bool	CreateRenderTarget (uint32_t width, uint32_t height) noexcept
	レンダーターゲットの生成

SharedTextureResource	GetResource () const noexcept
	テクスチャリソースの取得

bool	IsValid () const noexcept
	テクスチャが有効かを取得

bool	IsLoading () const noexcept
	テクスチャが読み込み中かを取得

	operator bool () const noexcept
	bool型にキャストした際にテクスチャの有効状態を取得

bool	operator! () const noexcept
	有効状態を否定演算子で取得

Vector2	GetSize () const noexcept
	テクスチャのサイズを取得

bool	Destroy () noexcept
	テクスチャリソースを破棄

静的公開メンバ関数
static bool	Destroy (TextureKey key) noexcept
	テクスチャリソースを破棄

template<class LoaderClass , class... Args>
static constexpr bool	RegisterLoader (TextureLoaderKey loaderKey, Args... args) noexcept
	テクスチャローダー登録用テンプレート

static void	SetDefaultLoader (TextureLoaderKey loaderKey) noexcept
	デフォルトのテクスチャローダーを設定

詳解

MGL テクスチャクラス

構築子と解体子

◆ Texture() [1/6]

MGL::Render::Texture::Texture ( SharedTextureResource resource )

noexcept

コンストラクタ

引数

[in] resource テクスチャリソース

◆ Texture() [2/6]

MGL::Render::Texture::Texture ( TextureKey key )

noexcept

コンストラクタ（取得のみ）

引数

[in] key テクスチャキー

◆ Texture() [3/6]

MGL::Render::Texture::Texture	(	TextureKey	key,
		const File::PathView &	imagePath,
		bool	isAsync,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

コンストラクタ（ファイルから読み込み）

引数

[in]	key	テクスチャキー
[in]	imagePath	読み込むファイルのパス
[in]	isAsync	非同期読み込みフラグ
[in]	loaderKey	テクスチャローダーのキー

◆ Texture() [4/6]

MGL::Render::Texture::Texture	(	TextureKey	key,
		const void *	imageData,
		size_t	dataSize,
		bool	isAsync,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

コンストラクタ（メモリから読み込み）

引数

[in]	key	テクスチャキー
[in]	imageData	読み込むデータのアドレス
[in]	dataSize	読み込むデータのサイズ
[in]	isAsync	非同期読み込みフラグ
[in]	loaderKey	テクスチャローダーのキー

◆ Texture() [5/6]

MGL::Render::Texture::Texture	(	const File::PathView &	imagePath,
		bool	isAsync,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

コンストラクタ（ファイルから読み込み）

引数

[in]	imagePath	読み込むファイルのパス
[in]	isAsync	非同期読み込みフラグ
[in]	loaderKey	テクスチャローダーのキー

◆ Texture() [6/6]

MGL::Render::Texture::Texture	(	const void *	imageData,
		size_t	dataSize,
		bool	isAsync,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

コンストラクタ（メモリから読み込み）

引数

[in]	imageData	読み込むデータのアドレス
[in]	dataSize	読み込むデータのサイズ
[in]	isAsync	非同期読み込みフラグ
[in]	loaderKey	テクスチャローダーのキー

関数詳解

◆ Create() [1/2]

bool MGL::Render::Texture::Create	(	const void *	pixelData,
		PixelFormat	pixelFormat,
		uint32_t	width,
		uint32_t	height )

noexcept

テクスチャをピクセルデータから生成

引数

[in]	pixelData	ピクセルデータ
[in]	pixelFormat	ピクセルデータのフォーマット
[in]	width	幅
[in]	height	高さ

戻り値

true	成功
false	失敗

◆ Create() [2/2]

bool MGL::Render::Texture::Create	(	TextureKey	key,
		const void *	pixelData,
		PixelFormat	pixelFormat,
		uint32_t	width,
		uint32_t	height )

noexcept

テクスチャをピクセルデータから生成

引数

[in]	key	テクスチャキー
[in]	pixelData	ピクセルデータ
[in]	pixelFormat	ピクセルデータのフォーマット
[in]	width	幅
[in]	height	高さ

戻り値

true	成功
false	失敗

◆ CreateRenderTarget() [1/2]

bool MGL::Render::Texture::CreateRenderTarget	(	TextureKey	key,
		uint32_t	width,
		uint32_t	height )

noexcept

レンダーターゲットの生成

引数

[in]	key	テクスチャキー
[in]	width	幅
[in]	height	高さ

戻り値

true	成功
false	失敗

◆ CreateRenderTarget() [2/2]

bool MGL::Render::Texture::CreateRenderTarget	(	uint32_t	width,
		uint32_t	height )

noexcept

レンダーターゲットの生成

引数

[in]	width	幅
[in]	height	高さ

戻り値

true	成功
false	失敗

◆ Destroy() [1/2]

bool MGL::Render::Texture::Destroy ( )

inlinenoexcept

テクスチャリソースを破棄

戻り値

true	成功
false	失敗

◆ Destroy() [2/2]

static bool MGL::Render::Texture::Destroy ( TextureKey key )

inlinestaticnoexcept

テクスチャリソースを破棄

引数

[in] key 破棄するテクスチャリソースのキー

戻り値

true	成功
false	失敗

◆ GetResource()

SharedTextureResource MGL::Render::Texture::GetResource ( ) const

nodiscardnoexcept

テクスチャリソースの取得

戻り値: テクスチャリソース

◆ GetSize()

Vector2 MGL::Render::Texture::GetSize ( ) const

nodiscardnoexcept

テクスチャのサイズを取得

戻り値: テクスチャのサイズ

◆ IsLoading()

bool MGL::Render::Texture::IsLoading ( ) const

nodiscardnoexcept

テクスチャが読み込み中かを取得

戻り値

true	読み込み中
false	読み込み中でない

◆ IsValid()

bool MGL::Render::Texture::IsValid ( ) const

nodiscardnoexcept

テクスチャが有効かを取得

戻り値

true	有効
false	無効

◆ Load() [1/5]

bool MGL::Render::Texture::Load	(	const File::PathView &	imagePath,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

テクスチャをファイルから読み込み

引数

[in]	imagePath	画像ファイルのパス
[in]	loaderKey	テクスチャローダーのキー

戻り値

true	成功
false	失敗

◆ Load() [2/5]

bool MGL::Render::Texture::Load	(	const void *	imageData,
		size_t	dataSize,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

テクスチャをメモリから読み込み

引数

[in]	imageData	読み込むデータのアドレス
[in]	dataSize	読み込むデータのサイズ
[in]	loaderKey	テクスチャローダーのキー

戻り値

true	成功
false	失敗

◆ Load() [3/5]

bool MGL::Render::Texture::Load ( TextureKey key )

noexcept

テクスチャをテクスチャストレージから読み込み

引数

[in] key テクスチャキー

戻り値

true	キーに対応したテクスチャが見つかった
false	キーに対応したテクスチャが見つからなかった

◆ Load() [4/5]

bool MGL::Render::Texture::Load	(	TextureKey	key,
		const File::PathView &	imagePath,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

テクスチャをファイルから読み込み

引数

[in]	key	テクスチャキー
[in]	imagePath	画像ファイルのパス
[in]	loaderKey	テクスチャローダーのキー

戻り値

true	成功
false	失敗

◆ Load() [5/5]

bool MGL::Render::Texture::Load	(	TextureKey	key,
		const void *	imageData,
		size_t	dataSize,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

テクスチャをメモリから読み込み

引数

[in]	key	テクスチャキー
[in]	imageData	読み込むデータのアドレス
[in]	dataSize	読み込むデータのサイズ
[in]	loaderKey	テクスチャローダーのキー

戻り値

true	成功
false	失敗

◆ LoadAsync() [1/4]

bool MGL::Render::Texture::LoadAsync	(	const File::PathView &	imagePath,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

テクスチャをファイルから非同期で読み込み

引数

[in]	imagePath	画像ファイルのパス
[in]	loaderKey	テクスチャローダーのキー

戻り値

true	成功
false	失敗

覚え書き: 非同期読み込みの場合は常にtrueが返るため，正常に読み込めたかどうかは IsLoading()とIsValid()で確認する．

◆ LoadAsync() [2/4]

bool MGL::Render::Texture::LoadAsync	(	const void *	imageData,
		size_t	dataSize,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

テクスチャをメモリから非同期で読み込み

引数

[in]	imageData	読み込むデータのアドレス
[in]	dataSize	読み込むデータのサイズ
[in]	loaderKey	テクスチャローダーのキー

戻り値

true	成功
false	失敗

覚え書き: 非同期読み込みの場合は常にtrueが返るため，正常に読み込めたかどうかは IsLoading()とIsValid()で確認する．

◆ LoadAsync() [3/4]

bool MGL::Render::Texture::LoadAsync	(	TextureKey	key,
		const File::PathView &	imagePath,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

テクスチャをファイルから非同期で読み込み

引数

[in]	key	テクスチャキー
[in]	imagePath	画像ファイルのパス
[in]	loaderKey	テクスチャローダーのキー

戻り値

true	成功
false	失敗

覚え書き: 非同期読み込みの場合は常にtrueが返るため，正常に読み込めたかどうかは IsLoading()とIsValid()で確認する．

◆ LoadAsync() [4/4]

bool MGL::Render::Texture::LoadAsync	(	TextureKey	key,
		const void *	imageData,
		size_t	dataSize,
		TextureLoaderKey	loaderKey = TextureStorage::kDefaultLoaderKey )

noexcept

テクスチャをメモリから非同期で読み込み

引数

[in]	key	テクスチャキー
[in]	imageData	読み込むデータのアドレス
[in]	dataSize	読み込むデータのサイズ
[in]	loaderKey	テクスチャローダーのキー

戻り値

true	成功
false	失敗

覚え書き: 非同期読み込みの場合は常にtrueが返るため，正常に読み込めたかどうかは IsLoading()とIsValid()で確認する．

◆ operator bool()

MGL::Render::Texture::operator bool ( ) const

inlineexplicitnoexcept

bool型にキャストした際にテクスチャの有効状態を取得

戻り値

true	有効
false	無効

◆ operator!()

bool MGL::Render::Texture::operator! ( ) const

inlinenoexcept

有効状態を否定演算子で取得

戻り値

true	無効
false	有効

◆ RegisterLoader()

template<class LoaderClass , class... Args>

static constexpr bool MGL::Render::Texture::RegisterLoader	(	TextureLoaderKey	loaderKey,
		Args...	args )

inlinestaticconstexprnoexcept

テクスチャローダー登録用テンプレート

テンプレート引数

LoaderClass 登録するテクスチャローダーのクラス

引数

[in]	loaderKey	登録するテクスチャローダーのキー
[in]	args	コンストラクタに渡す引数

戻り値

true	成功
false	失敗

◆ SetDefaultLoader()

static void MGL::Render::Texture::SetDefaultLoader ( TextureLoaderKey loaderKey )

inlinestaticnoexcept

デフォルトのテクスチャローダーを設定

引数

[in] loaderKey 設定するローダーキー

このクラス詳解は次のファイルから抽出されました:

/Users/acerola/x/mgl/include/mgl/render/mgl_texture.h
/Users/acerola/x/mgl/src/render/mgl_texture.cc

公開メンバ関数

静的公開メンバ関数

詳解

構築子と解体子

◆ Texture() [1/6]

◆ Texture() [2/6]

◆ Texture() [3/6]

◆ Texture() [4/6]

◆ Texture() [5/6]

◆ Texture() [6/6]

関数詳解

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateRenderTarget() [1/2]

◆ CreateRenderTarget() [2/2]

◆ Destroy() [1/2]

◆ Destroy() [2/2]

◆ GetResource()

◆ GetSize()

◆ IsLoading()

◆ IsValid()

◆ Load() [1/5]

◆ Load() [2/5]

◆ Load() [3/5]

◆ Load() [4/5]

◆ Load() [5/5]

◆ LoadAsync() [1/4]

◆ LoadAsync() [2/4]

◆ LoadAsync() [3/4]

◆ LoadAsync() [4/4]

◆ operator bool()

◆ operator!()

◆ RegisterLoader()

◆ SetDefaultLoader()