src/light.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include "light.h"
  21 #include <cmath>
  22 #include "util/numeric.h"
  23 #include "settings.h"
  24
  25 #ifndef SERVER
  26
  27 static u8 light_LUT[LIGHT_SUN + 1];
  28
  29 // The const ref to light_LUT is what is actually used in the code
  30 const u8 *light_decode_table = light_LUT;
  31
  32
  33 struct LightingParams {
  34         float a, b, c; // Lighting curve polynomial coefficients
  35         float boost, center, sigma; // Lighting curve parametric boost
  36         float gamma; // Lighting curve gamma correction
  37 };
  38
  39 static LightingParams params;
  40
  41
  42 float decode_light_f(float x)
  43 {
  44         if (x >= 1.0f) // x is often 1.0f
  45                 return 1.0f;
  46         x = std::fmax(x, 0.0f);
  47         float brightness = ((params.a * x + params.b) * x + params.c) * x;
  48         brightness += params.boost *
  49                 std::exp(-0.5f * sqr((x - params.center) / params.sigma));
  50         if (brightness <= 0.0f) // May happen if parameters are extreme
  51                 return 0.0f;
  52         if (brightness >= 1.0f)
  53                 return 1.0f;
  54         return powf(brightness, 1.0f / params.gamma);
  55 }
  56
  57
  58 // Initialize or update the light value tables using the specified gamma
  59 void set_light_table(float gamma)
  60 {
  61 // Lighting curve bounding gradients
  62         const float alpha = rangelim(g_settings->getFloat("lighting_alpha"), 0.0f, 3.0f);
  63         const float beta  = rangelim(g_settings->getFloat("lighting_beta"), 0.0f, 3.0f);
  64 // Lighting curve polynomial coefficients
  65         params.a = alpha + beta - 2.0f;
  66         params.b = 3.0f - 2.0f * alpha - beta;
  67         params.c = alpha;
  68 // Lighting curve parametric boost
  69         params.boost = rangelim(g_settings->getFloat("lighting_boost"), 0.0f, 0.4f);
  70         params.center = rangelim(g_settings->getFloat("lighting_boost_center"), 0.0f, 1.0f);
  71         params.sigma = rangelim(g_settings->getFloat("lighting_boost_spread"), 0.0f, 0.4f);
  72 // Lighting curve gamma correction
  73         params.gamma = rangelim(gamma, 0.33f, 3.0f);
  74
  75 // Boundary values should be fixed
  76         light_LUT[0] = 0;
  77         light_LUT[LIGHT_SUN] = 255;
  78
  79         for (size_t i = 1; i < LIGHT_SUN; i++) {
  80                 float brightness = decode_light_f((float)i / LIGHT_SUN);
  81                 // Strictly speaking, rangelim is not necessary here—if the implementation
  82                 // is conforming. But we don’t want problems in any case.
  83                 light_LUT[i] = rangelim((s32)(255.0f * brightness), 0, 255);
  84                 // Ensure light brightens with each level
  85                 if (i > 1 && light_LUT[i] <= light_LUT[i - 1])
  86                         light_LUT[i] = light_LUT[i - 1] + 1;
  87         }
  88 }
  89
  90 #endif