Back to Node List

SpriteSheet Playback

sprite_sheet_playback

Plays back a spritesheet contract and returns the current frame image

Draft
Guide available
The node name and summary are available in English. Port, parameter, and article details are currently shown in Japanese.

Input Ports

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

Output Ports

NameTypeDescription
スプライトシート
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
再生結果の短い概要です

Parameters

NameTypeDefaultRangeDescription / Options
時間
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

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

使用例

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

補足:

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