File: al_get_sample.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 (24 lines) | stat: -rw-r--r-- 600 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
.TH al_get_sample 3 "" "Allegro reference manual"
.SH NAME
.PP
al_get_sample \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

ALLEGRO_SAMPLE\ *al_get_sample(ALLEGRO_SAMPLE_INSTANCE\ *spl)
\f[]
.fi
.SH DESCRIPTION
.PP
Return the sample data that the sample instance plays.
.PP
Note this returns a pointer to an internal structure, \f[I]not\f[] the
ALLEGRO_SAMPLE(3) that you may have passed to al_set_sample(3).
You may, however, check which sample buffer is being played by the
sample instance with al_get_sample_data(3), and so on.
.SH SEE ALSO
.PP
al_set_sample(3)