SignalUtils::PeekCircularBuffer Function

int PeekCircularBuffer(const TCircularBufferState &State);

Get the number of available samples within the circular buffer.

#NameTypeDescription
1Stateconst TCircularBufferState &
Remarks:

Returns number of available samples, that can be read by ReadFromCircularBuffer. This function allows you to guard against buffer underflow. (reading data that is not there yet)

See Also: SignalUtils::InitCircularBuffer, SignalUtils::WriteToCircularBuffer, SignalUtils::ResizeCircularBuffer, SignalUtils::MonitorCircularBuffer
Declared in Dew::Signal::Units::SignalUtils · Dew.Signal/Units.SignalUtils.h · Cross-compiler