image_tracetag(3)

πŸ“¦
version 0.7.1 Β· 2 versions
, in nixos 26.05

πŸŽ€ image_tracetag πŸŽ€

okay bestie, welcome to the Arcan Lua API page for image_tracetag β€” yes she's a C-library-adjacent Lua function and yes she's lowkey iconic πŸ’…


✨ NAME ✨

image_tracetag β€” set or retrieve a tracing tag for the specified video object. that's the whole vibe 🫢


🌸 SYNOPSIS 🌸

string:tag, string:alt
image_tracetag( vid )
image_tracetag( vid, string:tag )
image_tracetag( vid, string:tag, string:alt )
image_tracetag( vid, string:tag=nil, string:alt )

like, pick your fighter β€” there's a signature for every mood πŸ’–


πŸ¦‹ DESCRIPTION πŸ¦‹

so the way this works: this function is used to associate user defined strings to a video object. two flavors, two purposes, both slay:

  • the tag form is used to define a tracetag that can be used to assist with debugging, or as ephemeral storage for persisting data across _reset calls πŸ”₯
  • the alt form is alt-text, to mark that the video object is useful for assistive devices such as screen-readers β€” accessibility is main character energy, no cap β™Ώβœ¨

and here's the cute little detail: if no tag is provided but an alt tag is, the existing tag will be preserved while also updating the alt-text. like she's not gonna throw away your tag just because you only asked about the alt πŸ₯Ί

if no tag or alt is provided, the currently set value will be returned, periodt.

πŸ™ˆ if there is no tag set, the returned string will be '(no tag)' and the alt text will be empty. not a bug, just her being honest.

πŸ’œ EXAMPLE πŸ’œ

function image_tracetag0()
      a = color_surface(32, 32, 255, 0, 0);
      image_tracetag(a, "test");
      print(image_tracetag(a));
end

look at her go β€” make a red surface, tag it "test", print it back. chef's kiss πŸ‘‘ literally the simplest little demo and it ate 🌈


okay that's the whole page bestie, go forth and tag your video objects responsibly πŸ§šπŸ’«

<thedate>tiny sign-off:</thedate> this page came from the debug corner of the world and it's dated October 2026 β€” image_tracetag(3), everybody, she's done πŸ“πŸ’€

πŸ“¦ where this page comes from