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

FreeBSD Manual Pages

  
 
  

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

NAME
       define_arcantarget - Create a rendertarget bound	subsegment for drawing
       to another arcan	instance

SYNOPSIS
       bool
       define_arcantarget(  vid:vstore,	  string:type,	 vidtbl:vpipe,	 func-
       tion:handler )

DESCRIPTION
       This function is	used to	request	and bind 'subsegments' useful for sec-
       ondary outputs.

       It works	like any other	normal	rendertarget  such  as	one  allocated
       through	define_rendertarget , but the clocking and updates are explic-
       itly tied to what the arcan instance the	segment	is  connected  to  de-
       cides.

       The design and inner workings for this function is marked as experimen-
       tal and may be subject to breaking changes without notice.

NOTES
       1      Valid types are: 'cursor', 'popup', 'icon', 'clipboard', 'title-
	      bar',

       2      An  invalid vstore or unsupported	type is	a terminal state tran-
	      sition.

EXAMPLE
       function	define_arcantarget0()
	     local ok =
		   define_arcantarget(buffer, "media", {test},
		   function(source, status)
			 if status.kind	== "terminated"	then
			       delete_image(source)
			 end
			 print(status.kind)
		   end
	     )
	     if	not ok then
		   delete_image(buffer)
	     end
       end
       end

SEE ALSO:
targetcontrol			  April	2022		 define_arcantarget(3)

NAME | SYNOPSIS | DESCRIPTION | NOTES | EXAMPLE | SEE ALSO:

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=define_arcantarget&sektion=3&manpath=FreeBSD+13.1-RELEASE+and+Ports>

home | help