comparison docs/man3/SDL_MixAudio.3 @ 181:e5bc29de3f0a

Updated from the SDL Documentation Project
author Sam Lantinga <slouken@libsdl.org>
date Fri, 14 Sep 2001 02:41:09 +0000
parents 55f1f1b3e27d
children 546f7c1eb755
comparison
equal deleted inserted replaced
180:578815880307 181:e5bc29de3f0a
1 .TH "SDL_MixAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" 1 .TH "SDL_MixAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
2 .SH "NAME" 2 .SH "NAME"
3 SDL_MixAudio\- Mix audio data 3 SDL_MixAudio\- Mix audio data
4 .SH "SYNOPSIS" 4 .SH "SYNOPSIS"
5 .PP 5 .PP
6 \fB#include "SDL\&.h" 6 \fB#include "SDL\&.h"
7 .sp 7 .sp
8 \fBvoid \fBSDL_MixAudio\fP\fR(\fBUint8 *dst, Uint8 *src, Uint32 len, int volume\fR); 8 \fBvoid \fBSDL_MixAudio\fP\fR(\fBUint8 *dst, Uint8 *src, Uint32 len, int volume\fR);
9 .SH "DESCRIPTION" 9 .SH "DESCRIPTION"
10 .PP 10 .PP
11 This function takes two audio buffers of \fBlen\fR bytes each of the playing audio format and mixes them, performing addition, volume adjustment, and overflow clipping\&. The \fBvolume\fR ranges from 0 to \fBSDL_MIX_MAXVOLUME\fP and should be set to the maximum value for full audio volume\&. Note this does not change hardware volume\&. This is provided for convenience -- you can mix your own audio data\&. 11 This function takes two audio buffers of \fBlen\fR bytes each of the playing audio format and mixes them, performing addition, volume adjustment, and overflow clipping\&. The \fBvolume\fR ranges from 0 to \fBSDL_MIX_MAXVOLUME\fP and should be set to the maximum value for full audio volume\&. Note this does not change hardware volume\&. This is provided for convenience -- you can mix your own audio data\&.
12 .PP
13 .RS
14 \fBNote:
15 .PP
16 Do not use this function for mixing together more than two streams of sample data\&. The output from repeated application of this function may be distorted by clipping, because there is no accumulator with greater range than the input (not to mention this being an inefficient way of doing it)\&. Use mixing functions from SDL_mixer, OpenAL, or write your own mixer instead\&.
17 .RE
12 .SH "SEE ALSO" 18 .SH "SEE ALSO"
13 .PP 19 .PP
14 \fI\fBSDL_OpenAudio\fP\fR 20 \fI\fBSDL_OpenAudio\fP\fR
15 ...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 21 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58