ノード一覧に戻る

スプライトシート再生

sprite_sheet_playback

spritesheet 契約を再生し、現在フレームの画像を返します

確認済み
解説あり

入力ポート

名前説明
スプライトシート
spritesheet
SpriteSheet
必須
再生する SpriteSheet ドキュメントです
時間
time
Float
再生位置を決める時間入力です
フレーム
frame
Int
直接フレーム指定です。time より優先されます

出力ポート

名前説明
スプライトシート
spritesheet
SpriteSheet
そのまま流す SpriteSheet ドキュメントです
画像
image
Image
現在フレームの画像です
フレーム
frame
Int
解決後のフレーム番号です
フレーム数
frame_count
Int
正規化後のフレーム数です
FPS
fps
Int
正規化後の FPS です
列数
columns
Int
正規化後の列数です
行数
rows
Int
正規化後の行数です
フレーム幅
frame_width
Int
正規化後のフレーム幅です
フレーム高さ
frame_height
Int
正規化後のフレーム高さです
配置順
fill_order
Text
正規化後の配置順です
概要
summary
Text
再生結果の短い概要です

パラメータ

名前既定値範囲説明・選択肢
時間
time
Float
00–60 / step 0.01

時間のフォールバック値です

時間モード
time_mode
Enum
Normalized

time 入力の解釈方法です

  • 正規化Normalized
    time を 0.0〜1.0 の進行率として扱います
  • Seconds
    time を秒として扱い、FPS からフレームを求めます
フレーム
frame
Int
-1-1–4096

直接フレーム指定です。-1 の時は time を使います

ループ
loop
Bool
true

範囲外に出た時にループさせます

概要

スプライトシートを動かして確認するノードです。時刻またはフレーム番号を 与えると、そのコマの画像を取り出して返します。アニメーションの再生プレビュー、 特定コマの抜き出し、シートを素材とした再加工の起点になります。

使い方のポイント

  • 再生プレビューの基本形: animation_render(や sprite_sheet_pack).spritesheet → playback、time_source.time → time。image 出力を見ればアニメが動く
  • 特定のコマだけ欲しいときは frame に番号を直接指定(time より優先)。 「4コマ目だけ取り出して加工」のような静的な用途にも使える
  • loop オンなら範囲外の時刻でも巻き戻って再生し続ける

よくある失敗

  • raw の Image をつなごうとする: このノードは SpriteSheet 型専用。 外部から読み込んだシート画像は sprite_sheet_info で契約情報を付けてから

関連ノード

  • sprite_sheet_pack / animation_render — シートの供給元
  • sprite_sheet_info — 外部画像をシート化して入り口を作る
  • sprite_sheet_frame_get — 再生ではなくコマ取得に特化した版
  • time_source — 再生時刻の供給

使用例

  1. KeyframeClipAnimationRenderSpriteSheetPack、または SpriteSheetInfospritesheet をつなぐ
  2. TimeSource.timetime へつなぐ
  3. image 出力を Preview につなぐ

補足:

  • frame 入力か frame パラメータを使うと、直接 index 指定でフレームを切り替えられます
  • SpriteSheetPlayback 自体は raw Image を受けません。外部画像から始める場合は SpriteSheetInfo を先に通します
  • spritesheet と helper metadata 出力もそのまま持つので、Inspector では再生 preview を維持したまま downstream へ渡せます

フレーム決定規則

  • indexは0始まりです(2コマ目はframe = 1)。frame >= 0は常にtimeより優先します。
  • Secondsfloor(time * FPS)でコマを決めます。loopオンは負値も含めて frame_countでwrapし、オフは先頭/末尾へclampします。
  • Normalizedのloopオンはfloor(fract(time) * frame_count)です。そのため time = 1.0は先頭へ戻ります。loopオフは従来どおり0〜1へclampし、 0を先頭、1を末尾へ対応させます。
ノード一覧に戻る
スプライトシート再生 — PixPipeline ノード解説