JPL Spatial
Sound spatialization and propagation library
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
JPL::ChannelMap Class Reference

#include <JPLSpatial/ChannelMap.h>

Public Member Functions

constexpr ChannelMap ()=default
 
constexpr bool Has (EChannel channel) const noexcept
 
constexpr bool HasLFE () const noexcept
 
constexpr bool HasTopChannels () const noexcept
 
constexpr bool IsValid () const noexcept
 
constexpr uint32 GetNumChannels () const noexcept
 
constexpr uint32 GetChannelIndex (EChannel channel) const
 
constexpr EChannel GetChannelAtIndex (uint32 index) const
 
constexpr uint32 GetChannelMask () const
 
template<class Predicate >
constexpr void ForEachChannel (Predicate predicate) const
 
constexpr bool operator== (const ChannelMap &other) const noexcept
 
constexpr bool operator!= (const ChannelMap &other) const noexcept
 

Static Public Member Functions

static constexpr ChannelMap FromChannelMask (uint32 channelMask)
 
static constexpr ChannelMap FromNumChannels (uint32 numChannels)
 

Static Public Attributes

static constexpr uint32 InvalidChannelIndex = ~uint32(0)
 

Friends

struct std::hash< JPL::ChannelMap >
 

Detailed Description

ChannelMap is just a interface for strongly-typed access to some sort of channel mask

Constructor & Destructor Documentation

◆ ChannelMap()

JPL::ChannelMap::ChannelMap ( )
constexprdefault

Member Function Documentation

◆ ForEachChannel()

template<class Predicate >
void JPL::ChannelMap::ForEachChannel ( Predicate predicate) const
inlineconstexpr

◆ FromChannelMask()

static constexpr ChannelMap JPL::ChannelMap::FromChannelMask ( uint32 channelMask)
inlinestaticnodiscardconstexpr

◆ FromNumChannels()

static constexpr ChannelMap JPL::ChannelMap::FromNumChannels ( uint32 numChannels)
inlinestaticnodiscardconstexpr

◆ GetChannelAtIndex()

EChannel JPL::ChannelMap::GetChannelAtIndex ( uint32 index) const
inlinenodiscardconstexpr

◆ GetChannelIndex()

uint32 JPL::ChannelMap::GetChannelIndex ( EChannel channel) const
inlinenodiscardconstexpr

◆ GetChannelMask()

uint32 JPL::ChannelMap::GetChannelMask ( ) const
inlinenodiscardconstexpr

◆ GetNumChannels()

uint32 JPL::ChannelMap::GetNumChannels ( ) const
inlinenodiscardconstexprnoexcept

◆ Has()

bool JPL::ChannelMap::Has ( EChannel channel) const
inlinenodiscardconstexprnoexcept

◆ HasLFE()

bool JPL::ChannelMap::HasLFE ( ) const
inlinenodiscardconstexprnoexcept

◆ HasTopChannels()

bool JPL::ChannelMap::HasTopChannels ( ) const
inlinenodiscardconstexprnoexcept

◆ IsValid()

bool JPL::ChannelMap::IsValid ( ) const
inlinenodiscardconstexprnoexcept

◆ operator!=()

bool JPL::ChannelMap::operator!= ( const ChannelMap & other) const
inlinenodiscardconstexprnoexcept

◆ operator==()

bool JPL::ChannelMap::operator== ( const ChannelMap & other) const
inlinenodiscardconstexprnoexcept

Friends And Related Symbol Documentation

◆ std::hash< JPL::ChannelMap >

friend struct std::hash< JPL::ChannelMap >
friend

Member Data Documentation

◆ InvalidChannelIndex

uint32 JPL::ChannelMap::InvalidChannelIndex = ~uint32(0)
staticconstexpr
The documentation for this class was generated from the following file: