File: al_attach_sample_instance_to_voice.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (30 lines) | stat: -rw-r--r-- 800 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
.TH al_attach_sample_instance_to_voice 3 "" "Allegro reference manual"
.SH NAME
.PP
al_attach_sample_instance_to_voice \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

bool\ al_attach_sample_instance_to_voice(ALLEGRO_SAMPLE_INSTANCE\ *spl,
\ \ \ ALLEGRO_VOICE\ *voice)
\f[]
.fi
.SH DESCRIPTION
.PP
Attaches a sample to a voice, and allows it to play.
The sample\[aq]s volume and loop mode will be ignored, and it must have
the same frequency and depth (including signed\-ness) as the voice.
This function may fail if the selected driver doesn\[aq]t support
preloading sample data.
.PP
At this time, we don\[aq]t recommend attaching samples directly to
voices.
Use a mixer in between.
.PP
Returns true on success, false on failure.
.SH SEE ALSO
.PP
al_detach_voice(3)