File: al_create_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 (37 lines) | stat: -rw-r--r-- 1,038 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
34
35
36
37
.TH al_create_sample 3 "" "Allegro reference manual"
.SH NAME
.PP
al_create_sample \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

ALLEGRO_SAMPLE\ *al_create_sample(void\ *buf,\ unsigned\ int\ samples,
\ \ \ unsigned\ int\ freq,\ ALLEGRO_AUDIO_DEPTH\ depth,
\ \ \ ALLEGRO_CHANNEL_CONF\ chan_conf,\ bool\ free_buf)
\f[]
.fi
.SH DESCRIPTION
.PP
Create a sample data structure from the supplied buffer.
If \f[C]free_buf\f[] is true then the buffer will be freed with
al_free(3) when the sample data structure is destroyed.
For portability (especially Windows), the buffer should have been
allocated with al_malloc(3).
Otherwise you should free the sample data yourself.
.PP
To allocate a buffer of the correct size, you can use something like
this:
.IP
.nf
\f[C]
sample_size\ =\ al_get_channel_count(chan_conf)\ *\ al_get_audio_depth_size(depth);
bytes\ =\ samples\ *\ sample_size;
buffer\ =\ al_malloc(bytes);
\f[]
.fi
.SH SEE ALSO
.PP
al_destroy_sample(3), ALLEGRO_AUDIO_DEPTH(3), ALLEGRO_CHANNEL_CONF(3)