This is the sdl2-mixer Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:41:53 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
sdl2-mixerBindings for sdl2_mixer using autowrap
Ryan Pavlik <rpavlik@gmail.com>
MIT
1.0
alexandria (system).
cl-autowrap (system).
sdl2 (system).
trivial-garbage (system).
package.lisp (file).
library.lisp (file).
autowrap.lisp (file).
conditions.lisp (file).
general.lisp (file).
autowrap-spec (module).
Modules are listed depth-first from the system components tree.
sdl2-mixer/autowrap-specgeneral.lisp (file).
sdl2-mixer (system).
sdl_mixer.h (file).
Files are sorted by type and then listed depth-first from the systems components trees.
sdl2-mixer/sdl2-mixer.asdsdl2-mixer/package.lispsdl2-mixer/library.lispsdl2-mixer/autowrap.lispsdl2-mixer/conditions.lispsdl2-mixer/general.lispsdl2-mixer/library.lisppackage.lisp (file).
sdl2-mixer (system).
sdl2-mixer/autowrap.lisplibrary.lisp (file).
sdl2-mixer (system).
sdl2-mixer/conditions.lispautowrap.lisp (file).
sdl2-mixer (system).
sdl-mixer-error (condition).
check-non-zero (macro).
check-null (macro).
check-rc (macro).
check-true (macro).
sdl2-mixer/general.lispconditions.lisp (file).
sdl2-mixer (system).
allocate-channels (function).
close-audio (function).
free-chunk (function).
free-music (function).
halt-channel (function).
halt-music (function).
init (function).
linked-version (function).
load-music (function).
load-wav (function).
open-audio (function).
play-channel (function).
play-music (function).
playing (function).
query-spec (function).
quit (function).
volume (function).
volume-music (function).
create-sdl-free-function (macro).
Packages are listed by definition order.
sdl2-mixeralexandria.
autowrap.minimal.
common-lisp.
plus-c.
sdl2-ffi.functions.
allocate-channels (function).
close-audio (function).
free-chunk (function).
free-music (function).
halt-channel (function).
halt-music (function).
init (function).
linked-version (function).
load-music (function).
load-wav (function).
open-audio (function).
play-channel (function).
play-music (function).
playing (function).
query-spec (function).
quit (function).
sdl-mixer-error (condition).
volume (function).
volume-music (function).
check-non-zero (macro).
check-null (macro).
check-rc (macro).
check-true (macro).
create-sdl-free-function (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Set the number of channels to be mixed. Opening too many channels may result in a segfault. This can be called at any time even while samples are playing. Passing a number lower than previous calls will close unused channels. It returns the number of channels allocated. NOTE: Channels are 0 indexed!
Closes the mixer
Free the memory used in the chunk and then free the chunk itself. Do not free the chunk while it is playing; halt the channel it’s playing on using halt-channel prior to freeing the chunk.
Halt the channel or pass -1 to halt all channels. Always returns 0. NOTE: Channels are 0 indexed!
Halts the playback of all music
Initialize the SDL mixer specifying the formats you wish to use. Must be one of these values or a combination thereof :ogg, :wave, :mod, :mp3
Returns the version number for SDL Mixer 2
Loads music from a file. Returns a mix-music object
Loads the sample specified by the sample-file-name. Returns a mix-chunk. sdl2-mixer must be initialized and open-audio must be called prior to.
Initialize the mixer specifiying the output sample format, number of output channels (1 mono or 2 for stereo), and bytes used per output sample. format must be one of the following values, :u8, :s8, :u16lsb, :s16lsb, :u16msb, :s16msb, :u16, :s16, :u16sys, :s16sys
Plays the mix-chunk (sound effect) loops+1 times on a given channel. Passing -1 for the channel will play it on the first unreserved channel. Returns the channel the sample is played on. NOTE: Channels are 0 indexed!
Play the music as many times as specified by the optional loops argument. By default loops is -1 which makes the music loop indefinitely. Returns 0 on success -1 on error
Checks whether or not a channel is currently playing. It will return a 1 for playing and 0 otherwise. Passing -1 for the channel will specify how many channels are playing.
Gets the output format in use by the opened audio device
Cleans up SDL Mixer
Set the volume on a given channel, pass -1 to set the volume for all channels. The volume may range from 0 to 128. Passing in a number higher than the maximum will automatically set it to the maximum while passing in a negatiev will automatically set it to 0. Returns the current volume of the channel. NOTE: Channels are 0 indexed!
Adjust the volume of the music. Volume ranges from 0 to 128. The return value is an integer that usually represents the previous volume setting. Passing -1 as the music volume does not change the volume but instead returns the current volume setting
| Jump to: | A C F H I L M O P Q V |
|---|
| Jump to: | A C F H I L M O P Q V |
|---|
| Jump to: | A C F G L M P S |
|---|
| Jump to: | A C F G L M P S |
|---|