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

FreeBSD Manual Pages

  
 
  

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

NAME
       rendertarget_attach - Modify the	attachment statement of	a video	object

SYNOPSIS
       nil
       rendertarget_attach( rendertarget, source, detach_state )

DESCRIPTION
       Every  video object has at least	one (primary), but possibly many (sec-
       ondary) connections to different	rendertargets. The primary  connection
       also  defines  lifespan,	meaning	that if	the object which act as	a pri-
       mary connection is deleted, so are any other objects that are  attached
       to it. This association can be changed either when creating new render-
       targets or dynamically using this function.

       rendertarget  specifies the attachment point, source  refers to the ob-
       ject  that  should be attached or detached and detach_state  determines
       if the primary attachment should	be reassigned (	RENDERTARGET_DETACH  )
       or kept ( RENDERTARGET_NODETACH ). Only WORLDID	or a vid that has been
       previously flagged as a rendertarget (using define_rendertarget	or de-
       fine_calctarget	 or define_recordtarget	) are valid values for render-
       traget .

NOTES
       1      Relative properties  (scale,  position  etc.)  are  all  defined
	      against  the  current  primary rendertarget and are not recalcu-
	      lated on attach/detach operations. The common pattern to	handle
	      objects  that  should have the same storage but live inside dif-
	      ferent rendertargets is to use null_surface   to	create	a  new
	      container,  image_sharestorage   to make sure source and new ob-
	      ject has the same	backing	store and then finally

	      rendertarget_attach  the new object with RENDERTARGET_DETACH .

       2

       3      Deleting an object also implies detaching	it from	all rendertar-
	      gets.

       4      A	rendertarget cannot be attached	to itself.

       5      Objects  that  have been flagged as persistant cannot be part of
	      other rendertargets.

EXAMPLE
       function	rendertarget_attach0()
	     local rtgt	= alloc_surface(VRESW, VRESH);
	     resize_image(rtgt,	200, 200);
	     local obj_a = color_surface(32, 32, 0, 255, 0);
	     show_image({rtgt, obj_a});
	     define_rendertarget(rtgt, {obj_a});
	     local new_obj = color_surface(64, 64, 255,	0, 0);
	     show_image(new_obj);
	     move_image(new_obj, VRESW * 0.5, VRESH * 0.5);
	     rendertarget_attach(rtgt, new_obj,	RENDERTARGET_NODETACH);
       end

SEE ALSO:
       define_rendertarget(3) define_recordtarget(3) define_calctarget(3)

targetcontrol			 December 2021		rendertarget_attach(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=rendertarget_attach&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help