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

FreeBSD Manual Pages

  
 
  

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

NAME
       image_active_frame  -  Set  the	active (displayed) frame for an	object
       with an allocated frameset.

SYNOPSIS
       nil
       image_active_frame( vid,	index )

DESCRIPTION
NOTES
       1      if the frameset index exceeds the	capacity of  the  frameset  in
	      question,	whatever is in the first index (0) will	be replaced.

       2      the  behavior  when  mixing objects with different storage types
	      (textured, nullsurface or	colorsurface) is undefined.

       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 mul-
	      tiple  video  objects.  The last one is round-robin storage from
	      frameservers where you need access to previous frames.

EXAMPLE
       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:
       set_image_as_frame(3) image_framesetsize(3) image_framecyclemode(3)

image				  April	2025		 image_active_frame(3)

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

home | help