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

FreeBSD Manual Pages

  
 
  

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

NAME
       arcantarget_hint	 -  Send a hint	state through a	frameserver tied to an
       arcan instance

SYNOPSIS
       bool:ok
       arcantarget_hint( string:kind, tbl:hint )
       arcantarget_hint( vid:fsrv, string:kind,	tbl:hint )

DESCRIPTION
       When the	arcan-in-arcan platform	is used	(arcan_lwa binary) it can for-
       ward hints like any normal arcan-shmif client. These are	from a	subset
       of  the	ones that can be found in launch_target	. If fsrv  is not pro-
       vided, the default output, WORLDID , will be used. Otherwise it is  ex-
       pected that fsrv	 references a valid frameserver	tied to	a valid	source
       from define_arcantarget	or retrieved through the _adopt	event handler.
       The  currently  supported ones are: * input_label and the format	of the
       hint  table matches that	of the description in launch_target . *	 ident
       with  a string:message field in hint , provided as the new segment run-
       time identity (e.g. document name) * alert with a string:message	 field
       in  hint	, provided as the reason for user attention * statesize	with a
       int:size	field in hint ,	provided as the	estimated current output  size
       of a state-save

EXAMPLE
       function	arcantarget_hint0()
	     arcantarget_hint("input_label",
	     {
		   labelhint = "test",
		   description = "this should register as a digital button",
	     })
       end

SEE ALSO:
targetcontrol			  April	2025		   arcantarget_hint(3)

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

home | help