diff --git a/reference/openal/functions/openal-buffer-create.xml b/reference/openal/functions/openal-buffer-create.xml index 4f3ac7b2c9..8a0bd93bcd 100644 --- a/reference/openal/functions/openal-buffer-create.xml +++ b/reference/openal/functions/openal-buffer-create.xml @@ -1,36 +1,36 @@ - - - - openal_buffer_create - - Generate OpenAL buffer - - - - &reftitle.description; - - resourceopenal_buffer_create - - - - - &reftitle.returnvalues; - - Returns an Open AL(Buffer) resource on success or - &false; on failure. - - - - &reftitle.seealso; - - - openal_buffer_loadwav - openal_buffer_data - - - - + + + + openal_buffer_create + + Generate OpenAL buffer + + + + &reftitle.description; + + resourceopenal_buffer_create + + + + + &reftitle.returnvalues; + + Returns an Open AL(Buffer) resource on success or + &false; on failure. + + + + &reftitle.seealso; + + + openal_buffer_loadwav + openal_buffer_data + + + + - - - openal_buffer_data - - Load a buffer with data - - - - &reftitle.description; - - boolopenal_buffer_data - resourcebuffer - intformat - stringdata - intfreq - - - - &reftitle.parameters; - - - buffer - - - An Open AL(Buffer) resource - (previously created by openal_buffer_create). - - - - - format - - - Format of data, one of: - AL_FORMAT_MONO8, - AL_FORMAT_MONO16, - AL_FORMAT_STEREO8&listendand; - AL_FORMAT_STEREO16 - - - - - data - - - Block of binary audio data in the format and - freq specified. - - - - - freq - - - Frequency of data given in Hz. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_buffer_loadwav - openal_stream - - - - + + + + openal_buffer_data + + Load a buffer with data + + + + &reftitle.description; + + boolopenal_buffer_data + resourcebuffer + intformat + stringdata + intfreq + + + + &reftitle.parameters; + + + buffer + + + An Open AL(Buffer) resource + (previously created by openal_buffer_create). + + + + + format + + + Format of data, one of: + AL_FORMAT_MONO8, + AL_FORMAT_MONO16, + AL_FORMAT_STEREO8&listendand; + AL_FORMAT_STEREO16 + + + + + data + + + Block of binary audio data in the format and + freq specified. + + + + + freq + + + Frequency of data given in Hz. + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_buffer_loadwav + openal_stream + + + + - - - openal_buffer_destroy - - Destroys an OpenAL buffer - - - - &reftitle.description; - - boolopenal_buffer_destroy - resourcebuffer - - - - &reftitle.parameters; - - - buffer - - - An Open AL(Buffer) resource - (previously created by openal_buffer_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_buffer_create - - - - + + + + openal_buffer_destroy + + Destroys an OpenAL buffer + + + + &reftitle.description; + + boolopenal_buffer_destroy + resourcebuffer + + + + &reftitle.parameters; + + + buffer + + + An Open AL(Buffer) resource + (previously created by openal_buffer_create). + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_buffer_create + + + + - - - openal_buffer_get - - Retrieve an OpenAL buffer property - - - - &reftitle.description; - - intopenal_buffer_get - resourcebuffer - intproperty - - - - &reftitle.parameters; - - - buffer - - - An Open AL(Buffer) resource - (previously created by openal_buffer_create). - - - - - property - - - Specific property, one of: - AL_FREQUENCY, - AL_BITS, - AL_CHANNELS&listendand; - AL_SIZE. - - - + + + + openal_buffer_get + + Retrieve an OpenAL buffer property + + + + &reftitle.description; + + intopenal_buffer_get + resourcebuffer + intproperty + + + + &reftitle.parameters; + + + buffer + + + An Open AL(Buffer) resource + (previously created by openal_buffer_create). + + + + + property + + + Specific property, one of: + AL_FREQUENCY, + AL_BITS, + AL_CHANNELS&listendand; + AL_SIZE. + + + - - - - &reftitle.returnvalues; - - Returns an integer value appropriate to the property - requested or &false; on failure. - - - - &reftitle.seealso; - - - openal_buffer_create - - - - + + + + &reftitle.returnvalues; + + Returns an integer value appropriate to the property + requested or &false; on failure. + + + + &reftitle.seealso; + + + openal_buffer_create + + + + - - - openal_buffer_loadwav - - Load a .wav file into a buffer - - - - &reftitle.description; - - boolopenal_buffer_loadwav - resourcebuffer - stringwavfile - - - - &reftitle.parameters; - - - buffer - - - An Open AL(Buffer) resource - (previously created by openal_buffer_create). - - - - - wavfile - - - Path to .WAV file on local file system. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_buffer_data - openal_stream - - - - + + + + openal_buffer_loadwav + + Load a .wav file into a buffer + + + + &reftitle.description; + + boolopenal_buffer_loadwav + resourcebuffer + stringwavfile + + + + &reftitle.parameters; + + + buffer + + + An Open AL(Buffer) resource + (previously created by openal_buffer_create). + + + + + wavfile + + + Path to .WAV file on local file system. + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_buffer_data + openal_stream + + + + - - - openal_context_create - - Create an audio processing context - - - - &reftitle.description; - - resourceopenal_context_create - resourcedevice - - - - &reftitle.parameters; - - - device - - - An Open AL(Device) resource - (previously created by openal_device_open). - - - - - - - &reftitle.returnvalues; - - Returns an Open AL(Context) resource on success or - &false; on failure. - - - - &reftitle.seealso; - - - openal_device_open - openal_context_destroy - - - - + + + + openal_context_create + + Create an audio processing context + + + + &reftitle.description; + + resourceopenal_context_create + resourcedevice + + + + &reftitle.parameters; + + + device + + + An Open AL(Device) resource + (previously created by openal_device_open). + + + + + + + &reftitle.returnvalues; + + Returns an Open AL(Context) resource on success or + &false; on failure. + + + + &reftitle.seealso; + + + openal_device_open + openal_context_destroy + + + + - - - openal_context_current - - Make the specified context current - - - - &reftitle.description; - - boolopenal_context_current - resourcecontext - - - - &reftitle.parameters; - - - context - - - An Open AL(Context) resource - (previously created by openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_context_create - - - - + + + + openal_context_current + + Make the specified context current + + + + &reftitle.description; + + boolopenal_context_current + resourcecontext + + + + &reftitle.parameters; + + + context + + + An Open AL(Context) resource + (previously created by openal_context_create). + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_context_create + + + + - - - openal_context_destroy - - Destroys a context - - - - &reftitle.description; - - boolopenal_context_destroy - resourcecontext - - - - &reftitle.parameters; - - - context - - - An Open AL(Context) resource - (previously created by openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_context_create - - - - + + + + openal_context_destroy + + Destroys a context + + + + &reftitle.description; + + boolopenal_context_destroy + resourcecontext + + + + &reftitle.parameters; + + + context + + + An Open AL(Context) resource + (previously created by openal_context_create). + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_context_create + + + + - - - openal_context_process - - Process the specified context - - - - &reftitle.description; - - boolopenal_context_process - resourcecontext - - - - &reftitle.parameters; - - - context - - - An Open AL(Context) resource - (previously created by openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_context_create - openal_context_current - openal_context_suspend - - - - + + + + openal_context_process + + Process the specified context + + + + &reftitle.description; + + boolopenal_context_process + resourcecontext + + + + &reftitle.parameters; + + + context + + + An Open AL(Context) resource + (previously created by openal_context_create). + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_context_create + openal_context_current + openal_context_suspend + + + + - - - openal_context_suspend - - Suspend the specified context - - - - &reftitle.description; - - boolopenal_context_suspend - resourcecontext - - - - &reftitle.parameters; - - - context - - - An Open AL(Context) resource - (previously created by openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_context_create - openal_context_current - openal_context_process - - - - + + + + openal_context_suspend + + Suspend the specified context + + + + &reftitle.description; + + boolopenal_context_suspend + resourcecontext + + + + &reftitle.parameters; + + + context + + + An Open AL(Context) resource + (previously created by openal_context_create). + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_context_create + openal_context_current + openal_context_process + + + + - - - openal_device_close - - Close an OpenAL device - - - - &reftitle.description; - - boolopenal_device_close - resourcedevice - - - - &reftitle.parameters; - - - device - - - An Open AL(Device) resource - (previously created by openal_device_open) - to be closed. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_device_open - - - - + + + + openal_device_close + + Close an OpenAL device + + + + &reftitle.description; + + boolopenal_device_close + resourcedevice + + + + &reftitle.parameters; + + + device + + + An Open AL(Device) resource + (previously created by openal_device_open) + to be closed. + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_device_open + + + + - - - openal_device_open - - Initialize the OpenAL audio layer - - - - &reftitle.description; - - resourceopenal_device_open - stringdevice_desc - - - - &reftitle.parameters; - - - device_desc - - - Open an audio device optionally specified by device_desc. - If device_desc is not specified the first available audio - device will be used. - - - - - - - &reftitle.returnvalues; - - Returns an Open AL(Device) resource on success or - &false; on failure. - - - - &reftitle.seealso; - - - openal_device_close - openal_context_create - - - - + + + + openal_device_open + + Initialize the OpenAL audio layer + + + + &reftitle.description; + + resourceopenal_device_open + stringdevice_desc + + + + &reftitle.parameters; + + + device_desc + + + Open an audio device optionally specified by device_desc. + If device_desc is not specified the first available audio + device will be used. + + + + + + + &reftitle.returnvalues; + + Returns an Open AL(Device) resource on success or + &false; on failure. + + + + &reftitle.seealso; + + + openal_device_close + openal_context_create + + + + - - - openal_listener_get - - Retrieve a listener property - - - - &reftitle.description; - - mixedopenal_listener_get - intproperty - - - - &reftitle.parameters; - - - property - - - Property to retrieve, one of: - AL_GAIN (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float))&listendand; - AL_ORIENTATION (array(float,float,float)). - - - - - - - &reftitle.returnvalues; - - Returns a float or array of floats (as appropriate), or &false; on failure. - - - - &reftitle.seealso; - - - openal_listener_set - - - - + + + + openal_listener_get + + Retrieve a listener property + + + + &reftitle.description; + + mixedopenal_listener_get + intproperty + + + + &reftitle.parameters; + + + property + + + Property to retrieve, one of: + AL_GAIN (float), + AL_POSITION (array(float,float,float)), + AL_VELOCITY (array(float,float,float))&listendand; + AL_ORIENTATION (array(float,float,float)). + + + + + + + &reftitle.returnvalues; + + Returns a float or array of floats (as appropriate), or &false; on failure. + + + + &reftitle.seealso; + + + openal_listener_set + + + + - - - openal_listener_set - - Set a listener property - - - - &reftitle.description; - - boolopenal_listener_set - intproperty - mixedsetting - - - - &reftitle.parameters; - - - property - - - Property to set, one of: - AL_GAIN (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float))&listendand; - AL_ORIENTATION (array(float,float,float)). - - - - - setting - - - Value to set, either float, or an array of floats as appropriate. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_listener_get - - - - + + + + openal_listener_set + + Set a listener property + + + + &reftitle.description; + + boolopenal_listener_set + intproperty + mixedsetting + + + + &reftitle.parameters; + + + property + + + Property to set, one of: + AL_GAIN (float), + AL_POSITION (array(float,float,float)), + AL_VELOCITY (array(float,float,float))&listendand; + AL_ORIENTATION (array(float,float,float)). + + + + + setting + + + Value to set, either float, or an array of floats as appropriate. + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_listener_get + + + + - - - openal_source_create - - Generate a source resource - - - - &reftitle.description; - - resourceopenal_source_create - - - - - &reftitle.returnvalues; - - Returns an Open AL(Source) resource on success or - &false; on failure. - - - - &reftitle.seealso; - - - openal_source_set - openal_source_play - openal_source_destroy - - - - + + + + openal_source_create + + Generate a source resource + + + + &reftitle.description; + + resourceopenal_source_create + + + + + &reftitle.returnvalues; + + Returns an Open AL(Source) resource on success or + &false; on failure. + + + + &reftitle.seealso; + + + openal_source_set + openal_source_play + openal_source_destroy + + + + - - - openal_source_destroy - - Destroy a source resource - - - - &reftitle.description; - - boolopenal_source_destroy - resourcesource - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_source_create - - - - + + + + openal_source_destroy + + Destroy a source resource + + + + &reftitle.description; + + boolopenal_source_destroy + resourcesource + + + + &reftitle.parameters; + + + source + + + An Open AL(Source) resource + (previously created by openal_source_create). + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_source_create + + + + - - - openal_source_get - - Retrieve an OpenAL source property - - - - &reftitle.description; - - mixedopenal_source_get - resourcesource - intproperty - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - property - - - Property to get, one of: - AL_SOURCE_RELATIVE (int), - AL_SOURCE_STATE (int), - AL_PITCH (float), - AL_GAIN (float), - AL_MIN_GAIN (float), - AL_MAX_GAIN (float), - AL_MAX_DISTANCE (float), - AL_ROLLOFF_FACTOR (float), - AL_CONE_OUTER_GAIN (float), - AL_CONE_INNER_ANGLE (float), - AL_CONE_OUTER_ANGLE (float), - AL_REFERENCE_DISTANCE (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float)), - AL_DIRECTION (array(float,float,float)). - - - - - - - &reftitle.returnvalues; - - Returns the type associated with the property being retrieved - or &false; on failure. - - - - &reftitle.seealso; - - - openal_source_create - openal_source_set - openal_source_play - - - - + + + + openal_source_get + + Retrieve an OpenAL source property + + + + &reftitle.description; + + mixedopenal_source_get + resourcesource + intproperty + + + + &reftitle.parameters; + + + source + + + An Open AL(Source) resource + (previously created by openal_source_create). + + + + + property + + + Property to get, one of: + AL_SOURCE_RELATIVE (int), + AL_SOURCE_STATE (int), + AL_PITCH (float), + AL_GAIN (float), + AL_MIN_GAIN (float), + AL_MAX_GAIN (float), + AL_MAX_DISTANCE (float), + AL_ROLLOFF_FACTOR (float), + AL_CONE_OUTER_GAIN (float), + AL_CONE_INNER_ANGLE (float), + AL_CONE_OUTER_ANGLE (float), + AL_REFERENCE_DISTANCE (float), + AL_POSITION (array(float,float,float)), + AL_VELOCITY (array(float,float,float)), + AL_DIRECTION (array(float,float,float)). + + + + + + + &reftitle.returnvalues; + + Returns the type associated with the property being retrieved + or &false; on failure. + + + + &reftitle.seealso; + + + openal_source_create + openal_source_set + openal_source_play + + + + - - - openal_source_pause - - Pause the source - - - - &reftitle.description; - - boolopenal_source_pause - resourcesource - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_source_stop - openal_source_play - openal_source_rewind - - - - + + + + openal_source_pause + + Pause the source + + + + &reftitle.description; + + boolopenal_source_pause + resourcesource + + + + &reftitle.parameters; + + + source + + + An Open AL(Source) resource + (previously created by openal_source_create). + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_source_stop + openal_source_play + openal_source_rewind + + + + - - - openal_source_play - - Start playing the source - - - - &reftitle.description; - - boolopenal_source_play - resourcesource - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_source_stop - openal_source_pause - openal_source_rewind - - - - + + + + openal_source_play + + Start playing the source + + + + &reftitle.description; + + boolopenal_source_play + resourcesource + + + + &reftitle.parameters; + + + source + + + An Open AL(Source) resource + (previously created by openal_source_create). + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_source_stop + openal_source_pause + openal_source_rewind + + + + - - - openal_source_rewind - - Rewind the source - - - - &reftitle.description; - - boolopenal_source_rewind - resourcesource - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_source_stop - openal_source_pause - openal_source_play - - - - + + + + openal_source_rewind + + Rewind the source + + + + &reftitle.description; + + boolopenal_source_rewind + resourcesource + + + + &reftitle.parameters; + + + source + + + An Open AL(Source) resource + (previously created by openal_source_create). + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_source_stop + openal_source_pause + openal_source_play + + + + - - - openal_source_set - - Set source property - - - - &reftitle.description; - - boolopenal_source_set - resourcesource - intproperty - mixedsetting - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - property - - - Property to set, one of: - AL_BUFFER (OpenAL(Source)), - AL_LOOPING (bool), - AL_SOURCE_RELATIVE (int), - AL_SOURCE_STATE (int), - AL_PITCH (float), - AL_GAIN (float), - AL_MIN_GAIN (float), - AL_MAX_GAIN (float), - AL_MAX_DISTANCE (float), - AL_ROLLOFF_FACTOR (float), - AL_CONE_OUTER_GAIN (float), - AL_CONE_INNER_ANGLE (float), - AL_CONE_OUTER_ANGLE (float), - AL_REFERENCE_DISTANCE (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float)), - AL_DIRECTION (array(float,float,float)). - - - - - setting - - - Value to assign to specified property. - Refer to the description of property - for a description of the value(s) expected. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_source_create - openal_source_get - openal_source_play - - - - + + + + openal_source_set + + Set source property + + + + &reftitle.description; + + boolopenal_source_set + resourcesource + intproperty + mixedsetting + + + + &reftitle.parameters; + + + source + + + An Open AL(Source) resource + (previously created by openal_source_create). + + + + + property + + + Property to set, one of: + AL_BUFFER (OpenAL(Source)), + AL_LOOPING (bool), + AL_SOURCE_RELATIVE (int), + AL_SOURCE_STATE (int), + AL_PITCH (float), + AL_GAIN (float), + AL_MIN_GAIN (float), + AL_MAX_GAIN (float), + AL_MAX_DISTANCE (float), + AL_ROLLOFF_FACTOR (float), + AL_CONE_OUTER_GAIN (float), + AL_CONE_INNER_ANGLE (float), + AL_CONE_OUTER_ANGLE (float), + AL_REFERENCE_DISTANCE (float), + AL_POSITION (array(float,float,float)), + AL_VELOCITY (array(float,float,float)), + AL_DIRECTION (array(float,float,float)). + + + + + setting + + + Value to assign to specified property. + Refer to the description of property + for a description of the value(s) expected. + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_source_create + openal_source_get + openal_source_play + + + + - - - openal_source_stop - - Stop playing the source - - - - &reftitle.description; - - boolopenal_source_stop - resourcesource - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - openal_source_play - openal_source_pause - openal_source_rewind - - - - + + + + openal_source_stop + + Stop playing the source + + + + &reftitle.description; + + boolopenal_source_stop + resourcesource + + + + &reftitle.parameters; + + + source + + + An Open AL(Source) resource + (previously created by openal_source_create). + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + openal_source_play + openal_source_pause + openal_source_rewind + + + + - - - openal_stream - - Begin streaming on a source - - - - &reftitle.description; - - resourceopenal_stream - resourcesource - intformat - intrate - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - format - - - Format of data, one of: - AL_FORMAT_MONO8, - AL_FORMAT_MONO16, - AL_FORMAT_STEREO8&listendand; - AL_FORMAT_STEREO16 - - - - - rate - - - Frequency of data to stream given in Hz. - - - - - - - &reftitle.returnvalues; - - Returns a stream resource on success, or &false; on failure. - - - - &reftitle.seealso; - - - openal_source_create - fwrite - - - - + + + + openal_stream + + Begin streaming on a source + + + + &reftitle.description; + + resourceopenal_stream + resourcesource + intformat + intrate + + + + &reftitle.parameters; + + + source + + + An Open AL(Source) resource + (previously created by openal_source_create). + + + + + format + + + Format of data, one of: + AL_FORMAT_MONO8, + AL_FORMAT_MONO16, + AL_FORMAT_STEREO8&listendand; + AL_FORMAT_STEREO16 + + + + + rate + + + Frequency of data to stream given in Hz. + + + + + + + &reftitle.returnvalues; + + Returns a stream resource on success, or &false; on failure. + + + + &reftitle.seealso; + + + openal_source_create + fwrite + + + +