Mercurial > sdl-ios-xcode

comparison docs/man3/SDL_BuildAudioCVT.3 @ 0:74212992fb08

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
comparison
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
1 .TH "SDL_BuildAudioCVT" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference"
2 .SH "NAME"
3 SDL_BuildAudioCVT\- Initializes a SDL_AudioCVT structure for conversion
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 .sp
8 \fBint \fBSDL_BuildAudioCVT\fP\fR(\fBSDL_AudioCVT *cvt, Uint16 src_format, Uint8 src_channels, int src_rate, Uint16 dst_format, Uint8 dst_channels, int dst_rate\fR);
9 .SH "DESCRIPTION"
10 .PP
11 Before an \fI\fBSDL_AudioCVT\fR\fR structure can be used to convert audio data it must be initialized with source and destination information\&.
12 .PP
13 \fBsrc_format\fR and \fBdst_format\fR are the source and destination format of the conversion\&. (For information on audio formats see \fI\fB SDL_AudioSpec\fR\fR)\&. \fBsrc_channels\fR and \fBdst_channels\fR are the number of channels in the source and destination formats\&. Finally, \fBsrc_rate\fR and \fBdst_rate\fR are the frequency or samples-per-second of the source and destination formats\&. Once again, see \fI\fBSDL_AudioSpec\fR\fR\&.
14 .SH "RETURN VALUES"
15 .PP
16 Returns \fB-1\fR if the filter could not be built or 1 if it could\&.
17 .SH "EXAMPLES"
18 .PP
19 See \fI\fBSDL_ConvertAudio\fP\fR\&.
20 .SH "SEE ALSO"
21 .PP
22 \fI\fBSDL_ConvertAudio\fP\fR, \fI\fBSDL_AudioCVT\fP\fR
23 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02