src/light.h

   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 #pragma once
  21
  22 #include "irrlichttypes.h"
  23
  24 /*
  25         Lower level lighting stuff
  26 */
  27
  28 // This directly sets the range of light.
  29 // Actually this is not the real maximum, and this is not the brightest, the
  30 // brightest is LIGHT_SUN.
  31 // If changed, this constant as defined in builtin/game/constants.lua must
  32 // also be changed.
  33 #define LIGHT_MAX 14
  34 // Light is stored as 4 bits, thus 15 is the maximum.
  35 // This brightness is reserved for sunlight
  36 #define LIGHT_SUN 15
  37
  38 inline u8 diminish_light(u8 light)
  39 {
  40         if (light == 0)
  41                 return 0;
  42         if (light >= LIGHT_MAX)
  43                 return LIGHT_MAX - 1;
  44
  45         return light - 1;
  46 }
  47
  48 inline u8 diminish_light(u8 light, u8 distance)
  49 {
  50         if (distance >= light)
  51                 return 0;
  52         return light - distance;
  53 }
  54
  55 inline u8 undiminish_light(u8 light)
  56 {
  57         // We don't know if light should undiminish from this particular 0.
  58         // Thus, keep it at 0.
  59         if (light == 0)
  60                 return 0;
  61         if (light == LIGHT_MAX)
  62                 return light;
  63
  64         return light + 1;
  65 }
  66
  67 #ifndef SERVER
  68
  69 /**
  70  * \internal
  71  *
  72  * \warning DO NOT USE this directly; it is here simply so that decode_light()
  73  * can be inlined.
  74  *
  75  * Array size is #LIGHTMAX+1
  76  *
  77  * The array is a lookup table to convert the internal representation of light
  78  * (brightness) to the display brightness.
  79  *
  80  */
  81 extern const u8 *light_decode_table;
  82
  83 // 0 <= light <= LIGHT_SUN
  84 // 0 <= return value <= 255
  85 inline u8 decode_light(u8 light)
  86 {
  87         if (light > LIGHT_MAX)
  88                 light = LIGHT_MAX;
  89
  90         return light_decode_table[light];
  91 }
  92
  93 // 0.0 <= light <= 1.0
  94 // 0.0 <= return value <= 1.0
  95 inline float decode_light_f(float light_f)
  96 {
  97         s32 i = (u32)(light_f * LIGHT_MAX + 0.5);
  98
  99         if (i <= 0)
 100                 return (float)light_decode_table[0] / 255.0;
 101         if (i >= LIGHT_MAX)
 102                 return (float)light_decode_table[LIGHT_MAX] / 255.0;
 103
 104         float v1 = (float)light_decode_table[i - 1] / 255.0;
 105         float v2 = (float)light_decode_table[i] / 255.0;
 106         float f0 = (float)i - 0.5;
 107         float f = light_f * LIGHT_MAX - f0;
 108         return f * v2 + (1.0 - f) * v1;
 109 }
 110
 111 void set_light_table(float gamma);
 112
 113 #endif // ifndef SERVER
 114
 115 // 0 <= daylight_factor <= 1000
 116 // 0 <= lightday, lightnight <= LIGHT_SUN
 117 // 0 <= return value <= LIGHT_SUN
 118 inline u8 blend_light(u32 daylight_factor, u8 lightday, u8 lightnight)
 119 {
 120         u32 c = 1000;
 121         u32 l = ((daylight_factor * lightday + (c - daylight_factor) * lightnight)) / c;
 122         if (l > LIGHT_SUN)
 123                 l = LIGHT_SUN;
 124         return l;
 125 }