Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
order_image(3)			  Arcan Lua API 		  order_image(3)

NAME
     order_image - Alter the drawing order of the specified image.

SYNOPSIS
     nil
     order_image( vid or tblvid, newzv )

DESCRIPTION
     Every  object has an order property that determines when it should be drawn
     in respect to other ones. This value can be  changed  by  calling	the  or-
     der_image function on a video object or a table of video objects. The newzv
     should  be  within the range 0 <= n < 65535 and will be clamped. The execp-
     tion to this is objects that are linked to others and have their order  be-
     ing relative to its parent, where negative values are permitted but will be
     resolved to a value within the specified range.

NOTES
     1	    This  only	applies  to the active owner of an image, for images at-
	    tached to multiple rendertarget, such changes won't take place until
	    you forcibly attach/detach for each specified rendertarget.

     2	    Order can also be relative to the world- order of the resolved  par-
	    ent, see image_inherit_order.

EXAMPLE
     function order_image0()
	   a = color_surface(32, 32, 255, 0, 0);
	   b = color_surface(32, 32, 0, 255, 0);
	   move_image(b, 16, 16);
	   show_image({a, b});
	   order_image(a, 2);
     end

MISUSE
     function order_image0()
	   a = color_surface(32, 32, 255, 0, 0);
	   order_image(a, -1);
     end

SEE ALSO:
     image_inherit_order(3) max_current_image_order(3)

image				   August 2026			  order_image(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=order_image&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help