JPL Spatial
Sound spatialization and propagation library
Loading...
Searching...
No Matches
JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout Struct Reference

Implementation of the source layout for 2D panning. More...

#include <JPLSpatial/Panning/VBAPanning3D.h>

Inheritance diagram for JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout:
JPL::VBAPannerBase< PannerType, Traits >::VBAPLayoutBase

Classes

struct  Dimensions
 

Public Types

using LayoutBase = typename Base::VBAPLayoutBase
 

Public Member Functions

JPL_INLINE Dimensions GetDimensions () const noexcept
 
JPL_INLINE size_t GetNumVirtualSources () const noexcept
 
JPL_INLINE float GetMinDistanceBetweenSamples () const noexcept
 
- Public Member Functions inherited from JPL::VBAPannerBase< PannerType, Traits >::VBAPLayoutBase
JPL_INLINE bool IsInitialized () const noexcept
 
JPL_INLINE ChannelMap GetTargetChannelMap () const noexcept
 

Static Public Member Functions

static JPL_INLINE constexpr size_t GetMaxNumVirtualSources () noexcept
 

Static Public Attributes

static constexpr size_t cMaxNumRings = 12
 
static constexpr size_t cMaxNumSamples = 24
 
static constexpr size_t cMaxNumVirtualSources = cMaxNumRings * cMaxNumSamples
 

Additional Inherited Members

- Public Attributes inherited from JPL::VBAPannerBase< PannerType, Traits >::VBAPLayoutBase
Array< ChannelGroupChannelGroups { GetDefaultMemoryResource()}
 Groups of virtual sources associated with source channels.
 
- Protected Member Functions inherited from JPL::VBAPannerBase< PannerType, Traits >::VBAPLayoutBase
JPL_INLINE float GetDefaultVSWeight () const noexcept
 
JPL_INLINE void SetTargetChannelMap (ChannelMap targetChannelMap) noexcept
 
bool InitializeBase (ChannelMap channelMap, ChannelMap targetMap, uint32 numVirtualSourcesPerChannel)
 
- Protected Attributes inherited from JPL::VBAPannerBase< PannerType, Traits >::VBAPLayoutBase
ChannelMap mTargetChannelMap
 
float mDefaultVSWeight
 

Detailed Description

template<class Traits, auto cLUTType>
struct JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout

Implementation of the source layout for 2D panning.

Member Typedef Documentation

◆ LayoutBase

template<class Traits , auto cLUTType>
using JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout::LayoutBase = typename Base::VBAPLayoutBase

Member Function Documentation

◆ GetDimensions()

template<class Traits , auto cLUTType>
JPL_INLINE Dimensions JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout::GetDimensions ( ) const
inlinenoexcept

◆ GetMaxNumVirtualSources()

template<class Traits , auto cLUTType>
JPL_INLINE constexpr size_t JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout::GetMaxNumVirtualSources ( )
staticconstexprnoexcept

◆ GetMinDistanceBetweenSamples()

template<class Traits , auto cLUTType>
JPL_INLINE float JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout::GetMinDistanceBetweenSamples ( ) const
inlinenoexcept

Rerturns minimal distance between two virtual source samples. This is mostly needed for debugging and verification. Must be called only after the Source Layout has been initialized by a panner.

◆ GetNumVirtualSources()

template<class Traits , auto cLUTType>
JPL_INLINE size_t JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout::GetNumVirtualSources ( ) const
noexcept

Member Data Documentation

◆ cMaxNumRings

template<class Traits , auto cLUTType>
constexpr size_t JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout::cMaxNumRings = 12
staticconstexpr

◆ cMaxNumSamples

template<class Traits , auto cLUTType>
constexpr size_t JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout::cMaxNumSamples = 24
staticconstexpr

◆ cMaxNumVirtualSources

template<class Traits , auto cLUTType>
constexpr size_t JPL::VBAP::Panning3D< Traits, cLUTType >::SourceLayout::cMaxNumVirtualSources = cMaxNumRings * cMaxNumSamples
staticconstexpr

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