sound rename gain -> volume (#571)

hxd/snd/Channel.hx

@@ -19,7 +19,7 @@ class Channel extends ChannelBase {
 	public var loop = false;
 	public var allowVirtual = true;
 
-	var audibleGain = 1.0;
+	var audibleVolume = 1.0;
 	var lastStamp = 0.0;
 	var isVirtual = false;
 	var isLoading = false;
@@ -69,13 +69,13 @@ class Channel extends ChannelBase {
 		}
 	}
 
-	public function calcAudibleGain( now : Float ) {
+	public function calcAudibleVolume( now : Float ) {
 		updateCurrentVolume(now);
-		audibleGain = currentVolume;
+		audibleVolume = currentVolume;
 
 		if (manager != null) { // fader may have stopped the sound
-			for (e in channelGroup.effects) audibleGain = e.applyAudibleGainModifier(audibleGain);
-			for (e in effects) audibleGain = e.applyAudibleGainModifier(audibleGain);
+			for (e in channelGroup.effects) audibleVolume = e.applyAudibleVolumeModifier(audibleVolume);
+			for (e in effects) audibleVolume = e.applyAudibleVolumeModifier(audibleVolume);
 		}
 	}
 

hxd/snd/Effect.hx

@@ -24,8 +24,8 @@ class Effect {
 		}
 	}
 
-	// used to evaluate gain midification for virtualization sorting
-	public function applyAudibleGainModifier(v : Float) : Float {
+	// used to evaluate volume modification for virtualization sorting
+	public function applyAudibleVolumeModifier(v : Float) : Float {
 		return v;
 	}
 

hxd/snd/Manager.hx

@@ -361,15 +361,15 @@ class Manager {
 		}
 
 		// --------------------------------------------------------------------
-		// calc audible gain & virtualize inaudible channels
+		// calc audible volume & virtualize inaudible channels
 		// --------------------------------------------------------------------
 
 		var c = channels;
 		while (c != null) {
-			c.calcAudibleGain(now);
+			c.calcAudibleVolume(now);
 			if( c.isLoading && !c.sound.getData().isLoading() )
 				c.isLoading = false;
-			c.isVirtual = c.pause || c.mute || c.channelGroup.mute || (c.allowVirtual && c.audibleGain < VIRTUAL_VOLUME_THRESHOLD) || c.isLoading;
+			c.isVirtual = c.pause || c.mute || c.channelGroup.mute || (c.allowVirtual && c.audibleVolume < VIRTUAL_VOLUME_THRESHOLD) || c.isLoading;
 			c = c.next;
 		}
 
@@ -444,12 +444,12 @@ class Manager {
 		// --------------------------------------------------------------------
 
 		var usedEffects : Effect = null;
-		var gain = hasMasterVolume ? 1. : masterVolume;
+		var volume = hasMasterVolume ? 1. : masterVolume;
 		for (s in sources) {
 			var c = s.channel;
 			if (c == null) continue;
 
-			var v = c.currentVolume * gain;
+			var v = c.currentVolume * volume;
 			if (s.volume != v) {
 				s.volume = v;
 				driver.setSourceVolume(s.handle, v);
@@ -759,8 +759,8 @@ class Manager {
 		if (a.priority != b.priority)
 			return a.priority < b.priority ? 1 : -1;
 
-		if (a.audibleGain != b.audibleGain)
-			return a.audibleGain < b.audibleGain ? 1 : -1;
+		if (a.audibleVolume != b.audibleVolume)
+			return a.audibleVolume < b.audibleVolume ? 1 : -1;
 
 		return a.id < b.id ? 1 : -1;
 	}

hxd/snd/effect/Spatialization.hx

@@ -25,17 +25,17 @@ class Spatialization extends hxd.snd.Effect {
 		var dist = Manager.get().listener.position.distance(position);
 		if (maxDistance != null) dist -= maxDistance;
 		else dist -= referenceDistance;
-		var gain = 1 - dist / fadeDistance;
-		if (gain > 1) gain = 1;
-		if (gain < 0) gain = 0;
-		return gain;
+		var volume = 1 - dist / fadeDistance;
+		if (volume > 1) volume = 1;
+		if (volume < 0) volume = 0;
+		return volume;
 	}
 
-	override function applyAudibleGainModifier(v : Float) {
+	override function applyAudibleVolumeModifier(v : Float) {
 		var dist = Manager.get().listener.position.distance(position);
 		dist = Math.max(dist, referenceDistance);
 		if (maxDistance != null) dist = Math.min(dist, maxDistance);
-		var gain = referenceDistance/(referenceDistance + rollOffFactor * (dist - referenceDistance));
-		return v * gain;
+		var volume = referenceDistance/(referenceDistance + rollOffFactor * (dist - referenceDistance));
+		return v * volume;
 	}
 }