Back to Node List

Batch Export

batch_export

Writes a list of images (or a single image) to PNG files using a name pattern

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
画像リスト
images
List<Image>
書き出す画像リストです(Batch Render の frames など)
画像
image
Image
1枚だけ書き出す時の画像入力です(リスト未接続時に使用)
名前リスト
names
List<Text>
{name} トークンに使う名前リストです(Batch Render の names など)

Output Ports

NameTypeDescription
画像
image
Image
先頭の元画像を元サイズのまま流します。拡大率は保存ファイルだけに適用されます。
保存数
count
Int
今回の評価で保存したファイル数です
入力総数
total
Int
未保存分も含め、処理対象として受け取った元画像の総数です。

Parameters

NameTypeDefaultRangeDescription / Options
保存フォルダ
directory
DirectoryPath

保存先フォルダです。空値は画像書き出し先設定(保存済みプロジェクトでは exports/images)で初期化され、相対パスはプロジェクトのフォルダを基準に解決されます。

名前パターン
name_pattern
Text
export_{index}

ファイル名のパターンです。{name}(名前リスト)、{index}(0始まり)、{index1}(1始まり)が使えます。.png は自動で付きます

保存モード
save_mode
Enum
Disabled

どの条件で実際に保存するかを切り替えます。誤書き込み防止のため既定は無効です

  • 無効Disabled
    ファイルへ書き込みません。
  • 新規のみCreateIfMissing
    無いファイルだけ保存します。
  • 上書きOverwrite
    既存ファイルも上書き保存します。
拡大率
scale
Int
11–16

保存前に適用する整数倍のニアレスト拡大です

Overview

The standard node for exporting PNG files. It accepts either one image or a list and saves them according to a naming pattern ({name}/{index}). This is an "exit" for the graph, and headless execution (--headless) also exports through this node and the other Export nodes.

  • Side effect: yes (writes files and is excluded from parallel evaluation)

This is the unified batch export node introduced in P15. Connect frames / names from Batch Render to export all variants at once. The export profile (destination, naming pattern, save mode, and scale) is stored as this node's parameters and saved with the project.

Usage tips

  • Keep save_mode: Disabled (the default) while building the graph, then switch it to Overwrite only when exporting. This is a safe habit because the side-effect node runs on every evaluation.
  • Prefer a relative destination path. It resolves from the project folder and creates folders automatically. For an unsaved project, the default is projects/exports/images/.
  • The golden batch-production pairing is batch_render.frames → images + batch_render.names → names + name_pattern: {name}. Each variant name becomes its filename.
  • To export larger assets for a game engine, use scale (integer nearest-neighbor scaling). It changes only the saved files; the image output remains the first native-size image before export, so the graph can continue at native size.

Common pitfalls

  • No files are written: in most cases, either 1) save_mode is still Disabled or
    1. directory is empty. Check the count output to see how many images were saved this time.
  • Old files remain: CreateIfMissing skips existing files and is intended for appending only missing results. Use Overwrite to rebuild everything.
  • Headless execution fails with "no export node": --require-export requires an enabled export node (anything other than Disabled). The standard approach is to override save_mode with Overwrite in the job's overrides.

Technical details

  • It writes nothing while save_mode: Disabled is selected or directory is unset.
  • Characters that cannot be used in filenames are replaced with _ in values from the name list.
  • CreateIfMissing skips existing files, which is useful when appending only missing outputs.

Examples

Exporting Batch Render results

[Seed Range] → [Batch Render] ─ frames → [Batch Export]
                        └ names ─────────↑

With name_pattern: {name}, each variant name becomes the filename.

Automatic export for the finished image

Connect the graph's final result to the image input and set save_mode: Overwrite to save the latest PNG on every evaluation. Use this node as the export endpoint for headless execution (--headless) as well.

Related nodes

  • batch_render — supplies batch-produced frames (the golden pairing)
  • surface_export / aseprite_export / tiled_tileset_export — format-specific exports
  • palette_save — exports a palette
  • preview — when you only want to inspect the result without saving
Back to Node List
Batch Export — PixPipeline Node Reference