Back to Node List

SpriteSheet Pack

sprite_sheet_pack

Packs List<Image> into a SpriteSheet document

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
フレーム一覧
frames
List<Image>
Required
スプライトシートへ詰める List<Image> です
FPS
fps
Int
FPS を上書きするオプション入力です
列数
columns
Int
列数を上書きするオプション入力です
配置順
fill_order
Text
配置順を上書きするオプション入力です

Output Ports

NameTypeDescription
スプライトシート
spritesheet
SpriteSheet
作成した SpriteSheet ドキュメントです
フレーム数
frame_count
Int
作成したフレーム数です
FPS
fps
Int
出力 FPS です
列数
columns
Int
解決後の列数です
行数
rows
Int
解決後の行数です
フレーム幅
frame_width
Int
1フレームの幅です
フレーム高さ
frame_height
Int
1フレームの高さです
配置順
fill_order
Text
解決後の配置順です
概要
summary
Text
作成結果の短い概要です

Parameters

NameTypeDefaultRangeDescription / Options
FPS
fps
Int
00–240

FPS のフォールバック値です (0 = プロジェクト既定に従う)

列数
columns
Int
00–512

0 の時は自動でほぼ正方形に近い配置を選びます

配置順
fill_order
Enum
RowMajor

フレームを詰める時の配置順です

  • 右へRowMajor
  • 下へColumnMajor

Overview

Arranges multiple images into one spritesheet. It combines lists of frame images made as variants or prepared individually into a grid sheet usable by a game engine.

Usage tips

  • The input is List<Image>. Connect an output list from a variant node such as variant_range, or frames bundled with list_create.
  • With the default columns=0, the node automatically selects a nearly square grid. To meet an engine requirement for one horizontal row, set columns to the number of frames.
  • Use animation_render when building a sheet from animation time. This node is for cases where you already have an image list.

Common pitfalls

  • Frames have different sizes: every frame must have the same dimensions. Normalize them beforehand with canvas_resize or a similar node.

Related nodes

  • animation_render — the other entry point, generating a time-based sheet
  • sprite_sheet_playback / sprite_sheet_frame_get — inspect or use the generated sheet
  • list_create / variant_range — supply frame lists
  • batch_export — export the sheet to a file

Examples

  1. Create a List<Image> with ListCreate or another node.
  2. Connect it to SpriteSheetPack.frames.
  3. Set columns and fill_order if needed.
  4. Connect spritesheet to SpriteSheetPlayback or SpriteSheetFrameGet.

Additional notes:

  • Every frame must have the same dimensions.
  • With columns = 0, the node automatically chooses a nearly square arrangement.
  • fill_order = row_major fills from the top left toward the right, while column_major fills from the top left downward.
  • Helper metadata outputs remain available when downstream nodes need only the frame count or grid information.
Back to Node List
SpriteSheet Pack — PixPipeline Node Reference