UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::TDeinterleaveView< T >::TChannelIterator< InAllocator > Class Template Reference

#include <DeinterleaveView.h>

Public Member Functions

 TChannelIterator (TDeinterleaveView< T > InDeinterleaveView, TArray< T, InAllocator > &InArrayToFill, int32 InChannelIndex)
 
TChannelIteratoroperator++ ()
 
bool operator!= (const TChannelIterator &Other) const
 
int32 GetChannelIndex () const
 
TChannel< InAllocatoroperator* ()
 

Static Public Attributes

static const int32 ChannelIndexEnd = INDEX_NONE
 

Detailed Description

template<typename T>
template<typename InAllocator = FDefaultAllocator>
class Audio::TDeinterleaveView< T >::TChannelIterator< InAllocator >

TChannelIterator

TChannelIterator iterates over channels in an interleaved array and providing contiguous arrays of a single channel.

Constructor & Destructor Documentation

◆ TChannelIterator()

template<typename T >
template<typename InAllocator = FDefaultAllocator>
Audio::TDeinterleaveView< T >::TChannelIterator< InAllocator >::TChannelIterator ( TDeinterleaveView< T >  InDeinterleaveView,
TArray< T, InAllocator > &  InArrayToFill,
int32  InChannelIndex 
)
inline

TChannelIterator

TChannelIterator allows iteration over interleaved arrays and provides contiguous arrays of single channels.

InDeinterleaveView is the parent view provides the source interleaved array for this iterator. InArrayToFill is the array which will be populated with contiguous elements for a channel. InChannelIndex is the channel index which this iterator will point to.

Member Function Documentation

◆ GetChannelIndex()

template<typename T >
template<typename InAllocator = FDefaultAllocator>
int32 Audio::TDeinterleaveView< T >::TChannelIterator< InAllocator >::GetChannelIndex ( ) const
inline

Get the current channel index

◆ operator!=()

template<typename T >
template<typename InAllocator = FDefaultAllocator>
bool Audio::TDeinterleaveView< T >::TChannelIterator< InAllocator >::operator!= ( const TChannelIterator< InAllocator > &  Other) const
inline

Check equality between iterators

◆ operator*()

template<typename T >
template<typename InAllocator = FDefaultAllocator>
TChannel< InAllocator > Audio::TDeinterleaveView< T >::TChannelIterator< InAllocator >::operator* ( )
inline

Dereference the iterator, returns a TChannel object

◆ operator++()

template<typename T >
template<typename InAllocator = FDefaultAllocator>
TChannelIterator & Audio::TDeinterleaveView< T >::TChannelIterator< InAllocator >::operator++ ( )
inline

Increment the iterator forward by one channel

Member Data Documentation

◆ ChannelIndexEnd

template<typename T >
template<typename InAllocator = FDefaultAllocator>
const int32 Audio::TDeinterleaveView< T >::TChannelIterator< InAllocator >::ChannelIndexEnd = INDEX_NONE
static

Denotes the end of a channel iterator


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