File: al_unlock_sample_id.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 (33 lines) | stat: -rw-r--r-- 757 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
31
32
33
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_unlock_sample_id" "3" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_unlock_sample_id \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

void\ al_unlock_sample_id(ALLEGRO_SAMPLE_ID\ *spl_id)
\f[]
.fi
.SH DESCRIPTION
.PP
Unlocks a ALLEGRO_SAMPLE_ID(3), allowing future calls to
al_play_sample(3) to reuse it if possible.
Note that after the id is unlocked, the ALLEGRO_SAMPLE_INSTANCE(3) that
was previously returned by al_lock_sample_id(3) will possibly be playing
a different sound, so you should only use it after locking the id again.
.SH SEE ALSO
.PP
al_play_sample(3), al_lock_sample_id(3)
.SH SINCE
.PP
5.2.3
.RS
.PP
\f[I][Unstable API]:\f[] New API.
.RE