Initial revision
--HG-- extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/trunk%401
This commit is contained in:
commit
2f110628a7
892 changed files with 170313 additions and 0 deletions
23
docs/man3/SDL_BuildAudioCVT.3
Normal file
23
docs/man3/SDL_BuildAudioCVT.3
Normal file
|
@ -0,0 +1,23 @@
|
|||
.TH "SDL_BuildAudioCVT" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference"
|
||||
.SH "NAME"
|
||||
SDL_BuildAudioCVT\- Initializes a SDL_AudioCVT structure for conversion
|
||||
.SH "SYNOPSIS"
|
||||
.PP
|
||||
\fB#include "SDL\&.h"
|
||||
.sp
|
||||
\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);
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
Before an \fI\fBSDL_AudioCVT\fR\fR structure can be used to convert audio data it must be initialized with source and destination information\&.
|
||||
.PP
|
||||
\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\&.
|
||||
.SH "RETURN VALUES"
|
||||
.PP
|
||||
Returns \fB-1\fR if the filter could not be built or 1 if it could\&.
|
||||
.SH "EXAMPLES"
|
||||
.PP
|
||||
See \fI\fBSDL_ConvertAudio\fP\fR\&.
|
||||
.SH "SEE ALSO"
|
||||
.PP
|
||||
\fI\fBSDL_ConvertAudio\fP\fR, \fI\fBSDL_AudioCVT\fP\fR
|
||||
...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02
|
Loading…
Add table
Add a link
Reference in a new issue