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
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Dummy audio backend for CI/testing environments without audio hardware.
4
+ # Has the same interface as the Audio C extension but does nothing.
5
+ module DummyAudio
6
+ @sound_count = 0
7
+
8
+ def self.init
9
+ nil
10
+ end
11
+
12
+ def self.load(path)
13
+ id = @sound_count
14
+ @sound_count += 1
15
+ id
16
+ end
17
+
18
+ def self.duration(clip)
19
+ 5.0
20
+ end
21
+
22
+ def self.play(channel, clip)
23
+ channel
24
+ end
25
+
26
+ def self.stop(channel)
27
+ nil
28
+ end
29
+
30
+ def self.pause(channel)
31
+ nil
32
+ end
33
+
34
+ def self.resume(channel)
35
+ nil
36
+ end
37
+
38
+ def self.set_volume(channel, volume)
39
+ nil
40
+ end
41
+
42
+ def self.set_pitch(channel, pitch)
43
+ nil
44
+ end
45
+
46
+ def self.set_pos(channel, angle, distance)
47
+ nil
48
+ end
49
+ end
data/lib/native_audio.rb CHANGED
@@ -1,14 +1,25 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require_relative './audio'
4
+ require_relative './dummy_audio'
5
+
6
+ Audio.init unless ENV['DUMMY_AUDIO_BACKEND'] == 'true'
4
7
 
5
8
  module NativeAudio
9
+ def self.audio_driver
10
+ ENV['DUMMY_AUDIO_BACKEND'] == 'true' ? DummyAudio : Audio
11
+ end
12
+
6
13
  class Clip
7
14
  attr_reader :clip
8
15
 
9
16
  def initialize(path)
10
17
  @path = path
11
- @clip = Audio.load(path)
18
+ @clip = NativeAudio.audio_driver.load(path)
19
+ end
20
+
21
+ def duration
22
+ NativeAudio.audio_driver.duration(@clip)
12
23
  end
13
24
  end
14
25
 
@@ -20,27 +31,31 @@ module NativeAudio
20
31
  end
21
32
 
22
33
  def play
23
- Audio.play(@channel, @clip.clip)
34
+ NativeAudio.audio_driver.play(@channel, @clip.clip)
24
35
  end
25
36
 
26
37
  def stop
27
- Audio.stop(@channel)
38
+ NativeAudio.audio_driver.stop(@channel)
28
39
  end
29
40
 
30
41
  def pause
31
- Audio.pause(@channel)
42
+ NativeAudio.audio_driver.pause(@channel)
32
43
  end
33
44
 
34
45
  def resume
35
- Audio.resume(@channel)
46
+ NativeAudio.audio_driver.resume(@channel)
36
47
  end
37
48
 
38
49
  def set_pos(angle, distance)
39
- Audio.set_pos(@channel, angle, distance)
50
+ NativeAudio.audio_driver.set_pos(@channel, angle, distance)
40
51
  end
41
52
 
42
53
  def set_volume(volume)
43
- Audio.set_volume(@channel, volume)
54
+ NativeAudio.audio_driver.set_volume(@channel, volume)
55
+ end
56
+
57
+ def set_pitch(pitch)
58
+ NativeAudio.audio_driver.set_pitch(@channel, pitch)
44
59
  end
45
60
 
46
61
  def self.channels
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: native_audio
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Max Hatfull
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2026-01-26 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
11
  dependencies: []
12
12
  description: A simple audio library for Ruby
13
13
  email:
@@ -17,137 +17,12 @@ extensions:
17
17
  - ext/audio/extconf.rb
18
18
  extra_rdoc_files: []
19
19
  files:
