This page was machine-translated. Spotted a mistake?Help improve it.
Skip to content

Sprite Sheet

複数の画像を1枚のスプライトシートグリッドに結合します。各画像は最初の画像の寸法に合わせてリサイズされ、グリッドに配置されます。フレームごとの座標メタデータとともにスプライトシート画像を返します。

API Endpoint

POST /api/v1/tools/image/sprite-sheet

2枚以上の画像ファイルとJSON形式のsettingsフィールドを含むmultipartフォームデータを受け付けます。

Parameters

ParameterTypeRequiredDefaultDescription
columnsintegerNo4グリッドの列数(1〜16)
paddingintegerNo0セル間の余白(ピクセル、0〜64)
backgroundstringNo"#ffffff"背景の16進カラー
formatstringNo"png"出力フォーマット: png, webp, またはjpeg
qualityintegerNo90出力品質(1〜100)

Example Request

bash
curl -X POST http://localhost:1349/api/v1/tools/image/sprite-sheet \
  -H "Authorization: Bearer si_your-api-key" \
  -F "[email protected]" \
  -F "[email protected]" \
  -F "[email protected]" \
  -F "[email protected]" \
  -F 'settings={"columns": 2, "padding": 4, "format": "png"}'

Example Response

json
{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/sprite-sheet.png",
  "originalSize": 120000,
  "processedSize": 95000,
  "frames": [
    { "index": 0, "left": 0, "top": 0, "width": 128, "height": 128 },
    { "index": 1, "left": 132, "top": 0, "width": 128, "height": 128 },
    { "index": 2, "left": 0, "top": 132, "width": 128, "height": 128 },
    { "index": 3, "left": 132, "top": 132, "width": 128, "height": 128 }
  ],
  "cols": 2,
  "rows": 2,
  "cellWidth": 128,
  "cellHeight": 128,
  "canvasWidth": 260,
  "canvasHeight": 260
}

Notes

  • 2〜64枚の画像を受け付けます。すべての画像は、最初にアップロードした画像の寸法に合わせてリサイズされます。
  • frames配列は、出力内の各フレームの正確なピクセル座標を提供し、CSSスプライト定義やゲームエンジンのフレームマップに利用できます。
  • 行数は、画像数とcolumnsの値から自動的に計算されます。
  • セル間に間隔を設けるにはpaddingパラメータを使用します。backgroundの色は、余白領域や末尾の空セルに表示されます。
  • HEIC、RAW、PSD、SVGの入力は処理前に自動的にデコードされます。