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 forward
     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 provided, the de-
     fault  output,  WORLDID , will be used. Otherwise it is expected that fsrv
     references a valid frameserver tied to a valid source from define_arcantar-
     get  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 runtime 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 esti-
     mated  current  output  size  of  a state-save * cursor with a string:style
     matching the set in launch_target

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

EXAMPLE
     function arcantarget_hint1()
	   arcantarget_hint("cursor", {style = "move"})
     end

SEE ALSO:
targetcontrol			   August 2026		     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+15.1.quarterly>

home | help