File: al_set_sample_instance_pan.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (32 lines) | stat: -rw-r--r-- 914 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
.TH "al_set_sample_instance_pan" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_set_sample_instance_pan \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

bool\ al_set_sample_instance_pan(ALLEGRO_SAMPLE_INSTANCE\ *spl,\ float\ val)
\f[]
.fi
.SH DESCRIPTION
.PP
Set the pan value on a sample instance.
A value of \-1.0 means to play the sample only through the left speaker;
+1.0 means only through the right speaker; 0.0 means the sample is
centre balanced.
A special value ALLEGRO_AUDIO_PAN_NONE(3) disables panning and plays the
sample at its original level.
This will be louder than a pan value of 0.0.
.RS
.PP
Note: panning samples with more than two channels doesn\[aq]t work yet.
.RE
.PP
Returns true on success, false on failure.
Will fail if the sample instance is attached directly to a voice.
.SH SEE ALSO
.PP
al_get_sample_instance_pan(3), ALLEGRO_AUDIO_PAN_NONE(3)