Back to Node List

SpriteSheet Pack

sprite_sheet_pack

Packs List<Image> into a SpriteSheet document

Draft

Guide available

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

Input Ports

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

Output Ports

Name	Type	Description
スプライトシート 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

Name Type Default Range Description / Options

FPS

fps

Int

12

1–240

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

列数

columns

Int

0

0–512

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

配置順

fill_order

Enum

RowMajor

—

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

右へRowMajor
下へColumnMajor

使用例

ListCreate などで List<Image> を作る
SpriteSheetPack.frames へつなぐ
必要なら columns と fill_order を決める
spritesheet を SpriteSheetPlayback や SpriteSheetFrameGet へつなぐ

補足:

全フレームは同じサイズである必要があります
columns = 0 の時は自動でほぼ正方形に近い配置を選びます
fill_order = row_major は左上から右へ、column_major は左上から下へ並べます
helper metadata 出力も残るので、後段で frame 数や grid 情報だけを参照したい時にも使えます

Back to Node List

SpriteSheet Pack — PixPipeline Node Reference