File: al_destroy_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 (27 lines) | stat: -rw-r--r-- 655 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
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_destroy_sample" "3" "" "Allegro reference manual" ""
.hy
.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)