ryujinx/libsoundio
1
0
Fork 0
mirror of https://github.com/Ryujinx/libsoundio.git synced 2024-12-22 23:45:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: move ring buffer docs to work around doxygen limitation

Browse source 
closes #113
This commit is contained in:
Andrew Kelley 2016-10-23 16:38:21 -04:00
parent 6703021eba
commit 9557eb7b60
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
soundio/soundio.h
View file

@ -1163,11 +1163,12 @@ SOUNDIO_EXPORT int soundio_instream_get_latency(struct SoundIoInStream *instream
double *out_latency); double *out_latency);
struct SoundIoRingBuffer;
/// A ring buffer is a single-reader single-writer lock-free fixed-size queue. /// A ring buffer is a single-reader single-writer lock-free fixed-size queue.
/// libsoundio ring buffers use memory mapping techniques to enable a /// libsoundio ring buffers use memory mapping techniques to enable a
/// contiguous buffer when reading or writing across the boundary of the ring /// contiguous buffer when reading or writing across the boundary of the ring
/// buffer's capacity. /// buffer's capacity.
struct SoundIoRingBuffer;
/// `requested_capacity` in bytes. /// `requested_capacity` in bytes.
/// Returns `NULL` if and only if memory could not be allocated. /// Returns `NULL` if and only if memory could not be allocated.
/// Use ::soundio_ring_buffer_capacity to get the actual capacity, which might /// Use ::soundio_ring_buffer_capacity to get the actual capacity, which might