update vibration handling
[pcsx_rearmed.git] / deps / libretro-common / include / libco.h
1 /* Copyright  (C) 2010-2020 The RetroArch team
2  *
3  * ---------------------------------------------------------------------------------------
4  * The following license statement only applies to this file (libco.h).
5  * ---------------------------------------------------------------------------------------
6  *
7  * Permission is hereby granted, free of charge,
8  * to any person obtaining a copy of this software and associated documentation files (the "Software"),
9  * to deal in the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
11  * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
16  * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
19  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  */
22
23 #ifndef LIBCO_H
24 #define LIBCO_H
25
26 #include <retro_common_api.h>
27
28 #ifdef LIBCO_C
29   #ifdef LIBCO_MP
30     #define thread_local __thread
31   #else
32     #define thread_local
33   #endif
34 #endif
35
36 RETRO_BEGIN_DECLS
37
38 typedef void* cothread_t;
39
40 /**
41  * co_active:
42  *
43  * Gets the currently active context.
44  *
45  * Returns: active context.
46  **/
47 cothread_t co_active(void);
48
49 /**
50  * co_create:
51  * @int                : stack size
52  * @funcptr            : thread entry function callback
53  *
54  * Create a co_thread.
55  *
56  * Returns: cothread if successful, otherwise NULL.
57  */
58 cothread_t co_create(unsigned int, void (*)(void));
59
60 /**
61  * co_delete:
62  * @cothread           : cothread object
63  *
64  * Frees a co_thread.
65  */
66 void co_delete(cothread_t cothread);
67
68 /**
69  * co_switch:
70  * @cothread           : cothread object to switch to
71  *
72  * Do a context switch to @cothread.
73  */
74 void co_switch(cothread_t cothread);
75
76 RETRO_END_DECLS
77
78 /* ifndef LIBCO_H */
79 #endif