Back to Node List

SpriteSheet Playback

sprite_sheet_playback

Plays back a spritesheet contract and returns the current frame image

Reviewed
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

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

Overview

Plays a spritesheet for inspection. Given a time or frame number, it extracts and returns the corresponding frame image. Use it for animation playback previews, extracting a particular frame, or starting further processing from a sheet.

Usage tips

  • The basic playback preview is animation_render (or sprite_sheet_pack).spritesheet → playback, and time_source.timetime. Watch the image output to see the animation play.
  • To retrieve a particular frame, enter its number in frame, which takes priority over time. This also supports static tasks such as extracting only frame 4 for processing.
  • With loop enabled, playback wraps and continues even when time leaves the range.

Common pitfalls

  • Trying to connect a raw Image: this node accepts only the SpriteSheet type. Add contract information to an externally loaded sheet image with sprite_sheet_info first.

Related nodes

  • sprite_sheet_pack / animation_render — supply sheets
  • sprite_sheet_info — turn an external image into a sheet input
  • sprite_sheet_frame_get — focused on frame extraction instead of playback
  • time_source — supply playback time

Examples

  1. Connect the spritesheet from KeyframeClip, AnimationRender, SpriteSheetPack, or SpriteSheetInfo.
  2. Connect TimeSource.time to time.
  3. Connect the image output to Preview.

Additional notes:

  • Use the frame input or frame parameter to switch frames by index directly.
  • SpriteSheetPlayback does not accept a raw Image. When starting from an external image, pass it through SpriteSheetInfo first.
  • The node also passes through spritesheet and helper metadata outputs, so it can preserve the playback preview in the Inspector while feeding downstream nodes.

Frame selection rules

  • Indices are zero-based (the second frame is frame = 1). Any frame >= 0 always overrides time.
  • Seconds selects floor(time * FPS). With loop on, positive and negative values wrap by frame count; with loop off, they clamp to the first/last frame.
  • Looping Normalized time uses floor(fract(time) * frame_count), so time = 1.0 returns to the first frame. Non-looping Normalized mode keeps the endpoint mapping from 0 to the first frame and 1 to the last.
Back to Node List
SpriteSheet Playback — PixPipeline Node Reference