20
- - assets/include/SDL2/SDL.h
21
- - assets/include/SDL2/SDL_assert.h
22
- - assets/include/SDL2/SDL_atomic.h
23
- - assets/include/SDL2/SDL_audio.h
24
- - assets/include/SDL2/SDL_bits.h
25
- - assets/include/SDL2/SDL_blendmode.h
26
- - assets/include/SDL2/SDL_clipboard.h
27
- - assets/include/SDL2/SDL_config.h
28
- - assets/include/SDL2/SDL_config_android.h
29
- - assets/include/SDL2/SDL_config_emscripten.h
30
- - assets/include/SDL2/SDL_config_iphoneos.h
31
- - assets/include/SDL2/SDL_config_macosx.h
32
- - assets/include/SDL2/SDL_config_minimal.h
33
- - assets/include/SDL2/SDL_config_ngage.h
34
- - assets/include/SDL2/SDL_config_os2.h
35
- - assets/include/SDL2/SDL_config_pandora.h
36
- - assets/include/SDL2/SDL_config_windows.h
37
- - assets/include/SDL2/SDL_config_wingdk.h
38
- - assets/include/SDL2/SDL_config_winrt.h
39
- - assets/include/SDL2/SDL_config_xbox.h
40
- - assets/include/SDL2/SDL_copying.h
41
- - assets/include/SDL2/SDL_cpuinfo.h
42
- - assets/include/SDL2/SDL_egl.h
43
- - assets/include/SDL2/SDL_endian.h
44
- - assets/include/SDL2/SDL_error.h
45
- - assets/include/SDL2/SDL_events.h
46
- - assets/include/SDL2/SDL_filesystem.h
47
- - assets/include/SDL2/SDL_gamecontroller.h
48
- - assets/include/SDL2/SDL_gesture.h
49
- - assets/include/SDL2/SDL_guid.h
50
- - assets/include/SDL2/SDL_haptic.h
51
- - assets/include/SDL2/SDL_hidapi.h
52
- - assets/include/SDL2/SDL_hints.h
53
- - assets/include/SDL2/SDL_image.h
54
- - assets/include/SDL2/SDL_joystick.h
55
- - assets/include/SDL2/SDL_keyboard.h
56
- - assets/include/SDL2/SDL_keycode.h
57
- - assets/include/SDL2/SDL_loadso.h
58
- - assets/include/SDL2/SDL_locale.h
59
- - assets/include/SDL2/SDL_log.h
60
- - assets/include/SDL2/SDL_main.h
61
- - assets/include/SDL2/SDL_messagebox.h
62
- - assets/include/SDL2/SDL_metal.h
63
- - assets/include/SDL2/SDL_misc.h
64
- - assets/include/SDL2/SDL_mixer.h
65
- - assets/include/SDL2/SDL_mouse.h
66
- - assets/include/SDL2/SDL_mutex.h
67
- - assets/include/SDL2/SDL_name.h
68
- - assets/include/SDL2/SDL_opengl.h
69
- - assets/include/SDL2/SDL_opengl_glext.h
70
- - assets/include/SDL2/SDL_opengles.h
71
- - assets/include/SDL2/SDL_opengles2.h
72
- - assets/include/SDL2/SDL_opengles2_gl2.h
73
- - assets/include/SDL2/SDL_opengles2_gl2ext.h
74
- - assets/include/SDL2/SDL_opengles2_gl2platform.h
75
- - assets/include/SDL2/SDL_opengles2_khrplatform.h
76
- - assets/include/SDL2/SDL_pixels.h
77
- - assets/include/SDL2/SDL_platform.h
78
- - assets/include/SDL2/SDL_power.h
79
- - assets/include/SDL2/SDL_quit.h
80
- - assets/include/SDL2/SDL_rect.h
81
- - assets/include/SDL2/SDL_render.h
82
- - assets/include/SDL2/SDL_revision.h
83
- - assets/include/SDL2/SDL_rwops.h
84
- - assets/include/SDL2/SDL_scancode.h
85
- - assets/include/SDL2/SDL_sensor.h
86
- - assets/include/SDL2/SDL_shape.h
87
- - assets/include/SDL2/SDL_stdinc.h
88
- - assets/include/SDL2/SDL_surface.h
89
- - assets/include/SDL2/SDL_system.h
90
- - assets/include/SDL2/SDL_syswm.h
91
- - assets/include/SDL2/SDL_test.h
92
- - assets/include/SDL2/SDL_test_assert.h
93
- - assets/include/SDL2/SDL_test_common.h
94
- - assets/include/SDL2/SDL_test_compare.h
95
- - assets/include/SDL2/SDL_test_crc32.h
96
- - assets/include/SDL2/SDL_test_font.h
97
- - assets/include/SDL2/SDL_test_fuzzer.h
98
- - assets/include/SDL2/SDL_test_harness.h
99
- - assets/include/SDL2/SDL_test_images.h
100
- - assets/include/SDL2/SDL_test_log.h
101
- - assets/include/SDL2/SDL_test_md5.h
102
- - assets/include/SDL2/SDL_test_memory.h
103
- - assets/include/SDL2/SDL_test_random.h
104
- - assets/include/SDL2/SDL_thread.h
105
- - assets/include/SDL2/SDL_timer.h
106
- - assets/include/SDL2/SDL_touch.h
107
- - assets/include/SDL2/SDL_ttf.h
108
- - assets/include/SDL2/SDL_types.h
109
- - assets/include/SDL2/SDL_version.h
110
- - assets/include/SDL2/SDL_video.h
111
- - assets/include/SDL2/SDL_vulkan.h
112
- - assets/include/SDL2/begin_code.h
113
- - assets/include/SDL2/close_code.h
114
- - assets/macos/universal/lib/libFLAC.a
115
- - assets/macos/universal/lib/libSDL2.a
116
- - assets/macos/universal/lib/libSDL2_mixer.a
117
- - assets/macos/universal/lib/libmodplug.a
118
- - assets/macos/universal/lib/libmpg123.a
119
- - assets/macos/universal/lib/libogg.a
120
- - assets/macos/universal/lib/libvorbis.a
121
- - assets/macos/universal/lib/libvorbisfile.a
122
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libFLAC.a
123
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libSDL2.a
124
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libSDL2_mixer.a
125
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libmodplug.a
126
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libmpg123.a
127
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libogg.a
128
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libopus.a
129
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libopusfile.a
130
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libsndfile.a
131
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libstdc++.a
132
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libvorbis.a
133
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libvorbisfile.a
134
- - assets/windows/mingw-w64-ucrt-x86_64/lib/libz.a
135
- - assets/windows/mingw-w64-x86_64/lib/libFLAC.a
136
- - assets/windows/mingw-w64-x86_64/lib/libSDL2.a
137
- - assets/windows/mingw-w64-x86_64/lib/libSDL2_mixer.a
138
- - assets/windows/mingw-w64-x86_64/lib/libmodplug.a
139
- - assets/windows/mingw-w64-x86_64/lib/libmpg123.a
140
- - assets/windows/mingw-w64-x86_64/lib/libogg.a
141
- - assets/windows/mingw-w64-x86_64/lib/libopus.a
142
- - assets/windows/mingw-w64-x86_64/lib/libopusfile.a
143
- - assets/windows/mingw-w64-x86_64/lib/libsndfile.a
144
- - assets/windows/mingw-w64-x86_64/lib/libstdc++.a
145
- - assets/windows/mingw-w64-x86_64/lib/libvorbis.a
146
- - assets/windows/mingw-w64-x86_64/lib/libvorbisfile.a
147
- - assets/windows/mingw-w64-x86_64/lib/libz.a
20
+ - LICENSE
21
+ - README.md
148
22
  - ext/audio/audio.c
