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 #ifndef LIGHT_HEADER
  21 #define LIGHT_HEADER
  22
  23 #include "irrlichttypes.h"
  24 #include "debug.h"
  25
  26 /*
  27         Day/night cache:
  28         Meshes are cached for different day-to-night transition values
  29 */
  30
  31 /*#define DAYNIGHT_CACHE_COUNT 3
  32 // First one is day, last one is night.
  33 extern u32 daynight_cache_ratios[DAYNIGHT_CACHE_COUNT];*/
  34
  35 /*
  36         Lower level lighting stuff
  37 */
  38
  39 // This directly sets the range of light.
  40 // Actually this is not the real maximum, and this is not the
  41 // brightest. The brightest is LIGHT_SUN.
  42 #define LIGHT_MAX 14
  43 // Light is stored as 4 bits, thus 15 is the maximum.
  44 // This brightness is reserved for sunlight
  45 #define LIGHT_SUN 15
  46
  47 inline u8 diminish_light(u8 light)
  48 {
  49         if(light == 0)
  50                 return 0;
  51         if(light >= LIGHT_MAX)
  52                 return LIGHT_MAX - 1;
  53
  54         return light - 1;
  55 }
  56
  57 inline u8 diminish_light(u8 light, u8 distance)
  58 {
  59         if(distance >= light)
  60                 return 0;
  61         return  light - distance;
  62 }
  63
  64 inline u8 undiminish_light(u8 light)
  65 {
  66         // We don't know if light should undiminish from this particular 0.
  67         // Thus, keep it at 0.
  68         if(light == 0)
  69                 return 0;
  70         if(light == LIGHT_MAX)
  71                 return light;
  72
  73         return light + 1;
  74 }
  75
  76 extern u8 light_decode_table[LIGHT_MAX+1];
  77
  78 // 0 <= light <= LIGHT_SUN
  79 // 0 <= return value <= 255
  80 inline u8 decode_light(u8 light)
  81 {
  82         if(light > LIGHT_MAX)
  83                 light = LIGHT_MAX;
  84
  85         return light_decode_table[light];
  86 }
  87
  88 // 0.0 <= light <= 1.0
  89 // 0.0 <= return value <= 1.0
  90 inline float decode_light_f(float light_f)
  91 {
  92         s32 i = (u32)(light_f * LIGHT_MAX + 0.5);
  93
  94         if(i <= 0)
  95                 return (float)light_decode_table[0] / 255.0;
  96         if(i >= LIGHT_MAX)
  97                 return (float)light_decode_table[LIGHT_MAX] / 255.0;
  98
  99         float v1 = (float)light_decode_table[i-1] / 255.0;
 100         float v2 = (float)light_decode_table[i] / 255.0;
 101         float f0 = (float)i - 0.5;
 102         float f = light_f * LIGHT_MAX - f0;
 103         return f * v2 + (1.0 - f) * v1;
 104 }
 105
 106 // 0 <= daylight_factor <= 1000
 107 // 0 <= lightday, lightnight <= LIGHT_SUN
 108 // 0 <= return value <= LIGHT_SUN
 109 inline u8 blend_light(u32 daylight_factor, u8 lightday, u8 lightnight)
 110 {
 111         u32 c = 1000;
 112         u32 l = ((daylight_factor * lightday + (c-daylight_factor) * lightnight))/c;
 113         if(l > LIGHT_SUN)
 114                 l = LIGHT_SUN;
 115         return l;
 116 }
 117
 118 // 0.0 <= daylight_factor <= 1.0
 119 // 0 <= lightday, lightnight <= LIGHT_SUN
 120 // 0 <= return value <= 255
 121 inline u8 blend_light_f1(float daylight_factor, u8 lightday, u8 lightnight)
 122 {
 123         u8 l = ((daylight_factor * decode_light(lightday) +
 124                         (1.0-daylight_factor) * decode_light(lightnight)));
 125         return l;
 126 }
 127
 128 #endif
 129