mirror
/
libx52
mirror of https://github.com/nirenjan/libx52.git
1
0
Fork 0
Code Releases Wiki Activity

Add reference to libx52_connect in integration documentation

reverse-scroll
nirenjan 2021-02-09 00:09:48 -08:00
parent 7116af8f66
commit 2c522b9a66
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
lib/libx52/doc/integration.dox
View File

@ -5,6 +5,9 @@ libx52 performs all its operations with a device context pointer. The
application must call \ref libx52_init before performing any operation, and application must call \ref libx52_init before performing any operation, and
must call \ref libx52_exit prior to terminating. must call \ref libx52_exit prior to terminating.
Also, the application must call \ref libx52_connect to ensure that it connects
to a supported joystick. This function must be called after \ref libx52_init
<b>Example Initialization/Deinitialization Code</b> <b>Example Initialization/Deinitialization Code</b>
@code{.c} @code{.c}
@ -22,6 +25,14 @@ libx52_device* init_libx52(void)
return NULL; return NULL;
} }
// Connect to the supported joystick
rc = libx52_connect(dev);
if (rc != LIBX52_SUCCESS) {
fputs(libx52_strerror(rc), stderr);
// A failure usually just means that there is no joystick connected
// Look at the return codes for more information.
}
return dev; return dev;
} }