NAME

image_tracetag - Set or retrieve a tracing tag for the specified video object.

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 )

DESCRIPTION

This function is used to associate user defined strings to a video object. 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. If no tag is provided but an alt tag is, the existing tag will be preserved while also updating the alt-text.

If no tag or alt is provided, the currently set value will be returned. If there is no tag set, the returned string will be '(no tag)' and the alt text will be empty.

EXAMPLE

function image_tracetag0()


      a = color_surface(32, 32, 255, 0, 0);


      image_tracetag(a, "test");


      print(image_tracetag(a));
end