OpenShot Audio Library | OpenShotAudio  0.3.0
juce::AbstractFifo::ScopedReadWrite< mode > Class Template Referencefinal

#include <juce_AbstractFifo.h>

Public Member Functions

 ScopedReadWrite ()=default
 
 ScopedReadWrite (AbstractFifo &f, int num) noexcept
 
 ScopedReadWrite (const ScopedReadWrite &)=delete
 
 ScopedReadWrite (ScopedReadWrite &&) noexcept
 
ScopedReadWriteoperator= (const ScopedReadWrite &)=delete
 
ScopedReadWriteoperator= (ScopedReadWrite &&) noexcept
 
 ~ScopedReadWrite () noexcept
 
template<typename FunctionToApply >
void forEach (FunctionToApply &&func) const
 

Public Attributes

int startIndex1
 
int blockSize1
 
int startIndex2
 
int blockSize2
 

Detailed Description

template<ReadOrWrite mode>
class juce::AbstractFifo::ScopedReadWrite< mode >

Class for a scoped reader/writer

Definition at line 211 of file juce_AbstractFifo.h.

Constructor & Destructor Documentation

◆ ScopedReadWrite() [1/2]

template<ReadOrWrite mode>
juce::AbstractFifo::ScopedReadWrite< mode >::ScopedReadWrite ( )
default

Construct an unassigned reader/writer. Doesn't do anything upon destruction.

◆ ScopedReadWrite() [2/2]

template<ReadOrWrite mode>
juce::AbstractFifo::ScopedReadWrite< mode >::ScopedReadWrite ( AbstractFifo f,
int  num 
)
inlinenoexcept

Construct a reader/writer and immediately call prepareRead/prepareWrite on the abstractFifo which was passed in. This object will hold a pointer back to the fifo, so make sure that the fifo outlives this object.

Definition at line 222 of file juce_AbstractFifo.h.

◆ ~ScopedReadWrite()

template<ReadOrWrite mode>
juce::AbstractFifo::ScopedReadWrite< mode >::~ScopedReadWrite ( )
inlinenoexcept

Calls finishedRead or finishedWrite if this is a non-null scoped reader/writer.

Definition at line 236 of file juce_AbstractFifo.h.

Member Function Documentation

◆ forEach()

template<ReadOrWrite mode>
template<typename FunctionToApply >
void juce::AbstractFifo::ScopedReadWrite< mode >::forEach ( FunctionToApply &&  func) const
inline

Calls the passed function with each index that was deemed valid for the current read/write operation.

Definition at line 246 of file juce_AbstractFifo.h.


The documentation for this class was generated from the following files: