From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/a02365.html | 338 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 338 insertions(+) create mode 100644 docs/doxygen/nel/a02365.html (limited to 'docs/doxygen/nel/a02365.html') diff --git a/docs/doxygen/nel/a02365.html b/docs/doxygen/nel/a02365.html new file mode 100644 index 00000000..86e3485a --- /dev/null +++ b/docs/doxygen/nel/a02365.html @@ -0,0 +1,338 @@ + + +NeL: NLSOUND::CClusteredSound::CClusterSoundStatus struct Reference + + + +

NLSOUND::CClusteredSound::CClusterSoundStatus Struct Reference

#include <clustered_sound.h> +

Detailed Description

+This structure contain data about sound status in a cluster. +

+ +

+Definition at line 62 of file clustered_sound.h. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields
NLMISC::CVector Direction
The direction vector for the virtual sound source.

float Dist
The distance from listener.

float DistFactor
The ratio distance/max earing distance.

float Gain
The relative gain of sound in the cluster.

sint32 Obstruction
The obsctruction att db.

sint32 Occlusion
The occlusion att.

float OcclusionLFFactor
The occlusion LF factor (see EAX spec).

float OcclusionRoomRatio
The occlusion romm ration.

float PosAlpha
The blending factor between real sound pos and virtual pos (1 mean virtual pos, 0 mean real pos).

NLMISC::CVector Position
The sound virtual position (in fact Dist * Direction).

+

Field Documentation

+ + + + +
+ + +
NLMISC::CVector NLSOUND::CClusteredSound::CClusterSoundStatus::Direction +
+
+ + + + + +
+ + + +
+The direction vector for the virtual sound source. +
+ +
+Definition at line 75 of file clustered_sound.h. +
+Referenced by NLSOUND::CClusteredSound::addAudibleCluster(), NLSOUND::CSimpleSource::getVirtualPos(), NLSOUND::CClusteredSound::soundTraverse(), NLSOUND::CClusteredSound::update(), and NLSOUND::CAudioMixerUser::update().
+

+ + + + +
+ + +
float NLSOUND::CClusteredSound::CClusterSoundStatus::Dist +
+
+ + + + + +
+ + + +
+The distance from listener. +
+ +
+Definition at line 67 of file clustered_sound.h. +
+Referenced by NLSOUND::CClusteredSound::addAudibleCluster(), NLSOUND::CSimpleSource::getVirtualPos(), NLSOUND::CClusteredSound::soundTraverse(), NLSOUND::CClusteredSound::update(), and NLSOUND::CAudioMixerUser::update().
+

+ + + + +
+ + +
float NLSOUND::CClusteredSound::CClusterSoundStatus::DistFactor +
+
+ + + + + +
+ + + +
+The ratio distance/max earing distance. +
+ +
+Definition at line 69 of file clustered_sound.h. +
+Referenced by NLSOUND::CClusteredSound::soundTraverse(), and NLSOUND::CClusteredSound::update().
+

+ + + + +
+ + +
float NLSOUND::CClusteredSound::CClusterSoundStatus::Gain +
+
+ + + + + +
+ + + +
+The relative gain of sound in the cluster. +
+ +
+Definition at line 65 of file clustered_sound.h. +
+Referenced by NLSOUND::CClusteredSound::soundTraverse(), NLSOUND::CClusteredSound::update(), and NLSOUND::CAudioMixerUser::update().
+

+ + + + +
+ + +
sint32 NLSOUND::CClusteredSound::CClusterSoundStatus::Obstruction +
+
+ + + + + +
+ + + +
+The obsctruction att db. +
+ +
+Definition at line 83 of file clustered_sound.h. +
+Referenced by NLSOUND::CClusteredSound::soundTraverse(), and NLSOUND::CAudioMixerUser::update().
+

+ + + + +
+ + +
sint32 NLSOUND::CClusteredSound::CClusterSoundStatus::Occlusion +
+
+ + + + + +
+ + + +
+The occlusion att. +
+ +
+Definition at line 77 of file clustered_sound.h. +
+Referenced by NLSOUND::CClusteredSound::soundTraverse(), and NLSOUND::CAudioMixerUser::update().
+

+ + + + +
+ + +
float NLSOUND::CClusteredSound::CClusterSoundStatus::OcclusionLFFactor +
+
+ + + + + +
+ + + +
+The occlusion LF factor (see EAX spec). +
+ +
+Definition at line 79 of file clustered_sound.h. +
+Referenced by NLSOUND::CClusteredSound::soundTraverse(), and NLSOUND::CAudioMixerUser::update().
+

+ + + + +
+ + +
float NLSOUND::CClusteredSound::CClusterSoundStatus::OcclusionRoomRatio +
+
+ + + + + +
+ + + +
+The occlusion romm ration. +
+ +
+Definition at line 81 of file clustered_sound.h. +
+Referenced by NLSOUND::CClusteredSound::soundTraverse(), and NLSOUND::CAudioMixerUser::update().
+

+ + + + +
+ + +
float NLSOUND::CClusteredSound::CClusterSoundStatus::PosAlpha +
+
+ + + + + +
+ + + +
+The blending factor between real sound pos and virtual pos (1 mean virtual pos, 0 mean real pos). +
+ +
+Definition at line 73 of file clustered_sound.h. +
+Referenced by NLSOUND::CSimpleSource::getVirtualPos(), NLSOUND::CClusteredSound::soundTraverse(), and NLSOUND::CAudioMixerUser::update().
+

+ + + + +
+ + +
NLMISC::CVector NLSOUND::CClusteredSound::CClusterSoundStatus::Position +
+
+ + + + + +
+ + + +
+The sound virtual position (in fact Dist * Direction). +
+ +
+Definition at line 71 of file clustered_sound.h. +
+Referenced by NLSOUND::CSimpleSource::getVirtualPos(), NLSOUND::CClusteredSound::soundTraverse(), NLSOUND::CAudioMixerUser::update(), and NLSOUND::CBackgroundSoundManager::updateBackgroundStatus().
+

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

clustered_sound.h

Generated on Tue Mar 16 14:35:24 2004 for NeL by + +

+1.3.6

+ + -- cgit v1.2.1


Data Fields
NLMISC::CVector	Direction
	The direction vector for the virtual sound source.
float	Dist
	The distance from listener.
float	DistFactor
	The ratio distance/max earing distance.
float	Gain
	The relative gain of sound in the cluster.
sint32	Obstruction
	The obsctruction att db.
sint32	Occlusion
	The occlusion att.
float	OcclusionLFFactor
	The occlusion LF factor (see EAX spec).
float	OcclusionRoomRatio
	The occlusion romm ration.
float	PosAlpha
	The blending factor between real sound pos and virtual pos (1 mean virtual pos, 0 mean real pos).
NLMISC::CVector	Position
	The sound virtual position (in fact Dist * Direction).