Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
al_reserve_samples(3)	   Library Functions Manual	 al_reserve_samples(3)

NAME
       al_reserve_samples - Allegro 5 API

SYNOPSIS
	      #include <allegro5/allegro_audio.h>

	      bool al_reserve_samples(int reserve_samples)

DESCRIPTION
       Reserves	 a  number  of sample instances, attaching them	to the default
       mixer.  If no default mixer is set when this function is	 called,  then
       it  will	 create	one and	attach it to the default voice.	 If no default
       voice has been set, it, too, will be created.

       If you call this	function a second time with a smaller number  of  sam-
       ples, then the excess internal sample instances will be destroyed caus-
       ing  some  sounds  to  stop and some instances returned by al_lock_sam-
       ple_id(3) to be invalidated.

       This diagram illustrates	the structures that are	set up:

						    sample instance 1
						  / sample instance 2
	      default voice <--	default	mixer <---	   .
						  \	   .
						    sample instance N

       Returns true on success,	false on error.	 al_install_audio(3) must have
       been called first.

SEE ALSO
       al_set_default_mixer(3),	al_play_sample(3)

Allegro	reference manual				 al_reserve_samples(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=al_reserve_samples&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help