A descriptor structure that describes the creation of an audio source. More...

#include <CeresEngine/Audio/API/Source.hpp>

Public Attributes
AudioAPIBufferPtr	buffer = nullptr
	The buffer to attached to the audio source.

Vector3	position = Vector3(0.0)
	The source position.

Vector3	direction = Vector3(0.0)
	The source direction.

Vector3	velocity = Vector3(0.0)
	The source velocity.

bool	startPlaying = false
	If set to `true`, will automatically start playing the audio when the source is created.

bool	looping = false
	If set to `true`, will loop the source until it is manually stopped.

double	pitch = 1.0
	The pitch multiplier. Always positive.

double	gain = 1.0
	The source gain. Value should be positive.

double	minimumGain = 0.0
	The source minimum gain.

double	maximumGain = 1.0
	The source maximum gain.

double	maximumDistance = 100.0
	Used with the Inverse Clamped Distance Model to set the distance where there will no longer be any attenuation of the source.

double	rolloffFactor = 1.0
	The rolloff rate for the source. Default is 1.0.

double	referenceDistance = 1.0
	The distance under which the volume for the source would normally drop by half (before being influenced by `rolloffFactor` or `maximumDistance`)

double	coneOuterGain = 1.0
	The gain when outside the oriented cone.

double	coneInnerAngle = 360.0
	The inner angle of the sound cone, in degrees. Default is 360.

double	coneOuterAngle = 360.0
	The outer angle of the sound cone, in degrees. Default is 360.

bool	relative = false
	Determines if the positions are relative to the listener.

double	offset = 0.0
	The playback position, expressed in seconds. Default is `0.0`.

Detailed Description

A descriptor structure that describes the creation of an audio source.

Member Data Documentation

◆ buffer

AudioAPIBufferPtr CeresEngine::AudioAPISourceDescriptor::buffer = nullptr

The buffer to attached to the audio source.

The buffer can be changed by calling update on the source with a new buffer value.

◆ coneInnerAngle

double CeresEngine::AudioAPISourceDescriptor::coneInnerAngle = 360.0

The inner angle of the sound cone, in degrees. Default is 360.

◆ coneOuterAngle

double CeresEngine::AudioAPISourceDescriptor::coneOuterAngle = 360.0

The outer angle of the sound cone, in degrees. Default is 360.

◆ coneOuterGain

double CeresEngine::AudioAPISourceDescriptor::coneOuterGain = 1.0

The gain when outside the oriented cone.

◆ direction

Vector3 CeresEngine::AudioAPISourceDescriptor::direction = Vector3(0.0)

The source direction.

◆ gain

double CeresEngine::AudioAPISourceDescriptor::gain = 1.0

The source gain. Value should be positive.

◆ looping

bool CeresEngine::AudioAPISourceDescriptor::looping = false

If set to true, will loop the source until it is manually stopped.

◆ maximumDistance

double CeresEngine::AudioAPISourceDescriptor::maximumDistance = 100.0

Used with the Inverse Clamped Distance Model to set the distance where there will no longer be any attenuation of the source.

◆ maximumGain

double CeresEngine::AudioAPISourceDescriptor::maximumGain = 1.0

The source maximum gain.

◆ minimumGain

double CeresEngine::AudioAPISourceDescriptor::minimumGain = 0.0

The source minimum gain.

◆ offset

double CeresEngine::AudioAPISourceDescriptor::offset = 0.0

The playback position, expressed in seconds. Default is 0.0.

◆ pitch

double CeresEngine::AudioAPISourceDescriptor::pitch = 1.0

The pitch multiplier. Always positive.

◆ position

Vector3 CeresEngine::AudioAPISourceDescriptor::position = Vector3(0.0)

The source position.

◆ referenceDistance

double CeresEngine::AudioAPISourceDescriptor::referenceDistance = 1.0

The distance under which the volume for the source would normally drop by half (before being influenced by rolloffFactor or maximumDistance)

◆ relative

bool CeresEngine::AudioAPISourceDescriptor::relative = false

Determines if the positions are relative to the listener.

Default is false.

◆ rolloffFactor

double CeresEngine::AudioAPISourceDescriptor::rolloffFactor = 1.0

The rolloff rate for the source. Default is 1.0.

◆ startPlaying

bool CeresEngine::AudioAPISourceDescriptor::startPlaying = false

If set to true, will automatically start playing the audio when the source is created.

◆ velocity

Vector3 CeresEngine::AudioAPISourceDescriptor::velocity = Vector3(0.0)

The source velocity.

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

/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Audio/API/Source.hpp

Public Attributes