【Unity】GIFをサポートするようにできる「UniGif」というライブラリの使い方

はじめに

今回はGIFをサポートできるようにするUniGifというライブラリについて取り上げたいと思います。

GIF image decoder for Unity.
Decode a GIF file at run time to get the texture list.
Supports GIF87a or GIF89a format. (Animation, transparency, interlace, etc)
This is made with Unity 5.4.0f3 (Mac, Win, Android, iOS).

// DeepL翻訳
Unity 用の GIF 画像デコーダです。
GIFファイルをランタイムにデコードしてテクスチャリストを取得します。
GIF87aまたはGIF89a形式をサポートします。(アニメーション、透明度、インターレースなど)
Unity 5.4.0f3 (Mac, Win, Android, iOS)で作成しています。

github.com

ただ最初に言っておくと、パフォーマンス的な面ではmgGifやUnity-GifDecoderの方が良いです。
www.hanachiru-blog.com
www.hanachiru-blog.com

はじめに
導入方法
使い方
- サンプルコードを利用する場合
コード上での利用方法

導入方法

unitypackageやPackage Managerに対応してはいなさそうなので、GitHubからダウンロードしてUniGif-master/Assets/UniGifを自身のプロジェクトにインポートします。

github.com

使い方

サンプルコードを利用する場合

公式のサンプルコードとしてUniGifImage.csがあるので、まずはそれの利用方法を書きます。

RawImageコンポーネントがアタッチされているゲームオブジェクト作成
UniGifImageコンポーネントをアタッチ
UniGifImageAspectControllerコンポーネントをアタッチ
UniGifImageコンポーネントのRawImageとImg Aspect Ctrlを設定する
Load On Start Urlに表示したいGifの「StreamingAssets以下の相対パス」か「WEBのURL」を指定する

UniGifImageのプロパティについては以下の通り。

プロパティ	意味
RawImage	対象の`RawImage`
Img Aspect Ctrl	利用する`Image Aspect Controller`
Filter Mode	`Texture`の`filter mode`
Wrap Mode	`Texture`の`Wrap Mode`
Load On Start	`Start`のタイミングで`Url`から`Gif`をロードするかどうか
Load On Start Url	ロードする`Gif`の`URL` (`WEB` or `StreamingAssets`からの相対パス)
Rotate On Loading	ロード中に`RawImage`を回転させるかどうか(使う場面がかなり限定的なような...)
Output Debug Log	`Debug.Log`を出力するかどうか

またUniGifImageAspectControllerコンポーネントの値はGifをロードした後に自動で設定されるので、自身で設定しなくて大丈夫です。

コード上での利用方法

サンプルコードを利用せずに自分でコードを書く場合について書きます。

public class Sample : MonoBehaviour
{
    [SerializeField] private RawImage rawImage;
    
    private IEnumerator Start()
    {
        // StreamingAssetsからデータをロードする
        var path = Path.Combine(Application.streamingAssetsPath, "sample.gif");
        var file = File.ReadAllBytes(path);

        // コールバックにて、Gifから「Texture2Dと間隔(s)のList」に変換したものを利用する
        yield return StartCoroutine(UniGif.GetTextureListCoroutine(file, (gifTexList, loopCount, width, height) =>
        {
            if (gifTexList != null)
            {
                // Texture2D
                rawImage.texture = gifTexList[0].m_texture2d;
                
                // 間隔(s)
                Debug.Log(gifTexList[0].m_delaySec);
                
                // ループする回数
                Debug.Log(loopCount);
                
                // 画像のwidth, height
                Debug.Log($"width : {width}, height : {height}");
            }
        }));
    }
}