3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
23 #include "common_irrlicht.h"
29 Specifies a texture in an atlas.
31 This is used to specify single textures also.
33 This has been designed to be small enough to be thrown around a lot.
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.
45 video::ITexture *atlas_=NULL,
58 bool operator==(const AtlasPointer &other)
65 atlas == other.atlas &&
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; }
79 An internal variant of the former with more data.
81 struct SourceAtlasPointer
85 video::IImage *atlas_img; // The source image of the atlas
86 // Integer variants of position and size
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)
99 atlas_img(atlas_img_),
107 Implementation (to be used as a no-op on the server)
113 virtual ~ITextureSource(){}
114 virtual u32 getTextureId(const std::string &name){return 0;}
115 virtual u32 getTextureIdDirect(const std::string &name){return 0;}
116 virtual std::string getTextureName(u32 id){return "";}
117 virtual AtlasPointer getTexture(u32 id){return AtlasPointer(0);}
118 virtual AtlasPointer getTexture(const std::string &name)
119 {return AtlasPointer(0);}
120 virtual video::ITexture* getTextureRaw(const std::string &name)
125 Creates and caches textures.
127 class TextureSource : public ITextureSource
130 TextureSource(IrrlichtDevice *device);
134 Processes queued texture requests from other threads.
136 Shall be called from the main thread.
142 Now, assume a texture with the id 1 exists, and has the name
143 "stone.png^mineral1".
144 Then a random thread calls getTextureId for a texture called
145 "stone.png^mineral1^crack0".
146 ...Now, WTF should happen? Well:
147 - getTextureId strips off stuff recursively from the end until
148 the remaining part is found, or nothing is left when
149 something is stripped out
151 But it is slow to search for textures by names and modify them
153 - ContentFeatures is made to contain ids for the basic plain
155 - Crack textures can be slow by themselves, but the framework
159 - Assume a texture with the id 1 exists, and has the name
160 "stone.png^mineral1" and is specified as a part of some atlas.
161 - Now MapBlock::getNodeTile() stumbles upon a node which uses
162 texture id 1, and finds out that NODEMOD_CRACK must be applied
164 - It finds out the name of the texture with getTextureName(1),
165 appends "^crack0" to it and gets a new texture id with
166 getTextureId("stone.png^mineral1^crack0")
171 Gets a texture id from cache or
172 - if main thread, from getTextureIdDirect
173 - if other thread, adds to request queue and waits for main thread
175 u32 getTextureId(const std::string &name);
181 "stone.png^blit:mineral_coal.png"
182 "stone.png^blit:mineral_coal.png^crack1"
184 - If texture specified by name is found from cache, return the
186 - Otherwise generate the texture, add to cache and return id.
187 Recursion is used to find out the largest found part of the
188 texture and continue based on it.
190 The id 0 points to a NULL texture. It is returned in case of error.
192 u32 getTextureIdDirect(const std::string &name);
195 Finds out the name of a cached texture.
197 std::string getTextureName(u32 id);
200 If texture specified by the name pointed by the id doesn't
201 exist, create it, then return the cached texture.
203 Can be called from any thread. If called from some other thread
204 and not found in cache, the call is queued to the main thread
207 AtlasPointer getTexture(u32 id);
209 AtlasPointer getTexture(const std::string &name)
211 return getTexture(getTextureId(name));
214 // Gets a separate texture
215 video::ITexture* getTextureRaw(const std::string &name)
217 AtlasPointer ap = getTexture(name);
223 Build the main texture atlas which contains most of the
226 This is called by the constructor.
228 void buildMainAtlas();
230 // The id of the thread that is allowed to use irrlicht directly
231 threadid_t m_main_thread;
232 // The irrlicht device
233 IrrlichtDevice *m_device;
235 // A texture id is index in this array.
236 // The first position contains a NULL texture.
237 core::array<SourceAtlasPointer> m_atlaspointer_cache;
238 // Maps a texture name to an index in the former.
239 core::map<std::string, u32> m_name_to_id;
240 // The two former containers are behind this mutex
241 JMutex m_atlaspointer_cache_mutex;
243 // Main texture atlas. This is filled at startup and is then not touched.
244 video::IImage *m_main_atlas_image;
245 video::ITexture *m_main_atlas_texture;
247 // Queued texture fetches (to be processed by the main thread)
248 RequestQueue<std::string, u32, u8, u8> m_get_texture_queue;
253 MATERIAL_ALPHA_VERTEX,
254 MATERIAL_ALPHA_SIMPLE, // >127 = opaque
255 MATERIAL_ALPHA_BLEND,
259 #define MATERIAL_FLAG_BACKFACE_CULLING 0x01
262 This fully defines the looks of a tile.
263 The SMaterial of a tile is constructed according to this.
265 TODO: Change this to use an AtlasPointer
272 material_type(MATERIAL_ALPHA_NONE),
273 // Use this so that leaves don't need a separate material
274 //material_type(MATERIAL_ALPHA_SIMPLE),
276 MATERIAL_FLAG_BACKFACE_CULLING
281 bool operator==(TileSpec &other)
284 texture == other.texture &&
285 alpha == other.alpha &&
286 material_type == other.material_type &&
287 material_flags == other.material_flags
291 // Sets everything else except the texture in the material
292 void applyMaterialOptions(video::SMaterial &material)
294 if(alpha != 255 && material_type != MATERIAL_ALPHA_VERTEX)
295 dstream<<"WARNING: TileSpec: alpha != 255 "
296 "but not MATERIAL_ALPHA_VERTEX"
299 if(material_type == MATERIAL_ALPHA_NONE)
300 material.MaterialType = video::EMT_SOLID;
301 else if(material_type == MATERIAL_ALPHA_VERTEX)
302 material.MaterialType = video::EMT_TRANSPARENT_VERTEX_ALPHA;
303 else if(material_type == MATERIAL_ALPHA_SIMPLE)
304 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
305 else if(material_type == MATERIAL_ALPHA_BLEND)
306 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
308 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) ? true : false;
311 // NOTE: Deprecated, i guess?
312 void setTexturePos(u8 tx_, u8 ty_, u8 tw_, u8 th_)
314 texture.pos = v2f((float)tx_/256.0, (float)ty_/256.0);
315 texture.size = v2f(((float)tw_ + 1.0)/256.0, ((float)th_ + 1.0)/256.0);
318 AtlasPointer texture;