149
- - ext/audio/extconf.h
150
23
  - ext/audio/extconf.rb
24
+ - ext/audio/miniaudio.h
25
+ - lib/dummy_audio.rb
151
26
  - lib/native_audio.rb
152
27
  homepage: https://github.com/rubyrpg/native_audio
153
28
  licenses:
@@ -167,7 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
167
42
  - !ruby/object:Gem::Version
168
43
  version: '0'
169
44
  requirements: []
170
- rubygems_version: 3.6.2
45
+ rubygems_version: 4.0.3
171
46
  specification_version: 4
172
47
  summary: A simple audio library for Ruby
173
48
  test_files: []
@@ -1,233 +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.h
24
- *
25
- * Main include header for the SDL library
26
- */
27
-
28
-
29
- #ifndef SDL_h_
30
- #define SDL_h_
31
-
32
- #include "SDL_main.h"
33
- #include "SDL_stdinc.h"
34
- #include "SDL_assert.h"
35
- #include "SDL_atomic.h"
36
- #include "SDL_audio.h"
37
- #include "SDL_clipboard.h"
38
- #include "SDL_cpuinfo.h"
39
- #include "SDL_endian.h"
40
- #include "SDL_error.h"
41
- #include "SDL_events.h"
42
- #include "SDL_filesystem.h"
43
- #include "SDL_gamecontroller.h"
44
- #include "SDL_guid.h"
45
- #include "SDL_haptic.h"
46
- #include "SDL_hidapi.h"
47
- #include "SDL_hints.h"
48
- #include "SDL_joystick.h"
49
- #include "SDL_loadso.h"
50
- #include "SDL_log.h"
51
- #include "SDL_messagebox.h"
52
- #include "SDL_metal.h"
53
- #include "SDL_mutex.h"
54
- #include "SDL_power.h"
55
- #include "SDL_render.h"
56
- #include "SDL_rwops.h"
57
- #include "SDL_sensor.h"
58
- #include "SDL_shape.h"
59
- #include "SDL_system.h"
60
- #include "SDL_thread.h"
61
- #include "SDL_timer.h"
62
- #include "SDL_version.h"
63
- #include "SDL_video.h"
64
- #include "SDL_locale.h"
65
- #include "SDL_misc.h"
66
-
67
- #include "begin_code.h"
68
- /* Set up for C function definitions, even when using C++ */
69
- #ifdef __cplusplus
70
- extern "C" {
71
- #endif
72
-
73
- /* As of version 0.5, SDL is loaded dynamically into the application */
74
-
75
- /**
76
- * \name SDL_INIT_*
77
- *
78
- * These are the flags which may be passed to SDL_Init(). You should
79
- * specify the subsystems which you will be using in your application.
80
- */
81
- /* @{ */
82
- #define SDL_INIT_TIMER 0x00000001u
83
- #define SDL_INIT_AUDIO 0x00000010u
84
- #define SDL_INIT_VIDEO 0x00000020u /**< SDL_INIT_VIDEO implies SDL_INIT_EVENTS */
85
- #define SDL_INIT_JOYSTICK 0x00000200u /**< SDL_INIT_JOYSTICK implies SDL_INIT_EVENTS */
86
- #define SDL_INIT_HAPTIC 0x00001000u
87
- #define SDL_INIT_GAMECONTROLLER 0x00002000u /**< SDL_INIT_GAMECONTROLLER implies SDL_INIT_JOYSTICK */
88
- #define SDL_INIT_EVENTS 0x00004000u
89
- #define SDL_INIT_SENSOR 0x00008000u
90
- #define SDL_INIT_NOPARACHUTE 0x00100000u /**< compatibility; this flag is ignored. */
91
- #define SDL_INIT_EVERYTHING ( \
92
- SDL_INIT_TIMER | SDL_INIT_AUDIO | SDL_INIT_VIDEO | SDL_INIT_EVENTS | \
93
- SDL_INIT_JOYSTICK | SDL_INIT_HAPTIC | SDL_INIT_GAMECONTROLLER | SDL_INIT_SENSOR \
94
- )
95
- /* @} */
96
-
97
- /**
98
- * Initialize the SDL library.
99
- *
100
- * SDL_Init() simply forwards to calling SDL_InitSubSystem(). Therefore, the
101
- * two may be used interchangeably. Though for readability of your code
102
- * SDL_InitSubSystem() might be preferred.
103
- *
104
- * The file I/O (for example: SDL_RWFromFile) and threading (SDL_CreateThread)
105
- * subsystems are initialized by default. Message boxes
106
- * (SDL_ShowSimpleMessageBox) also attempt to work without initializing the
107
- * video subsystem, in hopes of being useful in showing an error dialog when
108
- * SDL_Init fails. You must specifically initialize other subsystems if you
109
- * use them in your application.
110
- *
111
- * Logging (such as SDL_Log) works without initialization, too.
112
- *
113
- * `flags` may be any of the following OR'd together:
114
- *
115
- * - `SDL_INIT_TIMER`: timer subsystem
116
- * - `SDL_INIT_AUDIO`: audio subsystem
117
- * - `SDL_INIT_VIDEO`: video subsystem; automatically initializes the events
118
- * subsystem
119
- * - `SDL_INIT_JOYSTICK`: joystick subsystem; automatically initializes the
120
- * events subsystem
121
- * - `SDL_INIT_HAPTIC`: haptic (force feedback) subsystem
122
- * - `SDL_INIT_GAMECONTROLLER`: controller subsystem; automatically
123
- * initializes the joystick subsystem
124
- * - `SDL_INIT_EVENTS`: events subsystem
125
- * - `SDL_INIT_EVERYTHING`: all of the above subsystems
126
- * - `SDL_INIT_NOPARACHUTE`: compatibility; this flag is ignored
127
- *
128
- * Subsystem initialization is ref-counted, you must call SDL_QuitSubSystem()
129
- * for each SDL_InitSubSystem() to correctly shutdown a subsystem manually (or
130
- * call SDL_Quit() to force shutdown). If a subsystem is already loaded then
131
- * this call will increase the ref-count and return.
132
- *
133
- * \param flags subsystem initialization flags
134
- * \returns 0 on success or a negative error code on failure; call
135
- * SDL_GetError() for more information.
136
- *
137
- * \since This function is available since SDL 2.0.0.
138
- *
139
- * \sa SDL_InitSubSystem
140
- * \sa SDL_Quit
141
- * \sa SDL_SetMainReady
142
- * \sa SDL_WasInit
143
- */
144
- extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
145
-
146
- /**
147
- * Compatibility function to initialize the SDL library.
148
- *
149
- * In SDL2, this function and SDL_Init() are interchangeable.
150
- *
151
- * \param flags any of the flags used by SDL_Init(); see SDL_Init for details.
152
- * \returns 0 on success or a negative error code on failure; call
153
- * SDL_GetError() for more information.
154
- *
155
- * \since This function is available since SDL 2.0.0.
156
- *
157
- * \sa SDL_Init
158
- * \sa SDL_Quit
159
- * \sa SDL_QuitSubSystem
160
- */
161
- extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
162
-
163
- /**
164
- * Shut down specific SDL subsystems.
165
- *
166
- * If you start a subsystem using a call to that subsystem's init function
167
- * (for example SDL_VideoInit()) instead of SDL_Init() or SDL_InitSubSystem(),
168
- * SDL_QuitSubSystem() and SDL_WasInit() will not work. You will need to use
169
- * that subsystem's quit function (SDL_VideoQuit()) directly instead. But
170
- * generally, you should not be using those functions directly anyhow; use
171
- * SDL_Init() instead.
172
- *
173
- * You still need to call SDL_Quit() even if you close all open subsystems
174
- * with SDL_QuitSubSystem().
175
- *
176
- * \param flags any of the flags used by SDL_Init(); see SDL_Init for details.
177
- *
178
- * \since This function is available since SDL 2.0.0.
179
- *
180
- * \sa SDL_InitSubSystem
181
- * \sa SDL_Quit
182
- */
183
- extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
184
-
185
- /**
186
- * Get a mask of the specified subsystems which are currently initialized.
187
- *
188
- * \param flags any of the flags used by SDL_Init(); see SDL_Init for details.
189
- * \returns a mask of all initialized subsystems if `flags` is 0, otherwise it
190
- * returns the initialization status of the specified subsystems.
191
- *
192
- * The return value does not include SDL_INIT_NOPARACHUTE.
193
- *
194
- * \since This function is available since SDL 2.0.0.
195
- *
196
- * \sa SDL_Init
197
- * \sa SDL_InitSubSystem
198
- */
199
- extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
200
-
201
- /**
202
- * Clean up all initialized subsystems.
203
- *
204
- * You should call this function even if you have already shutdown each
205
- * initialized subsystem with SDL_QuitSubSystem(). It is safe to call this
206
- * function even in the case of errors in initialization.
207
- *
208
- * If you start a subsystem using a call to that subsystem's init function
209
- * (for example SDL_VideoInit()) instead of SDL_Init() or SDL_InitSubSystem(),
210
- * then you must use that subsystem's quit function (SDL_VideoQuit()) to shut
211
- * it down before calling SDL_Quit(). But generally, you should not be using
212
- * those functions directly anyhow; use SDL_Init() instead.
213
- *
214
- * You can use this function with atexit() to ensure that it is run when your
215
- * application is shutdown, but it is not wise to do this from a library or
216
- * other dynamically loaded code.
217
- *
218
- * \since This function is available since SDL 2.0.0.
219
- *
220
- * \sa SDL_Init
221
- * \sa SDL_QuitSubSystem
222
- */
223
- extern DECLSPEC void SDLCALL SDL_Quit(void);
224
-
225
- /* Ends C function definitions when using C++ */
226
- #ifdef __cplusplus
227
- }
228
- #endif
229
- #include "close_code.h"
230
-
231
- #endif /* SDL_h_ */
232
-
233
- /* vi: set ts=4 sw=4 expandtab: */