Browse Source

falloff -> attenuation;

bjorn 2 years ago
parent
commit
2d8c1f8f19
4 changed files with 10 additions and 10 deletions
  1. 3 3
      api/init.lua
  2. 1 1
      api/lovr/audio/Effect.lua
  3. 3 3
      api/lovr/audio/getAbsorption.lua
  4. 3 3
      api/lovr/audio/setAbsorption.lua

+ 3 - 3
api/init.lua

@@ -972,7 +972,7 @@ return {
               description = "Models absorption as sound travels through the air, water, etc."
               description = "Models absorption as sound travels through the air, water, etc."
             },
             },
             {
             {
-              name = "falloff",
+              name = "attenuation",
               description = "Decreases audio volume with distance (1 / max(distance, 1))."
               description = "Decreases audio volume with distance (1 / max(distance, 1))."
             },
             },
             {
             {
@@ -1032,7 +1032,7 @@ return {
         {
         {
           name = "getAbsorption",
           name = "getAbsorption",
           summary = "Get the absorption coefficients.",
           summary = "Get the absorption coefficients.",
-          description = "Returns the global air absorption coefficients for the medium.  This affects Sources that have the `absorption` effect enabled, causing audio volume to drop off with distance as it is absorbed by the medium it's traveling through (air, water, etc.).  The difference between absorption and falloff is that absorption is more subtle and is frequency-dependent, so higher-frequency bands can get absorbed more quickly than lower ones.  This can be used to apply \"underwater\" effects and stuff.",
+          description = "Returns the global air absorption coefficients for the medium.  This affects Sources that have the `absorption` effect enabled, causing audio volume to drop off with distance as it is absorbed by the medium it's traveling through (air, water, etc.).  The difference between absorption and the attenuation effect is that absorption is more subtle and is frequency-dependent, so higher-frequency bands can get absorbed more quickly than lower ones. This can be used to apply \"underwater\" effects and stuff.",
           key = "lovr.audio.getAbsorption",
           key = "lovr.audio.getAbsorption",
           module = "lovr.audio",
           module = "lovr.audio",
           notes = "Absorption is currently only supported by the phonon spatializer.\n\nThe frequency bands correspond to `400Hz`, `2.5KHz`, and `15KHz`.\n\nThe default coefficients are `.0002`, `.0017`, and `.0182` for low, mid, and high.",
           notes = "Absorption is currently only supported by the phonon spatializer.\n\nThe frequency bands correspond to `400Hz`, `2.5KHz`, and `15KHz`.\n\nThe default coefficients are `.0002`, `.0017`, and `.0182` for low, mid, and high.",
@@ -1465,7 +1465,7 @@ return {
         {
         {
           name = "setAbsorption",
           name = "setAbsorption",
           summary = "Set the absorption coefficients.",
           summary = "Set the absorption coefficients.",
-          description = "Sets the global air absorption coefficients for the medium.  This affects Sources that have the `absorption` effect enabled, causing audio volume to drop off with distance as it is absorbed by the medium it's traveling through (air, water, etc.).  The difference between absorption and falloff is that absorption is more subtle and is frequency-dependent, so higher-frequency bands can get absorbed more quickly than lower ones.  This can be used to apply \"underwater\" effects and stuff.",
+          description = "Sets the global air absorption coefficients for the medium.  This affects Sources that have the `absorption` effect enabled, causing audio volume to drop off with distance as it is absorbed by the medium it's traveling through (air, water, etc.).  The difference between absorption and the attenuation effect is that absorption is more subtle and is frequency-dependent, so higher-frequency bands can get absorbed more quickly than lower ones.  This can be used to apply \"underwater\" effects and stuff.",
           key = "lovr.audio.setAbsorption",
           key = "lovr.audio.setAbsorption",
           module = "lovr.audio",
           module = "lovr.audio",
           notes = "Absorption is currently only supported by the phonon spatializer.\n\nThe frequency bands correspond to `400Hz`, `2.5KHz`, and `15KHz`.\n\nThe default coefficients are `.0002`, `.0017`, and `.0182` for low, mid, and high.",
           notes = "Absorption is currently only supported by the phonon spatializer.\n\nThe frequency bands correspond to `400Hz`, `2.5KHz`, and `15KHz`.\n\nThe default coefficients are `.0002`, `.0017`, and `.0182` for low, mid, and high.",

+ 1 - 1
api/lovr/audio/Effect.lua

@@ -7,7 +7,7 @@ return {
       description = 'Models absorption as sound travels through the air, water, etc.'
       description = 'Models absorption as sound travels through the air, water, etc.'
     },
     },
     {
     {
-      name = 'falloff',
+      name = 'attenuation',
       description = 'Decreases audio volume with distance (1 / max(distance, 1)).'
       description = 'Decreases audio volume with distance (1 / max(distance, 1)).'
     },
     },
     {
     {

+ 3 - 3
api/lovr/audio/getAbsorption.lua

@@ -4,9 +4,9 @@ return {
     Returns the global air absorption coefficients for the medium.  This affects Sources that have
     Returns the global air absorption coefficients for the medium.  This affects Sources that have
     the `absorption` effect enabled, causing audio volume to drop off with distance as it is
     the `absorption` effect enabled, causing audio volume to drop off with distance as it is
     absorbed by the medium it's traveling through (air, water, etc.).  The difference between
     absorbed by the medium it's traveling through (air, water, etc.).  The difference between
-    absorption and falloff is that absorption is more subtle and is frequency-dependent, so
-    higher-frequency bands can get absorbed more quickly than lower ones.  This can be used to apply
-    "underwater" effects and stuff.
+    absorption and the attenuation effect is that absorption is more subtle and is
+    frequency-dependent, so higher-frequency bands can get absorbed more quickly than lower ones.
+    This can be used to apply "underwater" effects and stuff.
   ]],
   ]],
   arguments = {},
   arguments = {},
   returns = {
   returns = {

+ 3 - 3
api/lovr/audio/setAbsorption.lua

@@ -4,9 +4,9 @@ return {
     Sets the global air absorption coefficients for the medium.  This affects Sources that have the
     Sets the global air absorption coefficients for the medium.  This affects Sources that have the
     `absorption` effect enabled, causing audio volume to drop off with distance as it is absorbed by
     `absorption` effect enabled, causing audio volume to drop off with distance as it is absorbed by
     the medium it's traveling through (air, water, etc.).  The difference between absorption and
     the medium it's traveling through (air, water, etc.).  The difference between absorption and
-    falloff is that absorption is more subtle and is frequency-dependent, so higher-frequency bands
-    can get absorbed more quickly than lower ones.  This can be used to apply "underwater" effects
-    and stuff.
+    the attenuation effect is that absorption is more subtle and is frequency-dependent, so
+    higher-frequency bands can get absorbed more quickly than lower ones.  This can be used to apply
+    "underwater" effects and stuff.
   ]],
   ]],
   arguments = {
   arguments = {
     low = {
     low = {