Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_LoadWAV.3 @ 4107:4e3b250c950e SDL-1.2
Erik Heckers fixed bug #493
Searching the installed man pages for SDL functions fails, e.g.
man -k SDL_ |grep Video
After investigating this I found that "makewhatis", the tool that generates
the "whatis" database, reads the SDL_* man pages, but doesn't produce
entries in the "whatis" database for the SDL_* man pages.
After some more debugging I found the reason is a missing space.
After editing SDL_Init.3(.gz) and replacing
SDL_Init\- Initializes SDL
with
SDL_Init \- Initializes SDL
everything works fine.
After running "makewhatis" I can successfully do a
man -k SDL_
and SDL_Init is listed in the output.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sat, 29 Dec 2007 02:34:53 +0000 |
| parents | e5bc29de3f0a |
| children | 1238da4a7112 |
| rev | line source |
|---|---|
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_LoadWAV" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" |
| 0 | 2 .SH "NAME" |
|
4107
4e3b250c950e
Erik Heckers fixed bug #493
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
3 SDL_LoadWAV \- Load a WAVE file |
| 0 | 4 .SH "SYNOPSIS" |
| 5 .PP | |
| 6 \fB#include "SDL\&.h" | |
| 7 .sp | |
| 8 \fBSDL_AudioSpec *\fBSDL_LoadWAV\fP\fR(\fBconst char *file, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len\fR); | |
| 9 .SH "DESCRIPTION" | |
| 10 .PP | |
| 11 \fBSDL_LoadWAV\fP This function loads a WAVE \fBfile\fR into memory\&. | |
| 12 .PP | |
| 13 If this function succeeds, it returns the given \fI\fBSDL_AudioSpec\fP\fR, filled with the audio data format of the wave data, and sets \fBaudio_buf\fR to a \fBmalloc\fP\&'d buffer containing the audio data, and sets \fBaudio_len\fR to the length of that audio buffer, in bytes\&. You need to free the audio buffer with \fI\fBSDL_FreeWAV\fP\fR when you are done with it\&. | |
| 14 .PP | |
| 15 This function returns \fBNULL\fP and sets the SDL error message if the wave file cannot be opened, uses an unknown data format, or is corrupt\&. Currently raw, MS-ADPCM and IMA-ADPCM WAVE files are supported\&. | |
| 16 .SH "EXAMPLE" | |
| 17 .PP | |
| 18 .nf | |
| 19 \f(CWSDL_AudioSpec wav_spec; | |
| 20 Uint32 wav_length; | |
| 21 Uint8 *wav_buffer; | |
| 22 | |
| 23 /* Load the WAV */ | |
| 24 if( SDL_LoadWAV("test\&.wav", &wav_spec, &wav_buffer, &wav_length) == NULL ){ | |
| 25 fprintf(stderr, "Could not open test\&.wav: %s | |
| 26 ", SDL_GetError()); | |
| 27 exit(-1); | |
| 28 } | |
| 29 \&. | |
| 30 \&. | |
| 31 \&. | |
| 32 /* Do stuff with the WAV */ | |
| 33 \&. | |
| 34 \&. | |
| 35 /* Free It */ | |
| 36 SDL_FreeWAV(wav_buffer);\fR | |
| 37 .fi | |
| 38 .PP | |
| 39 .SH "SEE ALSO" | |
| 40 .PP | |
| 41 \fI\fBSDL_AudioSpec\fR\fR, \fI\fBSDL_OpenAudio\fP\fR, \fI\fBSDL_FreeWAV\fP\fR | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
42 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 |