image_surface_properties(3)

📦
version 0.7.1 · 2 versions
, in nixos 26.05

💖 image_surface_properties(3) 💖

okay so bestie, this one lives in the Arcan Lua API family and honestly? it's a little legend. let me put you on. ✨

🌸 NAME 🌸

image_surface_properties — literally retrieves the current properties of the object you point at. that's it. that's the whole vibe check. 🎀

🦋 SYNOPSIS 🦋

proptbl
image_surface_properties( vid, dt )

✨ DESCRIPTION ✨

so every object out here is lowkey carrying a whole bunch of attributes around with it. and some of those attributes — the ones that directly influence rendering and that you can mod through transformations (move, rotate, scale, ...) — can actually shift over time. main character attributes, fr fr. 👑

this function is your girl for pulling either:

  • the current state of those attributes rn, or
  • what that state would be at a future point in time — just hand it the dt argument and it'll resolve it for you. 🔥

iykyk.

💅 NOTES 💅

  1. the fields hanging out inside proptbl are: (x, y, z, width, height, angle, roll, pitch, yaw, opacity and order). that's the whole squad. 🫶
  2. the values you get back are expressed in local (object) coordinate space — like, the object's own little world, not the global one. ngl, super important detail. 💜

🌈 EXAMPLE 🌈

function image_surface_properties0()
      a = fill_surface(32, 32, 255, 0, 0);
      show_image(a);
      move_image(a, 100, 100, 100);
      cprops = image_surface_properties(a);
      fprops = image_surface_properties(a, 50);
      print(string.format("now(x,y): %d, %d -- later(x,y): %d, %d",
            cprops.x, cprops.y, fprops.x, fprops.y));
end

look at her go 😭 one call for now, one call with 50 for later, and the print shows you both. iconic. ⭐

🧚 SEE ALSO 🧚

okay that's the whole page bestie — go forth and query those properties 💖

mwah 💋 this one's from the image manual, October 2026 edition — dated and versioned and slaying, periodt. 🌸💅

📦 where this page comes from