src/tile.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 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 General Public License as published by
   7 the Free Software Foundation; either version 2 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 General Public License for more details.
  14
  15 You should have received a copy of the GNU 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 TILE_HEADER
  21 #define TILE_HEADER
  22
  23 #include "common_irrlicht.h"
  24 #include "threads.h"
  25 #include "utility.h"
  26 #include <string>
  27
  28 /*
  29         Specifies a texture in an atlas.
  30
  31         This is used to specify single textures also.
  32
  33         This has been designed to be small enough to be thrown around a lot.
  34 */
  35 struct AtlasPointer
  36 {
  37         u32 id; // Texture id
  38         video::ITexture *atlas; // Atlas in where the texture is
  39         v2f pos; // Position in atlas
  40         v2f size; // Size in atlas
  41         u16 tiled; // X-wise tiling count. If 0, width of atlas is width of image.
  42
  43         AtlasPointer(
  44                         u16 id_,
  45                         video::ITexture *atlas_=NULL,
  46                         v2f pos_=v2f(0,0),
  47                         v2f size_=v2f(1,1),
  48                         u16 tiled_=1
  49                 ):
  50                 id(id_),
  51                 atlas(atlas_),
  52                 pos(pos_),
  53                 size(size_),
  54                 tiled(tiled_)
  55         {
  56         }
  57
  58         bool operator==(const AtlasPointer &other)
  59         {
  60                 return (
  61                         id == other.id
  62                 );
  63                 /*return (
  64                         id == other.id &&
  65                         atlas == other.atlas &&
  66                         pos == other.pos &&
  67                         size == other.size &&
  68                         tiled == other.tiled
  69                 );*/
  70         }
  71
  72         float x0(){ return pos.X; }
  73         float x1(){ return pos.X + size.X; }
  74         float y0(){ return pos.Y; }
  75         float y1(){ return pos.Y + size.Y; }
  76 };
  77
  78 /*
  79         An internal variant of the former with more data.
  80 */
  81 struct SourceAtlasPointer
  82 {
  83         std::string name;
  84         AtlasPointer a;
  85         video::IImage *atlas_img; // The source image of the atlas
  86         // Integer variants of position and size
  87         v2s32 intpos;
  88         v2u32 intsize;
  89
  90         SourceAtlasPointer(
  91                         const std::string &name_,
  92                         AtlasPointer a_=AtlasPointer(0, NULL),
  93                         video::IImage *atlas_img_=NULL,
  94                         v2s32 intpos_=v2s32(0,0),
  95                         v2u32 intsize_=v2u32(0,0)
  96                 ):
  97                 name(name_),
  98                 a(a_),
  99                 atlas_img(atlas_img_),
 100                 intpos(intpos_),
 101                 intsize(intsize_)
 102         {
 103         }
 104 };
 105
 106 /*
 107         Creates and caches textures.
 108 */
 109 class TextureSource
 110 {
 111 public:
 112         TextureSource(IrrlichtDevice *device);
 113         ~TextureSource();
 114
 115         /*
 116                 Processes queued texture requests from other threads.
 117
 118                 Shall be called from the main thread.
 119         */
 120         void processQueue();
 121
 122         /*
 123                 Example case:
 124                 Now, assume a texture with the id 1 exists, and has the name
 125                 "stone.png^mineral1".
 126                 Then a random thread calls getTextureId for a texture called
 127                 "stone.png^mineral1^crack0".
 128                 ...Now, WTF should happen? Well:
 129                 - getTextureId strips off stuff recursively from the end until
 130                   the remaining part is found, or nothing is left when
 131                   something is stripped out
 132
 133                 But it is slow to search for textures by names and modify them
 134                 like that?
 135                 - ContentFeatures is made to contain ids for the basic plain
 136                   textures
 137                 - Crack textures can be slow by themselves, but the framework
 138                   must be fast.
 139
 140                 Example case #2:
 141                 - Assume a texture with the id 1 exists, and has the name
 142                   "stone.png^mineral1" and is specified as a part of some atlas.
 143                 - Now MapBlock::getNodeTile() stumbles upon a node which uses
 144                   texture id 1, and finds out that NODEMOD_CRACK must be applied
 145                   with progression=0
 146                 - It finds out the name of the texture with getTextureName(1),
 147                   appends "^crack0" to it and gets a new texture id with
 148                   getTextureId("stone.png^mineral1^crack0")
 149
 150         */
 151
 152         /*
 153                 Gets a texture id from cache or
 154                 - if main thread, from getTextureIdDirect
 155                 - if other thread, adds to request queue and waits for main thread
 156         */
 157         u32 getTextureId(const std::string &name);
 158
 159         /*
 160                 Example names:
 161                 "stone.png"
 162                 "stone.png^crack2"
 163                 "stone.png^blit:mineral_coal.png"
 164                 "stone.png^blit:mineral_coal.png^crack1"
 165
 166                 - If texture specified by name is found from cache, return the
 167                   cached id.
 168                 - Otherwise generate the texture, add to cache and return id.
 169                   Recursion is used to find out the largest found part of the
 170                   texture and continue based on it.
 171
 172                 The id 0 points to a NULL texture. It is returned in case of error.
 173         */
 174         u32 getTextureIdDirect(const std::string &name);
 175
 176         /*
 177                 Finds out the name of a cached texture.
 178         */
 179         std::string getTextureName(u32 id);
 180
 181         /*
 182                 If texture specified by the name pointed by the id doesn't
 183                 exist, create it, then return the cached texture.
 184
 185                 Can be called from any thread. If called from some other thread
 186                 and not found in cache, the call is queued to the main thread
 187                 for processing.
 188         */
 189         AtlasPointer getTexture(u32 id);
 190
 191         AtlasPointer getTexture(const std::string &name)
 192         {
 193                 return getTexture(getTextureId(name));
 194         }
 195
 196 private:
 197         /*
 198                 Build the main texture atlas which contains most of the
 199                 textures.
 200
 201                 This is called by the constructor.
 202         */
 203         void buildMainAtlas();
 204
 205         // The id of the thread that is allowed to use irrlicht directly
 206         threadid_t m_main_thread;
 207         // The irrlicht device
 208         IrrlichtDevice *m_device;
 209
 210         // A texture id is index in this array.
 211         // The first position contains a NULL texture.
 212         core::array<SourceAtlasPointer> m_atlaspointer_cache;
 213         // Maps a texture name to an index in the former.
 214         core::map<std::string, u32> m_name_to_id;
 215         // The two former containers are behind this mutex
 216         JMutex m_atlaspointer_cache_mutex;
 217
 218         // Main texture atlas. This is filled at startup and is then not touched.
 219         video::IImage *m_main_atlas_image;
 220         video::ITexture *m_main_atlas_texture;
 221
 222         // Queued texture fetches (to be processed by the main thread)
 223         RequestQueue<std::string, u32, u8, u8> m_get_texture_queue;
 224 };
 225
 226 enum MaterialType{
 227         MATERIAL_ALPHA_NONE,
 228         MATERIAL_ALPHA_VERTEX,
 229         MATERIAL_ALPHA_SIMPLE, // >127 = opaque
 230         MATERIAL_ALPHA_BLEND,
 231 };
 232
 233 // Material flags
 234 #define MATERIAL_FLAG_BACKFACE_CULLING 0x01
 235
 236 /*
 237         This fully defines the looks of a tile.
 238         The SMaterial of a tile is constructed according to this.
 239
 240         TODO: Change this to use an AtlasPointer
 241 */
 242 struct TileSpec
 243 {
 244         TileSpec():
 245                 texture(0),
 246                 alpha(255),
 247                 material_type(MATERIAL_ALPHA_NONE),
 248                 // Use this so that leaves don't need a separate material
 249                 //material_type(MATERIAL_ALPHA_SIMPLE),
 250                 material_flags(
 251                         MATERIAL_FLAG_BACKFACE_CULLING
 252                 )
 253         {
 254         }
 255
 256         bool operator==(TileSpec &other)
 257         {
 258                 return (
 259                         texture == other.texture &&
 260                         alpha == other.alpha &&
 261                         material_type == other.material_type &&
 262                         material_flags == other.material_flags
 263                 );
 264         }
 265
 266         // Sets everything else except the texture in the material
 267         void applyMaterialOptions(video::SMaterial &material)
 268         {
 269                 if(alpha != 255 && material_type != MATERIAL_ALPHA_VERTEX)
 270                         dstream<<"WARNING: TileSpec: alpha != 255 "
 271                                         "but not MATERIAL_ALPHA_VERTEX"
 272                                         <<std::endl;
 273
 274                 if(material_type == MATERIAL_ALPHA_NONE)
 275                         material.MaterialType = video::EMT_SOLID;
 276                 else if(material_type == MATERIAL_ALPHA_VERTEX)
 277                         material.MaterialType = video::EMT_TRANSPARENT_VERTEX_ALPHA;
 278                 else if(material_type == MATERIAL_ALPHA_SIMPLE)
 279                         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
 280                 else if(material_type == MATERIAL_ALPHA_BLEND)
 281                         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
 282
 283                 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) ? true : false;
 284         }
 285
 286         // NOTE: Deprecated, i guess?
 287         void setTexturePos(u8 tx_, u8 ty_, u8 tw_, u8 th_)
 288         {
 289                 texture.pos = v2f((float)tx_/256.0, (float)ty_/256.0);
 290                 texture.size = v2f(((float)tw_ + 1.0)/256.0, ((float)th_ + 1.0)/256.0);
 291         }
 292
 293         AtlasPointer texture;
 294         // Vertex alpha
 295         u8 alpha;
 296         // Material type
 297         u8 material_type;
 298         // Material flags
 299         u8 material_flags;
 300 };
 301
 302 #endif