ノード一覧に戻る

スプライトシート情報

sprite_sheet_info

raw spritesheet 画像と部分的なヒントから SpriteSheet document を正規化します

確認済み
解説あり

入力ポート

名前説明
スプライトシート
spritesheet
Image
必須
情報を正規化する対象のスプライトシート画像です
フレーム数
frame_count
Int
フレーム数のヒントです
FPS
fps
Int
FPS のヒントです
列数
columns
Int
列数のヒントです
行数
rows
Int
行数のヒントです
フレーム幅
frame_width
Int
フレーム幅のヒントです
フレーム高さ
frame_height
Int
フレーム高さのヒントです
配置順
fill_order
Text
配置順のヒントです

出力ポート

名前説明
スプライトシート
spritesheet
SpriteSheet
正規化した SpriteSheet ドキュメントです
フレーム数
frame_count
Int
正規化後のフレーム数です
FPS
fps
Int
正規化後の FPS です
列数
columns
Int
正規化後の列数です
行数
rows
Int
正規化後の行数です
フレーム幅
frame_width
Int
正規化後のフレーム幅です
フレーム高さ
frame_height
Int
正規化後のフレーム高さです
配置順
fill_order
Text
正規化後の配置順です
概要
summary
Text
metadata の短い概要です
警告
warnings
Text
補正されたヒントや未使用画素についての警告です

パラメータ

名前既定値範囲説明・選択肢
フレーム数
frame_count
Int
00–4096

フレーム数ヒントのフォールバック値です

FPS
fps
Int
121–240

FPS ヒントのフォールバック値です

列数
columns
Int
00–512

列数ヒントのフォールバック値です

行数
rows
Int
00–512

行数ヒントのフォールバック値です

フレーム幅
frame_width
Int
00–8192

フレーム幅ヒントのフォールバック値です

フレーム高さ
frame_height
Int
00–8192

フレーム高さヒントのフォールバック値です

配置順
fill_order
Enum
RowMajor

配置順ヒントのフォールバック値です

  • 右へRowMajor
  • 下へColumnMajor

概要

外部から持ち込んだただのシート画像を SpriteSheet 型に変換する入り口の ノードです。「4列4行」「1コマ32×32」のようなヒントを与えると、再生や コマ取得のノードで扱える形に正規化します。

使い方のポイント

  • 他ツールで作ったシートをPixPipelineで再生・分解したい時の最初の1個: image_load → sprite_sheet_info → sprite_sheet_playback
  • ヒントは分かるものだけでよい(例: columns=4 だけ)。画像サイズから残りを 推定して補完する。ただし推定に頼るより frame_width/height を明示する方が確実
  • fps もここで設定でき、下流の再生速度の既定値になる

よくある失敗

  • ヒントなしで多コマシートをつなぐ: 情報ゼロだと「1枚画像」として保守的に 解釈される。最低でも columns か frame_width は与える
  • frame_width / frame_heightが画像より大きい: 抽出不能なmetadataを作らず、 どのヒントが画像寸法を超えたかNodeErrorで知らせる
  • ヒント同士が矛盾する/割り切れない: 実際に使えるgridへ正規化し、変更された frame_count・columns・rowsと右端/下端の未使用画素をwarningsへ出す

関連ノード

  • sprite_sheet_playback / sprite_sheet_frame_get — 正規化後の利用先
  • sprite_sheet_pack — アプリ内で作る場合のシート生成
  • image_load — 外部シート画像の読み込み

使用例

  1. 外部から持ち込んだ spritesheet 画像を spritesheet へつなぐ
  2. 分かっている情報だけを columnsframe_width などへ入れる
  3. 出力された SpriteSheetSpriteSheetPlaybackSpriteSheetFrameGet へ流す

補足:

  • SpriteSheetInfo は raw Image から SpriteSheet へ入るための adapter です
  • 情報が完全でなくても、画像サイズと接続済みヒントから可能な範囲で補います
  • 何もヒントが無い場合は、まず 1 枚画像として扱う保守的な解釈になります
  • summaryは解決結果、warningsは入力ヒントから補正された点を確認するために使います
ノード一覧に戻る