dmxgetinputattributes(3) [bsd man page]

DMXGetInputAttributes(3)				     Library Functions Manual					  DMXGetInputAttributes(3)

NAME

       DMXGetInputAttributes - determine input device attributes

SYNOPSIS

       #include <X11/extensions/dmxext.h>

       Bool DMXGetInputAttributes(Display *dpy,
				  int id,
				  DMXInputAttributes *attr);

DESCRIPTION

       DMXGetInputAttributes()	returns  information  about  the  input  device  specified  with id.  This information cannot be obtained from the
       XListInputDevices(3) call.  id is the same as that used by the XListInputDevices(3) call, and must be in the range 0 to one less  than  the
       value returned by DMXGetInputCount(3), inclusive.

       The DMXInputAttributes structure is:

       typedef struct {
	   DMXInputEnum inputType;
	   int		physicalScreen;
	   int		physicalId;
	   Bool 	isCore;
	   Bool 	sendsCore;
	   const char	*name;
	   Bool 	detached;
       } DMXInputAttributes;

       The value of inputType will always be valid, and will have one of the following values, depending on the type of input: DMXLocalInputType ,
       DMXConsoleInputType , or DMXBackendInputType .

       For local devices, all other fields returned, except isCore  and  sendsCore , are invalid.

       For console devices, physicalScreen  and  physicalID will be invalid, and name will return the name of the X server on  which  the  console
       window is displayed.

       For  back-end  devices,	physicalScreen	will  identify the back-end display and can be used as an argument to DMXGetScreenAttributes(3) to
       obtain more information; physicalId will be the XInput device id on the back-end X server; and name will be invalid (since it does not pro-
       vide any additional information that cannot be obtained with DMXGetScreenAttributes(3)).

       If  isCore  is  True,  then  this  device is active as a true core input device and will send core events.  If sendsCore is True, then this
       device is an XInput extension device, but sends core events instead of extension events.  This behavior is different from that  of  XFree86
       or Xorg, where XInput extension devices may send both extension events and core events.

       If  detached  is True, then this device has been detached and is no longer producing input events.  The device may be reattached using DMX-
       AddInput(3).

RETURN VALUE

       DMXGetInputAttributes() returns True unless there is a protocol error.

       DMXGetInputAttributes() can generate BadValue (if the value of id is out of range).

SEE ALSO

       DMXGetInputCount(3), XListInputDevices(3), DMXGetScreenAttributes(3), DMXAddInput(3), DMX(3), Xdmx(1)

X Version 11							   libdmx 1.1.2 					  DMXGetInputAttributes(3)

DMXAddInput(3)						     Library Functions Manual						    DMXAddInput(3)

NAME

       DMXAddInput, DMXAddBackendInput, DMXAddConsoleInput - attach a new input

SYNOPSIS

       #include <X11/extensions/dmxext.h>

       Bool DMXAddInput(Display *dpy,
			unsigned int mask,
			DMXInputAttributes *attr,
			int *id);
       Bool DMXAddBackendInput(Display *dpy,
			       int screen,
			       int sendsCore,
			       int *newId);
       Bool DMXAddConsoleInput(Display *dpy,
			       const char *name,
			       int sendsCore,
			       int *newId);

DESCRIPTION

       DMXAddInput() is used to attach a new input (or a previously detached input) to the Xdmx(1) server.  mask specifies the fields in attr that
       are active, and id returns the device if of the first device in the series that is added.

       The value of mask is computed from the following values:

       DMXInputType
       DMXInputPhysicalScreen
       DMXInputSendsCore

       The DMXInputAttributes structure is:

       typedef struct {
	   DMXInputEnum inputType;
	   int		physicalScreen;
	   int		physicalId;
	   Bool 	isCore;
	   Bool 	sendsCore;
	   const char	*name;
	   Bool 	detached;
       } DMXInputAttributes;

       inputType may have the value DMXConsoleInputType  or  DMXBackendInputType .

       For console devices, name will specify the display to be used.

       For back-end devices, physicalScreen will specify the Xdmx(1) screen number.

       If sendsCore is True, the new device will be added as a true core device.

       If a device was removed with DMXRemoveInput(3) an attempt will be made to reconnect the previous devices  (sendsCore  is  ignored  in  this
       case).

       DMXAddBackendInput() is a helper function that is used to add input from a back-end server.  With this function, screen refers to the back-
       end screen, sendsCore is True if the new input should send core events (and it ignored if the input has been detached), and newId will hold
       the device id of the first device in the series added.

       DMXAddConsoleInput()  is  a  helper function that is used to add input from a console.  With this function, name is the name of the console
       display, sendsCore is True if the new input should send core events (and it ignored if the input has been detached), and  newId	will  hold
       the device id of the first device in the series added.

RETURN VALUE

       DMXAddInput() returns True on success and False otherwise.

       DMXAddInput()  can  generate BadValue (if inputType is invalid or physicalScreen is out of range), BadAccess (if the input has already been
       attached or if the backend screen is currently detached).

NOTES

       Local devices cannot be attached or detached.

       Attributes that are not specified will default to 0.  This may lead to unintended results.

SEE ALSO

       DMXRemoveInput(3), DMX(3), Xdmx(1)

X Version 11							   libdmx 1.1.2 						    DMXAddInput(3)