File: al_destroy_sample.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 (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_destroy_sample" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_destroy_sample \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

void\ al_destroy_sample(ALLEGRO_SAMPLE\ *spl)
\f[]
.fi
.SH DESCRIPTION
.PP
Free the sample data structure.
If it was created with the \f[C]free_buf\f[] parameter set to true, then
the buffer will be freed with al_free(3).
.PP
This function will stop any sample instances which may be playing the
buffer referenced by the ALLEGRO_SAMPLE(3).
.SH SEE ALSO
.PP
al_destroy_sample_instance(3), al_stop_sample(3), al_stop_samples(3)