image_active_frame(3)

📦
version 0.7.1 · 2 versions
, in nixos 26.05

🌸 NAME 🌸

okay bestie, welcome to image_active_frame(3) — that's the page, and the manual is the Arcan Lua API. This function is here to set the active (displayed) frame for an object with an allocated frameset. that's the whole assignment. 💅

✨ SYNOPSIS ✨

the synopsis is literally serving this exact energy:

nil
image_active_frame( vid, index )

so yes, nil is right there at the top, and the call takes vid and index. no extra lore in this part, bestie. 🫶

🎀 DESCRIPTION 🎀

this section is blank in the original page — no cap, the actual tea is all under NOTES. I'm not gonna invent extra behavior, because that would be messy and we don't do messy technical claims. 🙈

💅 NOTES 💅

  1. if the frameset index exceeds the capacity of the frameset in question, whatever is in the first index (0) will be replaced. yes, replaced. pay attention to your indexing, bestie. 🔥
  2. the behavior when mixing objects with different storage types (textured, nullsurface or colorsurface) is undefined. that's the dramatic warning, okay? undefined behavior is not a vibe. 💀
  3. there are three principal use-cases for the frameset-class of functions. the first one is the more obvious, static animations (combine with the appropriate framecyclemode). the second one is multitexturing where you want shaders that sample data from multiple video objects. the last one is round-robin storage from frameservers where you need access to previous frames. iconic range, honestly. 🌈

🧚 EXAMPLE 🧚

here's the example exactly as the page gives it — no edits, no remix, just the code:

function image_active_frame0()
      a = fill_surface(320, 200, 0, 0, 0);
      show_image(a);
      b = fill_surface(32, 32, 255, 0, 0);
      move_image(b, 320, 200);
      c = fill_surface(32, 32, 0, 255, 0);
      move_image(c, 352, 232);
      image_framesetsize(a, 3, FRAMESET_SPLIT);
      set_image_as_frame(a, b, 1, FRAMESET_DETACH);
      set_image_as_frame(a, c, 2, FRAMESET_NODETACH);
      image_active_frame(a, 1);
end

👑 SEE ALSO 👑

that's the whole page, bestie. signing off from the image source, October 2026 version/date energy, page image_active_frame(3). bye and slay responsibly 🫶💖

📦 where this page comes from