PaUtilRingBuffer Struct Reference

#include <pa_ringbuffer.h>


Data Fields

ring_buffer_size_t bufferSize
ring_buffer_size_t writeIndex
ring_buffer_size_t readIndex
ring_buffer_size_t bigMask
ring_buffer_size_t smallMask
ring_buffer_size_t elementSizeBytes
char * buffer


Field Documentation

Used for wrapping indices with extra bit to distinguish full/empty.

Referenced by PaUtil_AdvanceRingBufferReadIndex(), PaUtil_AdvanceRingBufferWriteIndex(), PaUtil_GetRingBufferReadAvailable(), and PaUtil_InitializeRingBuffer().

Index of next readable element. Set by PaUtil_AdvanceRingBufferReadIndex.

Referenced by PaUtil_AdvanceRingBufferReadIndex(), PaUtil_FlushRingBuffer(), PaUtil_GetRingBufferReadAvailable(), and PaUtil_GetRingBufferReadRegions().

Index of next writable element. Set by PaUtil_AdvanceRingBufferWriteIndex.

Referenced by PaUtil_AdvanceRingBufferWriteIndex(), PaUtil_FlushRingBuffer(), PaUtil_GetRingBufferReadAvailable(), and PaUtil_GetRingBufferWriteRegions().


The documentation for this struct was generated from the following file:

Generated on Tue Aug 9 16:05:25 2011 for PortAudio by  doxygen 1.5.7.1