クラス ImageAsset

画像アセットクラス [詳細]

すべてのメンバ一覧

Public メソッド

 ImageAsset (string filename, bool asyncLoad)
 指定した画像ファイルから新しいインスタンスを生成する
 ImageAsset (string filename)
 指定した画像ファイルから新しいインスタンスを生成する
 ImageAsset (SystemImageAsset name)
 指定したシステム画像アセットの新しいインスタンスを生成する
 ImageAsset (Texture2D texture)
 指定した既存のテクスチャから新しいインスタンスを生成する
 ImageAsset (Image image, PixelFormat format)
 指定した既存のイメージから新しいインスタンスを生成する
 ImageAsset (Image image)
 指定した既存のイメージから新しいインスタンスを生成する
 ImageAsset (string filename, bool asyncLoad, bool scaledPixelDensity)
 指定した画像ファイルから新しいインスタンスを生成する
 ImageAsset (Texture2D texture, bool scaledPixelDensity)
 指定した既存のテクスチャから新しいインスタンスを生成する
 ImageAsset (Image image, PixelFormat format, bool scaledPixelDensity)
 指定した既存のイメージから新しいインスタンスを生成する
 ImageAsset (Image image, bool scaledPixelDensity)
 指定した既存のイメージから新しいインスタンスを生成する
Texture2D CloneTexture ()
 テクスチャの複製を取得
void WaitForLoad ()
 ファイルが読み込まれるまで待機する
void Dispose ()
 使用されているリソースを解放する
bool UnloadFromCache ()
 画像ファイルから読み込んだImageAssetのキャッシュを削除する

Static Public メソッド

static void WaitForLoadAll ()
 非同期で読み込んでいるすべての画像が読み込まれるまで待機する
static bool UnloadFromCache (string filename)
 ファイルから読み込んだImageAssetのキャッシュを削除する

プロパティ

bool Ready [get]
 画像アセットの読み込みが完了したかどうかを取得する
int Width [get]
 画像アセットの幅を取得する
int Height [get]
 画像アセットの高さを取得する
string FilePath [get]
 画像ファイルのパスを取得する

説明

画像アセットクラス

テクスチャの読み込みなどを隠蔽するクラスです。 画像ファイルの非同期の読み込みやキャッシュをサポートします。 画像ファイルから ImageAsset を作成した場合は、テクスチャがキャッシュされます。 このキャッシュにより、同一ファイル名の ImageAsset を作成した場合、テクスチャのアンマネージドリソースは共有されます。 なお、キャッシュは Dispose やガーベージコレクションだけでは解放されません。 使用しなくなった ImageAsset は UnloadFromCache を呼び出したあと、同一画像ファイルのImageAssetすべての Dispose を呼び出してください。


コンストラクタとデストラクタ

ImageAsset ( string  filename,
bool  asyncLoad 
)

指定した画像ファイルから新しいインスタンスを生成する

一度読み込むとキャッシュされます。使用しなくなった場合は UnloadFromCache を呼び出してください。

引数:
filename画像ファイル名
asyncLoad非同期で読み込むかどうか
ImageAsset ( string  filename)

指定した画像ファイルから新しいインスタンスを生成する

同期で読み込みます。一度読み込むとキャッシュされます。使用しなくなった場合は UnloadFromCache を呼び出してください。

引数:
filename画像ファイル名

指定したシステム画像アセットの新しいインスタンスを生成する

標準のウィジェットなどに使用される画像アセットです。非同期で読み込みます。

引数:
nameシステム画像アセット
ImageAsset ( Texture2D  texture)

指定した既存のテクスチャから新しいインスタンスを生成する

キャッシュはされません。ImageAsset内ではテクスチャの ShallowClone を保持するため、引数で指定したテクスチャのインスタンスは必要に応じて Dispose してください。

引数:
textureテクスチャ
ImageAsset ( Image  image,
PixelFormat  format 
)

