JPL::Spatial::SourceInitParameters Struct Reference

#include <JPLSpatial/SpatialManager.h>

Public Attributes
uint32	NumChannels = 0
	Number of source channels. If 0, panning is not initialized for this source.
uint32	NumTargetChannels = 2
	Number of target channels for panning. Must be greater than 0.
JPL::Spatial::ListenerId	ListenerId
	Optional listener to assign this source to. If not set, default listener is used.
ESpatializationType	SpatializationType = ESpatializationType::Position
	Determines spatialized source channel oritentation.
uint64	ObjectId
PanEffectParameters	PanParameters { .Focus = 0.0f, .Spread = 1.0f }
	Pan parameters used if panning effect is initialized for the source.
std::optional< float >	ObjectSize
	If set, Spread value is calculated from ObjectSize based on distance to the listener.
AttenuationCurveRef	DistanceAttenuationCurve = make_pmr_shared<AttenuationCurve>()
	Base distance attenuation curve.
JPL::AttenuationCone	AttenuationCone
	Source directivity cone.

Member Data Documentation

AttenuationCone

JPL::AttenuationCone JPL::Spatial::SourceInitParameters::AttenuationCone

Source directivity cone.

DistanceAttenuationCurve

AttenuationCurveRef JPL::Spatial::SourceInitParameters::DistanceAttenuationCurve = make_pmr_shared<AttenuationCurve>()

Base distance attenuation curve.

ListenerId

JPL::Spatial::ListenerId JPL::Spatial::SourceInitParameters::ListenerId

Optional listener to assign this source to. If not set, default listener is used.

NumChannels

uint32 JPL::Spatial::SourceInitParameters::NumChannels = 0

Number of source channels. If 0, panning is not initialized for this source.

NumTargetChannels

uint32 JPL::Spatial::SourceInitParameters::NumTargetChannels = 2

Number of target channels for panning. Must be greater than 0.

ObjectId

uint64 JPL::Spatial::SourceInitParameters::ObjectId

ObjectSize

std::optional<float> JPL::Spatial::SourceInitParameters::ObjectSize

If set, Spread value is calculated from ObjectSize based on distance to the listener.

PanParameters

PanEffectParameters JPL::Spatial::SourceInitParameters::PanParameters { .Focus = 0.0f, .Spread = 1.0f }

Pan parameters used if panning effect is initialized for the source.

SpatializationType

ESpatializationType JPL::Spatial::SourceInitParameters::SpatializationType = ESpatializationType::Position

Determines spatialized source channel oritentation.

---

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

• JPLSpatial/SpatialManager.h