書き出し形式を選ぶ

利用先から選ぶ

まず結果を確認するならPNGフレームのZIP、独自のゲーム実装ならスプライトシートと対応するJSON、ゲームエンジンに取り込むならそのエンジン用パックを選び、同梱の説明を読んでください。

Webの書き出し画面は最初にPNGフレームZIPを選びます。一方、ワンステップPublic APIでoutput_formatsを省略すると、既定はspritesheetです。特定のファイルが必要な連携では、形式を明示してください。

形式一覧

メタデータ形式だけでは画像になりません。対応するテクスチャーも取得してください。返却されたoutputsを実際の成果物一覧として扱い、配列の位置や拡張子を決め打ちしないでください。

透過は元素材と形式の両方で決まる

通常のMP4と生成された元動画は不透明です。透明なPNG、アトラス、エンジン素材、WebM Alpha、ProRes 4444には、適切な元素材と書き出し設定が必要です。

Public APIの透過はAlpha Key素材だけをサポートします。任意の背景を自動で除去する機能ではありません。透過アニメーションも参照してください。

ファイルにAlphaがあっても、再生側が無視する場合があります。利用先で確認し、表示側の問題と書き出しの問題を切り分けるにはPNGフレームや対応エディターを使ってください。

エンジン向けパックは構造を保って取り込む

エンジン用ZIPにはanimgen-manifest.jsonと説明が入っています。相対パスを維持してください。Godotの素材はパック内のパスを参照し、Unreal Paper2Dの取り込みには該当するエンジン側ツールが必要です。

マニフェストのフレーム矩形は左上原点、正規化されたピボット座標は左下原点です。テクスチャーの大きさから推測せず、マニフェストを確認してください。ゲーム全体に組み込む前に小さなテストシーンで順番、速度、スケール、ピボット、透過を確かめます。

クレジット、利用権限、ダウンロード

無料のWeb利用にはPNGフレームZIPが含まれます。高度な形式には有料の書き出し権限が必要です。クレジット残高と形式の利用権限は別々に確認されます。クレジットと利用権限をご覧ください。

ファイルは短期間有効な署名付きダウンロードリンクから取得します。URLではなくファイル本体を保存してください。APIからの取得はポーリングとダウンロードを参照してください。

エンジンへの取り込みを完了する

Unity、Godot 4、Unreal Paper2D、Cocos Creator 3の手順へ進んでください。各ガイドは実際のパック内容とパス、再生補助に対応しますが、すべてのエンジンでの実行試験を保証するものではありません。

位置合わせはキャンバスとピボット、透過動画の合成は形式の互換性を参照してください。

Alphaに対応する一般的な三つの書き出し形式は、実測したWebM Alpha、ProRes 4444、PNG連番の比較（英語）で比較できます。2Dゲーム向けには、同じ96フレームのファイル容量、展開後のRGBAサイズ、メタデータ、最大テクスチャー寸法を比べたスプライトシートとPNG連番の比較（英語）もあります。