Yotsuba Games
Back to Node List

SpriteSheet Frame Get

sprite_sheet_frame_get

Extracts a single frame from a spritesheet contract

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 ăƒ‰ă‚­ăƒ„ăƒĄăƒłăƒˆă§ă™
ă‚€ăƒłăƒ‡ăƒƒă‚Żă‚č
index
Int
æŠœăć‡șă™ăƒ•ăƒŹăƒŒăƒ ç•Șć·ă§ă™

Output Ports

NameTypeDescription
ç”»ćƒ
image
Image
æŠœăć‡șă—ăŸăƒ•ăƒŹăƒŒăƒ ç”»ćƒă§ă™
ă‚€ăƒłăƒ‡ăƒƒă‚Żă‚č
index
Int
è§Łæ±șćŸŒăźăƒ•ăƒŹăƒŒăƒ ç•Șć·ă§ă™
抂芁
summary
Text
抜ć‡șç”æžœăźçŸ­ă„æŠ‚èŠă§ă™

Parameters

NameTypeDefaultRangeDescription / Options
ă‚€ăƒłăƒ‡ăƒƒă‚Żă‚č
index
Int
00–4096

æŠœăć‡șă™ăƒ•ăƒŹăƒŒăƒ ç•Șć·ă§ă™

Overview

Extracts one frame at a specified index from a spritesheet. Unlike playback with sprite_sheet_playback, it has no concept of time; it simply returns the Nth image. Use it to process, compare, or export a particular frame.

Usage tips

  • Its main use is static extraction, such as using only the second frame of a walk animation as an icon, or selecting one frame to recolor.
  • Connect index to int_input for manual selection, or combine it with list processing to process every frame in a batch.
  • Out-of-range indices are clamped to the first or last frame and do not cause an error.
  • index is zero-based: the first frame is 0 and the second is 1.

Related nodes

  • sprite_sheet_playback — time-based playback
  • sprite_sheet_info — entry point for an external sheet image
  • sprite_sheet_pack — reverse operation, from an image list to a sheet

Examples

  1. Connect the spritesheet from KeyframeClip, AnimationRender, SpriteSheetPack, or SpriteSheetInfo.
  2. Feed index from IntInput or the result of ListGet.
  3. Pass the image output to other image nodes.

Additional notes:

  • An out-of-range index is clamped to the first or last frame.
  • The frame 2/N text in summary is one-based for people; the index output remains zero-based.
  • SpriteSheetFrameGet does not accept a raw Image. When starting from an external image, pass it through SpriteSheetInfo first.
Back to Node List
SpriteSheet Frame Get — PixPipeline Node Reference