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

FreeBSD Manual Pages

  
 
  

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

NAME
       reset_image_transform - Drop all	ongoing	transformations.

SYNOPSIS
       left_blend, left_move, left_rotate, left_scale
       reset_image_transform( vid )
       reset_image_transform( vid:id, int:mask )

DESCRIPTION
       At times	there may be queued events that	should be cancelled out	due to
       unforeseen changes. This	is especially typical when transformations are
       initated	 as part as some input or client event handler,	like pushing a
       button to move a	cursor indicating a selected item or invoking  a  key-
       binding that triggers new animations.

       To prevent these	from stacking up, reset_image_transformation can first
       be  called  to flush the	queue, and the return values are the number of
       ticks left to the next item in the chain	before flushing. These	values
       could then be used to schedule the new transform	and make sure that the
       total  would  take 'as long' time as the	previously scheduled one would
       have been.

       If a mask is provided, only the specific	transforms are reset. The mask
       values (	MASK_POSITION ,	MASK_ORIENTATION , MASK_SCALE ,	MASK_OPACITY )
       can be bit.or:ed	together. This is  helpful  when  you  have  different
       parts  of  a  codebase  responsible for different transforms and	do not
       want them to interfere with each	other.

NOTES
       1      this will	not revert the object back to a	 previous  state,  but
	      rather  stop  at	whatever part of the chain was currently being
	      processed.

EXAMPLE
       function	reset_image_transform0()
	     a = fill_surface(20, 20, 255, 0, 0);
	     show_image(a);
	     move_image(a, 100,	100, 10);
	     clock_c = 5;
       end
       function	main_clock_pulse()
	     if	(clock_c > 0) then
		   clock_c = clock_c - 1;
		   if (clock_c == 0) then
			 reset_image_transform(a);
		   end
	     end
       end

SEE ALSO:
       instant_image_transform(3)

image				  April	2025	      reset_image_transform(3)

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

home | help