CriAtomEx3dSourceConfigTag Struct Reference

Configuration structure used to create a 3D sound source. More...

#include <cri_le_atom_ex.h>

Data Fields
CriBool	enable_voice_priority_decay
	Enable Voice Priority Attenuation by Distance. More...
CriUint32	random_position_list_max_length
	Maximum number of elements in the coordinate list for randomizing the position of a 3D sound source. More...

Detailed Description

Configuration structure used to create a 3D sound source.

Description:

Structure used to create a 3D sound source.
While no parameters can be specified at this time, some may be added in the future. Therefore, when using this structure, it is recommended to use the criAtomEx3dSource_SetDefaultConfig macro to initialize it.

See also

criAtomEx3dSource_SetDefaultConfig, criAtomEx3dSource_CalculateWorkSize, criAtomEx3dSource_Create

Field Documentation

enable_voice_priority_decay

CriBool enable_voice_priority_decay

Enable Voice Priority Attenuation by Distance.

Description:

Sets whether to enable priority attenuation by distance.
When this parameter is set to CRI_TRUE and a 3D sound source handle is created, the voice priority of the 3D sound sounded by the 3D sound source handle will be attenuated by the distance to the listener.
The attenuation value of the voice priority is 0 for the minimum distance set for the voice and -255 for the maximum distance.

Remarks:

Voice priority attenuation by distance is applied with addition to other voice priority settings.
In other words, the final voice priority is the sum of each of the following.

• Value set in data
• Set value by criAtomExPlayer_SetVoicePriority function
• Voice priority attenuation value by distance

The default value of this parameter is CRI_FALSE (Voice priority by distance is invalid).

See also

criAtomExPlayer_SetVoicePriority

random_position_list_max_length

CriUint32 random_position_list_max_length

Maximum number of elements in the coordinate list for randomizing the position of a 3D sound source.

Description:

Sets the maximum number of elements in the coordinate list for position randomization in 3D sound sources.
The area for the position coordinate list is allocated internally according to this setting value.

Remarks:

If you do not use position randomization in the 3D sound source or if you do not specify CRIATOMEX3DSOURCE_RANDOM_POSITION_CALCULATION_TYPE_LIST for the calculation_type variable in the CriAtomEx3dSourceRandomPositionConfig structure, specify 0 as the setting value.

See also

CriAtomEx3dSourceRandomPositionConfig

---

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

• cri_le_atom_ex.h