core_audio_types.h File Reference

Go to the source code of this file.

Macros
#define	AUDIO_INNER_RADIUS_MIN   0.0f
#define	AUDIO_INNER_RADIUS_MAX   65535.0f
#define	AUDIO_INNER_RADIUS_DEFAULT   1.0f
#define	AUDIO_OUTER_RADIUS_MIN   0.1f
#define	AUDIO_OUTER_RADIUS_MAX   65536.0f
#define	AUDIO_OUTER_RADIUS_DEFAULT   2.0f
#define	AUDIO_FALLOFF_MIN   0.1f
#define	AUDIO_FALLOFF_MAX   10.0f
#define	AUDIO_FALLOFF_DEFAULT   1.0f
#define	AUDIO_PITCH_MIN   0.5f
#define	AUDIO_PITCH_MAX   2.0f
#define	AUDIO_PITCH_DEFAULT   1.0f
#define	AUDIO_VOLUME_MIN   0.0f
#define	AUDIO_VOLUME_MAX   1.0f
#define	AUDIO_VOLUME_DEFAULT   1.0f

Typedefs
typedef enum kaudio_space	kaudio_space
	Describes the dimensionality of audio. More...
typedef enum kaudio_attenuation_model	kaudio_attenuation_model
	Represents the attenuation models supported by the audio system. These affect how sounds fall off as the listener moves away from the source. More...

Enumerations
enum	kaudio_space { KAUDIO_SPACE_2D , KAUDIO_SPACE_3D }
	Describes the dimensionality of audio. More...
enum	kaudio_attenuation_model { KAUDIO_ATTENUATION_MODEL_LINEAR , KAUDIO_ATTENUATION_MODEL_EXPONENTIAL , KAUDIO_ATTENUATION_MODEL_LOGARITHMIC , KAUDIO_ATTENUATION_MODEL_SMOOTHERSTEP }
	Represents the attenuation models supported by the audio system. These affect how sounds fall off as the listener moves away from the source. More...

Macro Definition Documentation

AUDIO_FALLOFF_DEFAULT

#define AUDIO_FALLOFF_DEFAULT   1.0f

AUDIO_FALLOFF_MAX

#define AUDIO_FALLOFF_MAX   10.0f

AUDIO_FALLOFF_MIN

#define AUDIO_FALLOFF_MIN   0.1f

AUDIO_INNER_RADIUS_DEFAULT

#define AUDIO_INNER_RADIUS_DEFAULT   1.0f

AUDIO_INNER_RADIUS_MAX

#define AUDIO_INNER_RADIUS_MAX   65535.0f

AUDIO_INNER_RADIUS_MIN

#define AUDIO_INNER_RADIUS_MIN   0.0f

AUDIO_OUTER_RADIUS_DEFAULT

#define AUDIO_OUTER_RADIUS_DEFAULT   2.0f

AUDIO_OUTER_RADIUS_MAX

#define AUDIO_OUTER_RADIUS_MAX   65536.0f

AUDIO_OUTER_RADIUS_MIN

#define AUDIO_OUTER_RADIUS_MIN   0.1f

AUDIO_PITCH_DEFAULT

#define AUDIO_PITCH_DEFAULT   1.0f

AUDIO_PITCH_MAX

#define AUDIO_PITCH_MAX   2.0f

AUDIO_PITCH_MIN

#define AUDIO_PITCH_MIN   0.5f

AUDIO_VOLUME_DEFAULT

#define AUDIO_VOLUME_DEFAULT   1.0f

AUDIO_VOLUME_MAX

#define AUDIO_VOLUME_MAX   1.0f

AUDIO_VOLUME_MIN

#define AUDIO_VOLUME_MIN   0.0f

Typedef Documentation

kaudio_attenuation_model

typedef enum kaudio_attenuation_model kaudio_attenuation_model

Represents the attenuation models supported by the audio system. These affect how sounds fall off as the listener moves away from the source.

kaudio_space

typedef enum kaudio_space kaudio_space

Describes the dimensionality of audio.

Enumeration Type Documentation

kaudio_attenuation_model

enum kaudio_attenuation_model

Represents the attenuation models supported by the audio system. These affect how sounds fall off as the listener moves away from the source.

Enumerator
KAUDIO_ATTENUATION_MODEL_LINEAR	Simple, constant rate of attenuation. Sound falls off linearly between inner and outer radii. Falloff parameter is ignored.
KAUDIO_ATTENUATION_MODEL_EXPONENTIAL	Sharper or softer depending on falloff factor. Sound falls off exponentially as determined by falloff parameter. 1.0 essentially makes it linear.
KAUDIO_ATTENUATION_MODEL_LOGARITHMIC	Gentle falloff of sound. Sound falls off logarithmically. Falloff parameter is ignored.
KAUDIO_ATTENUATION_MODEL_SMOOTHERSTEP	Smooth, gradual transitions. Sound falls off in a smooth step fashion. Falloff parameter is ignored.

kaudio_space

enum kaudio_space

Describes the dimensionality of audio.

Enumerator
KAUDIO_SPACE_2D	The audio does not exist in the world, but perhaps in an overlay such as UI or music overlay.
KAUDIO_SPACE_3D	The audio exists in the world and is attenuated based on 3d space.