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

FreeBSD Manual Pages

  
 
  

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

NAME
       delete_image - Delete a video object and	associated resources.

SYNOPSIS
       nil
       delete_image( vid )

DESCRIPTION
       This  function deletes vid, any attached	frameservers and linked	images
       without the MASK_LIVING	flag cleared.

NOTES
       1      Trying to	delete a non-existing image is considered  a  terminal
	      state  transition.  The valid_vid	function can be	used as	a last
	      resort to	to determine if	a number maps to a valid vid  or  not,
	      but is in	many cases a sign of bad design.

       2      In  a  LWA  build, deleting WORLDID  is a	terminal state object.
	      On other platforms it results in the default rendertarget	 being
	      dropped.	 This  can  be used to save memory in some cases where
	      rendering	goes strictly through manually defined rendertargets.

       3      If the underlying	object is in an	asynchronous load  state,  the
	      load operation will be completed first.

EXAMPLE
       function	delete_image0()
	     valid = fill_surface(32, 32, 255, 0, 0, 0);
	     delete_image(valid);
       end

MISUSE
       function	delete_image0()
	     delete_image(WORLDID);
       end

MISUSE
       function	delete_image1()
	     delete_image();
       end

MISUSE
       function	delete_image2()
	     delete_image(BADID);
       end

MISUSE
       function	delete_image3()
	     delete_image(-1);
       end

SEE ALSO:
       expire_image(3)

image				  April	2025		       delete_image(3)

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

home | help