native_audio 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (138) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +21 -0
  3. data/README.md +87 -0
  4. data/ext/audio/audio.c +321 -47
  5. data/ext/audio/extconf.rb +12 -110
  6. data/ext/audio/miniaudio.h +95844 -0
  7. data/lib/dummy_audio.rb +49 -0
  8. data/lib/native_audio.rb +22 -7
  9. metadata +7 -132
  10. data/assets/include/SDL2/SDL.h +0 -233
  11. data/assets/include/SDL2/SDL_assert.h +0 -326
  12. data/assets/include/SDL2/SDL_atomic.h +0 -415
  13. data/assets/include/SDL2/SDL_audio.h +0 -1500
  14. data/assets/include/SDL2/SDL_bits.h +0 -126
  15. data/assets/include/SDL2/SDL_blendmode.h +0 -198
  16. data/assets/include/SDL2/SDL_clipboard.h +0 -141
  17. data/assets/include/SDL2/SDL_config.h +0 -61
  18. data/assets/include/SDL2/SDL_config_android.h +0 -194
  19. data/assets/include/SDL2/SDL_config_emscripten.h +0 -218
  20. data/assets/include/SDL2/SDL_config_iphoneos.h +0 -217
  21. data/assets/include/SDL2/SDL_config_macosx.h +0 -277
  22. data/assets/include/SDL2/SDL_config_minimal.h +0 -95
  23. data/assets/include/SDL2/SDL_config_ngage.h +0 -89
  24. data/assets/include/SDL2/SDL_config_os2.h +0 -207
  25. data/assets/include/SDL2/SDL_config_pandora.h +0 -141
  26. data/assets/include/SDL2/SDL_config_windows.h +0 -331
  27. data/assets/include/SDL2/SDL_config_wingdk.h +0 -253
  28. data/assets/include/SDL2/SDL_config_winrt.h +0 -220
  29. data/assets/include/SDL2/SDL_config_xbox.h +0 -235
  30. data/assets/include/SDL2/SDL_copying.h +0 -20
  31. data/assets/include/SDL2/SDL_cpuinfo.h +0 -594
  32. data/assets/include/SDL2/SDL_egl.h +0 -2352
  33. data/assets/include/SDL2/SDL_endian.h +0 -348
  34. data/assets/include/SDL2/SDL_error.h +0 -163
  35. data/assets/include/SDL2/SDL_events.h +0 -1166
  36. data/assets/include/SDL2/SDL_filesystem.h +0 -149
  37. data/assets/include/SDL2/SDL_gamecontroller.h +0 -1074
  38. data/assets/include/SDL2/SDL_gesture.h +0 -117
  39. data/assets/include/SDL2/SDL_guid.h +0 -100
  40. data/assets/include/SDL2/SDL_haptic.h +0 -1341
  41. data/assets/include/SDL2/SDL_hidapi.h +0 -451
  42. data/assets/include/SDL2/SDL_hints.h +0 -2569
  43. data/assets/include/SDL2/SDL_image.h +0 -2173
  44. data/assets/include/SDL2/SDL_joystick.h +0 -1066
  45. data/assets/include/SDL2/SDL_keyboard.h +0 -353
  46. data/assets/include/SDL2/SDL_keycode.h +0 -358
  47. data/assets/include/SDL2/SDL_loadso.h +0 -115
  48. data/assets/include/SDL2/SDL_locale.h +0 -103
  49. data/assets/include/SDL2/SDL_log.h +0 -404
  50. data/assets/include/SDL2/SDL_main.h +0 -275
  51. data/assets/include/SDL2/SDL_messagebox.h +0 -193
  52. data/assets/include/SDL2/SDL_metal.h +0 -113
  53. data/assets/include/SDL2/SDL_misc.h +0 -79
  54. data/assets/include/SDL2/SDL_mixer.h +0 -2784
  55. data/assets/include/SDL2/SDL_mouse.h +0 -465
  56. data/assets/include/SDL2/SDL_mutex.h +0 -471
  57. data/assets/include/SDL2/SDL_name.h +0 -33
  58. data/assets/include/SDL2/SDL_opengl.h +0 -2132
  59. data/assets/include/SDL2/SDL_opengl_glext.h +0 -13209
  60. data/assets/include/SDL2/SDL_opengles.h +0 -39
  61. data/assets/include/SDL2/SDL_opengles2.h +0 -52
  62. data/assets/include/SDL2/SDL_opengles2_gl2.h +0 -656
  63. data/assets/include/SDL2/SDL_opengles2_gl2ext.h +0 -4033
  64. data/assets/include/SDL2/SDL_opengles2_gl2platform.h +0 -27
  65. data/assets/include/SDL2/SDL_opengles2_khrplatform.h +0 -311
  66. data/assets/include/SDL2/SDL_pixels.h +0 -644
  67. data/assets/include/SDL2/SDL_platform.h +0 -261
  68. data/assets/include/SDL2/SDL_power.h +0 -88
  69. data/assets/include/SDL2/SDL_quit.h +0 -58
  70. data/assets/include/SDL2/SDL_rect.h +0 -376
  71. data/assets/include/SDL2/SDL_render.h +0 -1919
  72. data/assets/include/SDL2/SDL_revision.h +0 -6
  73. data/assets/include/SDL2/SDL_rwops.h +0 -841
  74. data/assets/include/SDL2/SDL_scancode.h +0 -438
  75. data/assets/include/SDL2/SDL_sensor.h +0 -322
  76. data/assets/include/SDL2/SDL_shape.h +0 -155
  77. data/assets/include/SDL2/SDL_stdinc.h +0 -830
  78. data/assets/include/SDL2/SDL_surface.h +0 -997
  79. data/assets/include/SDL2/SDL_system.h +0 -623
  80. data/assets/include/SDL2/SDL_syswm.h +0 -386
  81. data/assets/include/SDL2/SDL_test.h +0 -69
  82. data/assets/include/SDL2/SDL_test_assert.h +0 -105
  83. data/assets/include/SDL2/SDL_test_common.h +0 -236
  84. data/assets/include/SDL2/SDL_test_compare.h +0 -69
  85. data/assets/include/SDL2/SDL_test_crc32.h +0 -124
  86. data/assets/include/SDL2/SDL_test_font.h +0 -168
  87. data/assets/include/SDL2/SDL_test_fuzzer.h +0 -386
  88. data/assets/include/SDL2/SDL_test_harness.h +0 -134
  89. data/assets/include/SDL2/SDL_test_images.h +0 -78
  90. data/assets/include/SDL2/SDL_test_log.h +0 -67
  91. data/assets/include/SDL2/SDL_test_md5.h +0 -129
  92. data/assets/include/SDL2/SDL_test_memory.h +0 -63
  93. data/assets/include/SDL2/SDL_test_random.h +0 -115
  94. data/assets/include/SDL2/SDL_thread.h +0 -464
  95. data/assets/include/SDL2/SDL_timer.h +0 -222
  96. data/assets/include/SDL2/SDL_touch.h +0 -150
  97. data/assets/include/SDL2/SDL_ttf.h +0 -2316
  98. data/assets/include/SDL2/SDL_types.h +0 -29
  99. data/assets/include/SDL2/SDL_version.h +0 -204
  100. data/assets/include/SDL2/SDL_video.h +0 -2150
  101. data/assets/include/SDL2/SDL_vulkan.h +0 -215
  102. data/assets/include/SDL2/begin_code.h +0 -187
  103. data/assets/include/SDL2/close_code.h +0 -40
  104. data/assets/macos/universal/lib/libFLAC.a +0 -0
  105. data/assets/macos/universal/lib/libSDL2.a +0 -0
  106. data/assets/macos/universal/lib/libSDL2_mixer.a +0 -0
  107. data/assets/macos/universal/lib/libmodplug.a +0 -0
  108. data/assets/macos/universal/lib/libmpg123.a +0 -0
  109. data/assets/macos/universal/lib/libogg.a +0 -0
  110. data/assets/macos/universal/lib/libvorbis.a +0 -0
  111. data/assets/macos/universal/lib/libvorbisfile.a +0 -0
  112. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libFLAC.a +0 -0
  113. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libSDL2.a +0 -0
  114. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libSDL2_mixer.a +0 -0
  115. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libmodplug.a +0 -0
  116. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libmpg123.a +0 -0
  117. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libogg.a +0 -0
  118. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libopus.a +0 -0
  119. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libopusfile.a +0 -0
  120. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libsndfile.a +0 -0
  121. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libstdc++.a +0 -0
  122. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libvorbis.a +0 -0
  123. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libvorbisfile.a +0 -0
  124. data/assets/windows/mingw-w64-ucrt-x86_64/lib/libz.a +0 -0
  125. data/assets/windows/mingw-w64-x86_64/lib/libFLAC.a +0 -0
  126. data/assets/windows/mingw-w64-x86_64/lib/libSDL2.a +0 -0
  127. data/assets/windows/mingw-w64-x86_64/lib/libSDL2_mixer.a +0 -0
  128. data/assets/windows/mingw-w64-x86_64/lib/libmodplug.a +0 -0
  129. data/assets/windows/mingw-w64-x86_64/lib/libmpg123.a +0 -0
  130. data/assets/windows/mingw-w64-x86_64/lib/libogg.a +0 -0
  131. data/assets/windows/mingw-w64-x86_64/lib/libopus.a +0 -0
  132. data/assets/windows/mingw-w64-x86_64/lib/libopusfile.a +0 -0
  133. data/assets/windows/mingw-w64-x86_64/lib/libsndfile.a +0 -0
  134. data/assets/windows/mingw-w64-x86_64/lib/libstdc++.a +0 -0
  135. data/assets/windows/mingw-w64-x86_64/lib/libvorbis.a +0 -0
  136. data/assets/windows/mingw-w64-x86_64/lib/libvorbisfile.a +0 -0
  137. data/assets/windows/mingw-w64-x86_64/lib/libz.a +0 -0
  138. data/ext/audio/extconf.h +0 -3
