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

FreeBSD Manual Pages

  
 
  

home | help
al_reconfi..._joysticks(3) Library Functions Manual al_reconfi..._joysticks(3)

NAME
       al_reconfigure_joysticks	- Allegro 5 API

SYNOPSIS
	      #include <allegro5/allegro.h>

	      bool al_reconfigure_joysticks(void)

DESCRIPTION
       Allegro is able to cope with users connecting and disconnected joystick
       devices	on-the-fly.   On existing platforms, the joystick event	source
       will generate an	 event	of  type  ALLEGRO_EVENT_JOYSTICK_CONFIGURATION
       when a device is	plugged	in or unplugged.  In response, you should call
       al_reconfigure_joysticks(3).

       Afterwards,  the	number returned	by al_get_num_joysticks(3) may be dif-
       ferent, and the handles returned	by al_get_joystick(3) may be different
       or be ordered differently.

       All ALLEGRO_JOYSTICK(3) handles remain valid, but handles  for  discon-
       nected devices become inactive: their states will no longer update, and
       al_get_joystick(3)  will	 not  return  the handle.  Handles for devices
       which remain connected will continue to	represent  the	same  devices.
       Previously  inactive  handles  may become active	again, being reused to
       represent newly connected devices.

       Returns true if the joystick configuration changed,  otherwise  returns
       false.

       It  is possible that on some systems, Allegro won't be able to generate
       ALLEGRO_EVENT_JOYSTICK_CONFIGURATION events.  If	your game has an input
       configuration screen or similar,	you  may  wish	to  call  al_reconfig-
       ure_joysticks(3)	when entering that screen.

SEE ALSO
       al_get_joystick_event_source(3),	ALLEGRO_EVENT(3)

Allegro	reference manual			    al_reconfi..._joysticks(3)

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

home | help