JPL Spatial
Sound spatialization and propagation library
Loading...
Searching...
No Matches
JPL::VBAPBaseTraits< Vec3 > Struct Template Reference

Forward declaration. More...

#include <JPLSpatial/Panning/PannerBase.h>

Public Types

using Vec3Type = Vec3
 
using ChannelGains = std::array< float, MAX_CHANNELS >
 

Static Public Member Functions

static float GetChannelAngle (EChannel channel)
 
static Vec3Type GetChannelVector (EChannel channel)
 

Static Public Attributes

static constexpr auto MAX_CHANNELS = 32
 
static constexpr auto MAX_SOURCE_CHANNELS = 8
 
static constexpr auto MAX_CHANNEL_MIX_MAP_SIZE = MAX_SOURCE_CHANNELS * MAX_CHANNELS
 

Detailed Description

template<CVec3 Vec3>
struct JPL::VBAPBaseTraits< Vec3 >

Forward declaration.

Customization. You can either inherit from this and shadow some types and functions, or use a completely separate traits type with VBAP API.

Member Typedef Documentation

◆ ChannelGains

template<CVec3 Vec3>
using JPL::VBAPBaseTraits< Vec3 >::ChannelGains = std::array<float, MAX_CHANNELS>

◆ Vec3Type

template<CVec3 Vec3>
using JPL::VBAPBaseTraits< Vec3 >::Vec3Type = Vec3

Member Function Documentation

◆ GetChannelAngle()

template<CVec3 Vec3>
static float JPL::VBAPBaseTraits< Vec3 >::GetChannelAngle ( EChannel  channel)
inlinestatic

Standard channel vectors converted to angles

◆ GetChannelVector()

template<CVec3 Vec3>
static Vec3Type JPL::VBAPBaseTraits< Vec3 >::GetChannelVector ( EChannel  channel)
inlinestatic

Standard channel vectors converted to angles

Member Data Documentation

◆ MAX_CHANNEL_MIX_MAP_SIZE

template<CVec3 Vec3>
constexpr auto JPL::VBAPBaseTraits< Vec3 >::MAX_CHANNEL_MIX_MAP_SIZE = MAX_SOURCE_CHANNELS * MAX_CHANNELS
staticconstexpr

◆ MAX_CHANNELS

template<CVec3 Vec3>
constexpr auto JPL::VBAPBaseTraits< Vec3 >::MAX_CHANNELS = 32
staticconstexpr

Can be useful to override to save a tiny bit of memory if max number of channels ever used is known at compile time. Or to handle larger channel maps. (though currently ChannelMap interface doesn't support 64-bit masks and is not very customizable, e.g. storing in an int mask, not array)

◆ MAX_SOURCE_CHANNELS

template<CVec3 Vec3>
constexpr auto JPL::VBAPBaseTraits< Vec3 >::MAX_SOURCE_CHANNELS = 8
staticconstexpr

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