JPL Spatial
Sound spatialization and propagation library
Loading...
Searching...
No Matches
JPL::VBAP::DummySpeakers< GetChannelVectorFunction > Class Template Reference

Utility class to encapsulate dummy speaker handling while building a LUT. More...

#include <JPLSpatial/Panning/DummySpeakers.h>

Public Types

using Vec3Type = std::remove_cvref_t< decltype(GetChannelVectorFunction(EChannel{}))>
 

Public Member Functions

JPL_INLINE constexpr DummySpeakers (ChannelMap channelMap, std::pmr::vector< Vec3Type > &speakerVectors) noexcept
 
JPL_INLINE constexpr void AddDummy (const Vec3Type &speakerVector)
 
JPL_INLINE constexpr void AddIfChannelNotPresent (EChannel channel)
 
JPL_INLINE constexpr bool Contains (uint32 index) const
 
JPL_INLINE constexpr bool HasDummyAt (const Vec3Type &direction, float tolerance) const noexcept
 
JPL_INLINE constexpr uint32 GetNumDummies () const noexcept
 
JPL_INLINE constexpr ChannelMap GetChannelMap () const noexcept
 

Detailed Description

template<auto GetChannelVectorFunction>
class JPL::VBAP::DummySpeakers< GetChannelVectorFunction >

Utility class to encapsulate dummy speaker handling while building a LUT.

Member Typedef Documentation

◆ Vec3Type

template<auto GetChannelVectorFunction>
using JPL::VBAP::DummySpeakers< GetChannelVectorFunction >::Vec3Type = std::remove_cvref_t<decltype(GetChannelVectorFunction(EChannel{}))>

Constructor & Destructor Documentation

◆ DummySpeakers()

template<auto GetChannelVectorFunction>
JPL_INLINE constexpr JPL::VBAP::DummySpeakers< GetChannelVectorFunction >::DummySpeakers ( ChannelMap  channelMap,
std::pmr::vector< Vec3Type > &  speakerVectors 
)
inlineconstexprnoexcept

Member Function Documentation

◆ AddDummy()

template<auto GetChannelVectorFunction>
JPL_INLINE constexpr void JPL::VBAP::DummySpeakers< GetChannelVectorFunction >::AddDummy ( const Vec3Type speakerVector)
inlineconstexpr

◆ AddIfChannelNotPresent()

template<auto GetChannelVectorFunction>
JPL_INLINE constexpr void JPL::VBAP::DummySpeakers< GetChannelVectorFunction >::AddIfChannelNotPresent ( EChannel  channel)
inlineconstexpr

◆ Contains()

template<auto GetChannelVectorFunction>
JPL_INLINE constexpr bool JPL::VBAP::DummySpeakers< GetChannelVectorFunction >::Contains ( uint32  index) const
inlineconstexpr

◆ GetChannelMap()

template<auto GetChannelVectorFunction>
JPL_INLINE constexpr ChannelMap JPL::VBAP::DummySpeakers< GetChannelVectorFunction >::GetChannelMap ( ) const
inlineconstexprnoexcept

◆ GetNumDummies()

template<auto GetChannelVectorFunction>
JPL_INLINE constexpr uint32 JPL::VBAP::DummySpeakers< GetChannelVectorFunction >::GetNumDummies ( ) const
inlineconstexprnoexcept

◆ HasDummyAt()

template<auto GetChannelVectorFunction>
JPL_INLINE constexpr bool JPL::VBAP::DummySpeakers< GetChannelVectorFunction >::HasDummyAt ( const Vec3Type direction,
float  tolerance 
) const
inlineconstexprnoexcept

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