File: al_get_sample.3

package info (click to toggle)
allegro5 2%3A5.2.6.0-3%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 24,212 kB
  • sloc: ansic: 125,319; cpp: 15,781; objc: 4,579; python: 2,802; java: 2,254; javascript: 1,204; sh: 1,002; makefile: 51; perl: 37; xml: 25; pascal: 24
file content (30 lines) | stat: -rw-r--r-- 776 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
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_get_sample" "3" "" "Allegro reference manual" ""
.hy
.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).
However, the sample buffer of the returned ALLEGRO_SAMPLE will be the
same as the one that was used to create the sample (passed to
al_create_sample(3)).
You can use al_get_sample_data(3) on the return value to retrieve and
compare it.
.SH SEE ALSO
.PP
al_set_sample(3)