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

#include <DeinterleaveView.h>

+ Inheritance diagram for Audio::TAutoDeinterleaveView< T, InAllocator >:

Public Member Functions

 TAutoDeinterleaveView (TArrayView< const T > InInterleavedArray, TArray< T, InAllocator > &InArrayToFill, int32 InNumChannels)
 
TAutoChannelIterator begin ()
 
TAutoChannelIterator end ()
 
- Public Member Functions inherited from Audio::TDeinterleaveView< T >
 TDeinterleaveView (TArrayView< const T > InInterleavedArray, int32 InNumChannels)
 
template<typename InAllocator = FDefaultAllocator>
TChannelIterator< InAllocatorbegin (TArray< T, InAllocator > &InArrayToFill) const
 
template<typename InAllocator = FDefaultAllocator>
TChannelIterator< InAllocatorend (TArray< T, InAllocator > &InArrayToFill) const
 

Detailed Description

template<typename T, typename InAllocator = FDefaultAllocator>
class Audio::TAutoDeinterleaveView< T, InAllocator >

TAutoDeinterleaveView

TAutoDeinterlaveView provides a STL like iterators which exposes contiguous channel arrays from interleaved arrays. As opposed to TDeinterleaveView, this class can be used in range based for loops, but only one iterator is valid at a time since they all share the same InArrayToFill.

Example:

TArray<float> ArrayToFill; for (auto Channel : TAudoDeineterleaveView(InterleavedArray, ArrayToFill, 2)) { DoSomethingWithAudio(Channel.Values, Channel.ChannelIndex); }

Constructor & Destructor Documentation

◆ TAutoDeinterleaveView()

template<typename T , typename InAllocator = FDefaultAllocator>
Audio::TAutoDeinterleaveView< T, InAllocator >::TAutoDeinterleaveView ( TArrayView< const T >  InInterleavedArray,
TArray< T, InAllocator > &  InArrayToFill,
int32  InNumChannels 
)
inline

TAutoDeinterleaveView Constructor.

InInterleavedArray is the interleaved array to be deinterleaved. InArrayToFill is the array which will be populated with contiguous elements for a channel. InNumChannels is the number of channels in the deinterleaved array.

Member Function Documentation

◆ begin()

template<typename T , typename InAllocator = FDefaultAllocator>
TAutoChannelIterator Audio::TAutoDeinterleaveView< T, InAllocator >::begin ( )
inline

Return an STL iterator to the first channel.

◆ end()

template<typename T , typename InAllocator = FDefaultAllocator>
TAutoChannelIterator Audio::TAutoDeinterleaveView< T, InAllocator >::end ( )
inline

Return an STL iterator to the end.


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