指定した既存のイメージから新しいインスタンスを生成する

キャッシュはされません。引数で指定したイメージのインスタンスは必要に応じて Dispose してください。

引数:
image既存の画像
format指定した既存の画像のピクセルフォーマット
ImageAsset ( Image  image)

指定した既存のイメージから新しいインスタンスを生成する

キャッシュはされません。引数で指定したイメージのインスタンスは必要に応じて Dispose してください。

引数:
image既存の画像
ImageAsset ( string  filename,
bool  asyncLoad,
bool  scaledPixelDensity 
)

指定した画像ファイルから新しいインスタンスを生成する

一度読み込むとキャッシュされます。使用しなくなった場合は UnloadFromCache を呼び出してください。

引数:
filename画像ファイル名
asyncLoad非同期で読み込むかどうか
scaledPixelDensityピクセル密度に応じてスケールするかどうか
ImageAsset ( Texture2D  texture,
bool  scaledPixelDensity 
)

指定した既存のテクスチャから新しいインスタンスを生成する

キャッシュはされません。ImageAsset内ではテクスチャの ShallowClone を保持するため、引数で指定したテクスチャのインスタンスは必要に応じて Dispose してください。

引数:
textureテクスチャ
scaledPixelDensityピクセル密度に応じてスケールするかどうか
ImageAsset ( Image  image,
PixelFormat  format,
bool  scaledPixelDensity 
)

指定した既存のイメージから新しいインスタンスを生成する

キャッシュはされません。引数で指定したイメージのインスタンスは必要に応じて Dispose してください。

引数:
image既存の画像
format指定した既存の画像のピクセルフォーマット
scaledPixelDensityピクセル密度に応じてスケールするかどうか
ImageAsset ( Image  image,
bool  scaledPixelDensity 
)

指定した既存のイメージから新しいインスタンスを生成する

キャッシュはされません。引数で指定したイメージのインスタンスは必要に応じて Dispose してください。

引数:
image既存の画像
scaledPixelDensityピクセル密度に応じてスケールするかどうか

メソッド

Texture2D CloneTexture ( )

テクスチャの複製を取得

テクスチャのShallowCloneを返します。非同期読み込みで、まだテクスチャの読み込みが完了していない場合はnullを返します。

void Dispose ( )

使用されているリソースを解放する

このインスタンスが保持しているテクスチャの Dispose を呼びます。 画像ファイルから読み込んだImageAssetの場合、キャッシュされているテクスチャは解放されません。 完全に解放するためには UnloadFromCache を呼び出す必要があります。

bool UnloadFromCache ( )

画像ファイルから読み込んだImageAssetのキャッシュを削除する

キャッシュされているテクスチャを解放します。 キャッシュ内のテクスチャのみ解放されるので、このインスタンスは引き続き使用することができます。 対象のテクスチャのアンマネージドリソースをガーベージコレクションを待たずに解放するには、Dispose を呼ぶ必要があります。

戻り値:
false:キャッシュに存在していなかった
static bool UnloadFromCache ( string  filename) [static]

ファイルから読み込んだImageAssetのキャッシュを削除する

引数:
filenameファイル名
戻り値:
false:キャッシュに存在していなかった
void WaitForLoad ( )

ファイルが読み込まれるまで待機する

同期で読み込んだ場合やすでに読み込みが完了している場合はすぐに戻ります。


プロパティ

string FilePath [get]

画像ファイルのパスを取得する

ファイルから生成していない場合は null が返ります。

int Height [get]

画像アセットの高さを取得する

非同期読み込みでまだ読み込まれていない場合は0を返します。

bool Ready [get]

画像アセットの読み込みが完了したかどうかを取得する

画像ファイル以外や同期で読み込んだ場合は true が返ります。

int Width [get]

画像アセットの幅を取得する

非同期読み込みでまだ読み込まれていない場合は0を返します