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, function:handler
     )

DESCRIPTION
     This function is used to request and bind	'subsegments'  useful  for  sec-
     ondary  outputs.  The event model is also applied for target_updatehandler
     when applied to WORLDID .

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

     The design and inner workings for this function is marked	as  experimental
     and may be subject to incremental changes.

NOTES
     1	    Valid types are: 'cursor', 'popup', 'icon', 'clipboard', 'titlebar',

     2	    An	invalid  vstore  or unsupported type is a terminal state transi-
	    tion.

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			   August 2026		   define_arcantarget(3)

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

home | help