@@ -1,322 +0,0 @@
1
- /*
2
- Simple DirectMedia Layer
3
- Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
4
-
5
- This software is provided 'as-is', without any express or implied
6
- warranty. In no event will the authors be held liable for any damages
7
- arising from the use of this software.
8
-
9
- Permission is granted to anyone to use this software for any purpose,
10
- including commercial applications, and to alter it and redistribute it
11
- freely, subject to the following restrictions:
12
-
13
- 1. The origin of this software must not be misrepresented; you must not
14
- claim that you wrote the original software. If you use this software
15
- in a product, an acknowledgment in the product documentation would be
16
- appreciated but is not required.
17
- 2. Altered source versions must be plainly marked as such, and must not be
18
- misrepresented as being the original software.
19
- 3. This notice may not be removed or altered from any source distribution.
20
- */
21
-
22
- /**
23
- * \file SDL_sensor.h
24
- *
25
- * Include file for SDL sensor event handling
26
- *
27
- */
28
-
29
- #ifndef SDL_sensor_h_
30
- #define SDL_sensor_h_
31
-
32
- #include "SDL_stdinc.h"
33
- #include "SDL_error.h"
34
-
35
- #include "begin_code.h"
36
- /* Set up for C function definitions, even when using C++ */
37
- #ifdef __cplusplus
38
- /* *INDENT-OFF* */
39
- extern "C" {
40
- /* *INDENT-ON* */
41
- #endif
42
-
43
- /**
44
- * \brief SDL_sensor.h
45
- *
46
- * In order to use these functions, SDL_Init() must have been called
47
- * with the ::SDL_INIT_SENSOR flag. This causes SDL to scan the system
48
- * for sensors, and load appropriate drivers.
49
- */
50
-
51
- struct _SDL_Sensor;
52
- typedef struct _SDL_Sensor SDL_Sensor;
53
-
54
- /**
55
- * This is a unique ID for a sensor for the time it is connected to the system,
56
- * and is never reused for the lifetime of the application.
57
- *
58
- * The ID value starts at 0 and increments from there. The value -1 is an invalid ID.
59
- */
60
- typedef Sint32 SDL_SensorID;
61
-
62
- /* The different sensors defined by SDL
63
- *
64
- * Additional sensors may be available, using platform dependent semantics.
65
- *
66
- * Hare are the additional Android sensors:
67
- * https://developer.android.com/reference/android/hardware/SensorEvent.html#values
68
- */
69
- typedef enum
70
- {
71
- SDL_SENSOR_INVALID = -1, /**< Returned for an invalid sensor */
72
- SDL_SENSOR_UNKNOWN, /**< Unknown sensor type */
73
- SDL_SENSOR_ACCEL, /**< Accelerometer */
74
- SDL_SENSOR_GYRO, /**< Gyroscope */
75
- SDL_SENSOR_ACCEL_L, /**< Accelerometer for left Joy-Con controller and Wii nunchuk */
76
- SDL_SENSOR_GYRO_L, /**< Gyroscope for left Joy-Con controller */
77
- SDL_SENSOR_ACCEL_R, /**< Accelerometer for right Joy-Con controller */
78
- SDL_SENSOR_GYRO_R /**< Gyroscope for right Joy-Con controller */
79
- } SDL_SensorType;
80
-
81
- /**
82
- * Accelerometer sensor
83
- *
84
- * The accelerometer returns the current acceleration in SI meters per
85
- * second squared. This measurement includes the force of gravity, so
86
- * a device at rest will have an value of SDL_STANDARD_GRAVITY away
87
- * from the center of the earth.
88
- *
89
- * values[0]: Acceleration on the x axis
90
- * values[1]: Acceleration on the y axis
91
- * values[2]: Acceleration on the z axis
92
- *
93
- * For phones held in portrait mode and game controllers held in front of you,
94
- * the axes are defined as follows:
95
- * -X ... +X : left ... right
96
- * -Y ... +Y : bottom ... top
97
- * -Z ... +Z : farther ... closer
98
- *
99
- * The axis data is not changed when the phone is rotated.
100
- *
101
- * \sa SDL_GetDisplayOrientation()
102
- */
103
- #define SDL_STANDARD_GRAVITY 9.80665f
104
-
105
- /**
106
- * Gyroscope sensor
107
- *
108
- * The gyroscope returns the current rate of rotation in radians per second.
109
- * The rotation is positive in the counter-clockwise direction. That is,
110
- * an observer looking from a positive location on one of the axes would
111
- * see positive rotation on that axis when it appeared to be rotating
112
- * counter-clockwise.
113
- *
114
- * values[0]: Angular speed around the x axis (pitch)
115
- * values[1]: Angular speed around the y axis (yaw)
116
- * values[2]: Angular speed around the z axis (roll)
117
- *
118
- * For phones held in portrait mode and game controllers held in front of you,
119
- * the axes are defined as follows:
120
- * -X ... +X : left ... right
121
- * -Y ... +Y : bottom ... top
122
- * -Z ... +Z : farther ... closer
123
- *
124
- * The axis data is not changed when the phone or controller is rotated.
125
- *
126
- * \sa SDL_GetDisplayOrientation()
127
- */
128
-
129
- /* Function prototypes */
130
-
131
- /**
132
- * Locking for multi-threaded access to the sensor API
133
- *
134
- * If you are using the sensor API or handling events from multiple threads
135
- * you should use these locking functions to protect access to the sensors.
136
- *
137
- * In particular, you are guaranteed that the sensor list won't change, so the
138
- * API functions that take a sensor index will be valid, and sensor events
139
- * will not be delivered.
140
- *
141
- * \since This function is available since SDL 2.0.14.
142
- */
143
- extern DECLSPEC void SDLCALL SDL_LockSensors(void);
144
- extern DECLSPEC void SDLCALL SDL_UnlockSensors(void);
145
-
146
- /**
147
- * Count the number of sensors attached to the system right now.
148
- *
149
- * \returns the number of sensors detected.
150
- *
151
- * \since This function is available since SDL 2.0.9.
152
- */
153
- extern DECLSPEC int SDLCALL SDL_NumSensors(void);
154
-
155
- /**
156
- * Get the implementation dependent name of a sensor.
157
- *
158
- * \param device_index The sensor to obtain name from
159
- * \returns the sensor name, or NULL if `device_index` is out of range.
160
- *
161
- * \since This function is available since SDL 2.0.9.
162
- */
163
- extern DECLSPEC const char *SDLCALL SDL_SensorGetDeviceName(int device_index);
164
-
165
- /**
166
- * Get the type of a sensor.
167
- *
168
- * \param device_index The sensor to get the type from
169
- * \returns the SDL_SensorType, or `SDL_SENSOR_INVALID` if `device_index` is
170
- * out of range.
171
- *
172
- * \since This function is available since SDL 2.0.9.
173
- */
174
- extern DECLSPEC SDL_SensorType SDLCALL SDL_SensorGetDeviceType(int device_index);
175
-
176
- /**
177
- * Get the platform dependent type of a sensor.
178
- *
179
- * \param device_index The sensor to check
180
- * \returns the sensor platform dependent type, or -1 if `device_index` is out
181
- * of range.
182
- *
183
- * \since This function is available since SDL 2.0.9.
184
- */
185
- extern DECLSPEC int SDLCALL SDL_SensorGetDeviceNonPortableType(int device_index);
186
-
187
- /**
188
- * Get the instance ID of a sensor.
189
- *
190
- * \param device_index The sensor to get instance id from
191
- * \returns the sensor instance ID, or -1 if `device_index` is out of range.
192
- *
193
- * \since This function is available since SDL 2.0.9.
194
- */
195
- extern DECLSPEC SDL_SensorID SDLCALL SDL_SensorGetDeviceInstanceID(int device_index);
196
-
197
- /**
198
- * Open a sensor for use.
199
- *
200
- * \param device_index The sensor to open
201
- * \returns an SDL_Sensor sensor object, or NULL if an error occurred.
202
- *
203
- * \since This function is available since SDL 2.0.9.
204
- */
205
- extern DECLSPEC SDL_Sensor *SDLCALL SDL_SensorOpen(int device_index);
206
-
207
- /**
208
- * Return the SDL_Sensor associated with an instance id.
209
- *
210
- * \param instance_id The sensor from instance id
211
- * \returns an SDL_Sensor object.
212
- *
213
- * \since This function is available since SDL 2.0.9.
214
- */
215
- extern DECLSPEC SDL_Sensor *SDLCALL SDL_SensorFromInstanceID(SDL_SensorID instance_id);
216
-
217
- /**
218
- * Get the implementation dependent name of a sensor
219
- *
220
- * \param sensor The SDL_Sensor object
221
- * \returns the sensor name, or NULL if `sensor` is NULL.
222
- *
223
- * \since This function is available since SDL 2.0.9.
224
- */
225
- extern DECLSPEC const char *SDLCALL SDL_SensorGetName(SDL_Sensor *sensor);
226
-
227
- /**
228
- * Get the type of a sensor.
229
- *
230
- * \param sensor The SDL_Sensor object to inspect
231
- * \returns the SDL_SensorType type, or `SDL_SENSOR_INVALID` if `sensor` is
232
- * NULL.
233
- *
234
- * \since This function is available since SDL 2.0.9.
235
- */
236
- extern DECLSPEC SDL_SensorType SDLCALL SDL_SensorGetType(SDL_Sensor *sensor);
237
-
238
- /**
239
- * Get the platform dependent type of a sensor.
240
- *
241
- * \param sensor The SDL_Sensor object to inspect
242
- * \returns the sensor platform dependent type, or -1 if `sensor` is NULL.
243
- *
244
- * \since This function is available since SDL 2.0.9.
245
- */
246
- extern DECLSPEC int SDLCALL SDL_SensorGetNonPortableType(SDL_Sensor *sensor);
247
-
248
- /**
249
- * Get the instance ID of a sensor.
250
- *
251
- * \param sensor The SDL_Sensor object to inspect
252
- * \returns the sensor instance ID, or -1 if `sensor` is NULL.
253
- *
254
- * \since This function is available since SDL 2.0.9.
255
- */
256
- extern DECLSPEC SDL_SensorID SDLCALL SDL_SensorGetInstanceID(SDL_Sensor *sensor);
257
-
258
- /**
259
- * Get the current state of an opened sensor.
260
- *
261
- * The number of values and interpretation of the data is sensor dependent.
262
- *
263
- * \param sensor The SDL_Sensor object to query
264
- * \param data A pointer filled with the current sensor state
265
- * \param num_values The number of values to write to data
266
- * \returns 0 or -1 if an error occurred.
267
- *
268
- * \since This function is available since SDL 2.0.9.
269
- */
270
- extern DECLSPEC int SDLCALL SDL_SensorGetData(SDL_Sensor *sensor, float *data, int num_values);
271
-
272
- /**
273
- * Get the current state of an opened sensor with the timestamp of the last
274
- * update.
275
- *
276
- * The number of values and interpretation of the data is sensor dependent.
277
- *
278
- * \param sensor The SDL_Sensor object to query
279
- * \param timestamp A pointer filled with the timestamp in microseconds of the
280
- * current sensor reading if available, or 0 if not
281
- * \param data A pointer filled with the current sensor state
282
- * \param num_values The number of values to write to data
283
- * \returns 0 or -1 if an error occurred.
284
- *
285
- * \since This function is available since SDL 2.26.0.
286
- */
287
- extern DECLSPEC int SDLCALL SDL_SensorGetDataWithTimestamp(SDL_Sensor *sensor, Uint64 *timestamp, float *data, int num_values);
288
-
289
- /**
290
- * Close a sensor previously opened with SDL_SensorOpen().
291
- *
292
- * \param sensor The SDL_Sensor object to close
293
- *
294
- * \since This function is available since SDL 2.0.9.
295
- */
296
- extern DECLSPEC void SDLCALL SDL_SensorClose(SDL_Sensor *sensor);
297
-
298
- /**
299
- * Update the current state of the open sensors.
300
- *
301
- * This is called automatically by the event loop if sensor events are
302
- * enabled.
303
- *
304
- * This needs to be called from the thread that initialized the sensor
305
- * subsystem.
306
- *
307
- * \since This function is available since SDL 2.0.9.
308
- */
309
- extern DECLSPEC void SDLCALL SDL_SensorUpdate(void);
310
-
311
-
312
- /* Ends C function definitions when using C++ */
313
- #ifdef __cplusplus
314
- /* *INDENT-OFF* */
315
- }
316
- /* *INDENT-ON* */
317
- #endif
318
- #include "close_code.h"
319
-
320
- #endif /* SDL_sensor_h_ */
321
-
322
- /* vi: set ts=4 sw=4 expandtab: */
@@ -1,155 +0,0 @@
1
- /*
2
- Simple DirectMedia Layer
3
- Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
4
-
5
- This software is provided 'as-is', without any express or implied
6
- warranty. In no event will the authors be held liable for any damages
7
- arising from the use of this software.
8
-
9
- Permission is granted to anyone to use this software for any purpose,
10
- including commercial applications, and to alter it and redistribute it
11
- freely, subject to the following restrictions:
12
-
13
- 1. The origin of this software must not be misrepresented; you must not
14
- claim that you wrote the original software. If you use this software
15
- in a product, an acknowledgment in the product documentation would be
16
- appreciated but is not required.
17
- 2. Altered source versions must be plainly marked as such, and must not be
18
- misrepresented as being the original software.
19
- 3. This notice may not be removed or altered from any source distribution.
20
- */
21
-
22
- #ifndef SDL_shape_h_
23
- #define SDL_shape_h_
24
-
25
- #include "SDL_stdinc.h"
26
- #include "SDL_pixels.h"
27
- #include "SDL_rect.h"
28
- #include "SDL_surface.h"
29
- #include "SDL_video.h"
30
-
31
- #include "begin_code.h"
32
- /* Set up for C function definitions, even when using C++ */
33
- #ifdef __cplusplus
34
- extern "C" {
35
- #endif
36
-
37
- /** \file SDL_shape.h
38
- *
39
- * Header file for the shaped window API.
40
- */
41
-
42
- #define SDL_NONSHAPEABLE_WINDOW -1
43
- #define SDL_INVALID_SHAPE_ARGUMENT -2
44
- #define SDL_WINDOW_LACKS_SHAPE -3
45
-
46
- /**
47
- * Create a window that can be shaped with the specified position, dimensions,
48
- * and flags.
49
- *
50
- * \param title The title of the window, in UTF-8 encoding.
51
- * \param x The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
52
- * ::SDL_WINDOWPOS_UNDEFINED.
53
- * \param y The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
54
- * ::SDL_WINDOWPOS_UNDEFINED.
55
- * \param w The width of the window.
56
- * \param h The height of the window.
57
- * \param flags The flags for the window, a mask of SDL_WINDOW_BORDERLESS with
58
- * any of the following: ::SDL_WINDOW_OPENGL,
59
- * ::SDL_WINDOW_INPUT_GRABBED, ::SDL_WINDOW_HIDDEN,
60
- * ::SDL_WINDOW_RESIZABLE, ::SDL_WINDOW_MAXIMIZED,
61
- * ::SDL_WINDOW_MINIMIZED, ::SDL_WINDOW_BORDERLESS is always set,
62
- * and ::SDL_WINDOW_FULLSCREEN is always unset.
63
- * \return the window created, or NULL if window creation failed.
64
- *
65
- * \since This function is available since SDL 2.0.0.
66
- *
67
- * \sa SDL_DestroyWindow
68
- */
69
- extern DECLSPEC SDL_Window * SDLCALL SDL_CreateShapedWindow(const char *title,unsigned int x,unsigned int y,unsigned int w,unsigned int h,Uint32 flags);
70
-
71
- /**
72
- * Return whether the given window is a shaped window.
73
- *
74
- * \param window The window to query for being shaped.
75
- * \return SDL_TRUE if the window is a window that can be shaped, SDL_FALSE if
76
- * the window is unshaped or NULL.
77
- *
78
- * \since This function is available since SDL 2.0.0.
79
- *
80
- * \sa SDL_CreateShapedWindow
81
- */
82
- extern DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window);
83
-
84
- /** \brief An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */
85
- typedef enum {
86
- /** \brief The default mode, a binarized alpha cutoff of 1. */
87
- ShapeModeDefault,
88
- /** \brief A binarized alpha cutoff with a given integer value. */
89
- ShapeModeBinarizeAlpha,
90
- /** \brief A binarized alpha cutoff with a given integer value, but with the opposite comparison. */
91
- ShapeModeReverseBinarizeAlpha,
92
- /** \brief A color key is applied. */
93
- ShapeModeColorKey
94
- } WindowShapeMode;
95
-
96
- #define SDL_SHAPEMODEALPHA(mode) (mode == ShapeModeDefault || mode == ShapeModeBinarizeAlpha || mode == ShapeModeReverseBinarizeAlpha)
97
-
98
- /** \brief A union containing parameters for shaped windows. */
99
- typedef union {
100
- /** \brief A cutoff alpha value for binarization of the window shape's alpha channel. */
101
- Uint8 binarizationCutoff;
102
- SDL_Color colorKey;
103
- } SDL_WindowShapeParams;
104
-
105
- /** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
106
- typedef struct SDL_WindowShapeMode {
107
- /** \brief The mode of these window-shape parameters. */
108
- WindowShapeMode mode;
109
- /** \brief Window-shape parameters. */
110
- SDL_WindowShapeParams parameters;
111
- } SDL_WindowShapeMode;
112
-
113
- /**
114
- * Set the shape and parameters of a shaped window.
115
- *
116
- * \param window The shaped window whose parameters should be set.
117
- * \param shape A surface encoding the desired shape for the window.
118
- * \param shape_mode The parameters to set for the shaped window.
119
- * \return 0 on success, SDL_INVALID_SHAPE_ARGUMENT on an invalid shape
120
- * argument, or SDL_NONSHAPEABLE_WINDOW if the SDL_Window given does
121
- * not reference a valid shaped window.
122
- *
123
- * \since This function is available since SDL 2.0.0.
124
- *
125
- * \sa SDL_WindowShapeMode
126
- * \sa SDL_GetShapedWindowMode
127
- */
128
- extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
129
-
130
- /**
131
- * Get the shape parameters of a shaped window.
132
- *
133
- * \param window The shaped window whose parameters should be retrieved.
134
- * \param shape_mode An empty shape-mode structure to fill, or NULL to check
135
- * whether the window has a shape.
136
- * \return 0 if the window has a shape and, provided shape_mode was not NULL,
137
- * shape_mode has been filled with the mode data,
138
- * SDL_NONSHAPEABLE_WINDOW if the SDL_Window given is not a shaped
139
- * window, or SDL_WINDOW_LACKS_SHAPE if the SDL_Window given is a
140
- * shapeable window currently lacking a shape.
141
- *
142
- * \since This function is available since SDL 2.0.0.
143
- *
144
- * \sa SDL_WindowShapeMode
145
- * \sa SDL_SetWindowShape
146
- */
147
- extern DECLSPEC int SDLCALL SDL_GetShapedWindowMode(SDL_Window *window,SDL_WindowShapeMode *shape_mode);
148
-
149
- /* Ends C function definitions when using C++ */
150
- #ifdef __cplusplus
151
- }
152
- #endif
153
- #include "close_code.h"
154
-
155
- #endif /* SDL_shape_h_ */