3 Copyright (C) 2010-2013 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 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.
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.
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.
23 #include "irrlichttypes.h"
27 #include <IrrlichtDevice.h>
35 tile.{h,cpp}: Texture handling stuff.
39 Find out the full path of an image by trying different filename
44 TODO: Should probably be moved out from here, because things needing
45 this function do not need anything else from this header
47 std::string getImagePath(std::string path);
50 Gets the path to a texture by first checking if the texture exists
51 in texture_path and if not, using the data path.
53 Checks all supported extensions by replacing the original extension.
55 If not found, returns "".
57 Utilizes a thread-safe cache.
59 std::string getTexturePath(const std::string &filename);
61 void clearTextureNameCache();
64 ITextureSource::generateTextureFromMesh parameters
66 namespace irr {namespace scene {class IMesh;}}
67 struct TextureFromMeshParams
70 core::dimension2d<u32> dim;
71 std::string rtt_texture_name;
72 bool delete_texture_on_shutdown;
75 core::CMatrix4<f32> camera_projection_matrix;
76 video::SColorf ambient_light;
78 video::SColorf light_color;
83 TextureSource creates and caches textures.
86 class ISimpleTextureSource
89 ISimpleTextureSource(){}
90 virtual ~ISimpleTextureSource(){}
91 virtual video::ITexture* getTexture(
92 const std::string &name, u32 *id = NULL) = 0;
95 class ITextureSource : public ISimpleTextureSource
99 virtual ~ITextureSource(){}
100 virtual u32 getTextureId(const std::string &name)=0;
101 virtual std::string getTextureName(u32 id)=0;
102 virtual video::ITexture* getTexture(u32 id)=0;
103 virtual video::ITexture* getTexture(
104 const std::string &name, u32 *id = NULL)=0;
105 virtual IrrlichtDevice* getDevice()=0;
106 virtual bool isKnownSourceImage(const std::string &name)=0;
107 virtual video::ITexture* generateTextureFromMesh(
108 const TextureFromMeshParams ¶ms)=0;
109 virtual video::ITexture* getNormalTexture(const std::string &name)=0;
112 class IWritableTextureSource : public ITextureSource
115 IWritableTextureSource(){}
116 virtual ~IWritableTextureSource(){}
117 virtual u32 getTextureId(const std::string &name)=0;
118 virtual std::string getTextureName(u32 id)=0;
119 virtual video::ITexture* getTexture(u32 id)=0;
120 virtual video::ITexture* getTexture(
121 const std::string &name, u32 *id = NULL)=0;
122 virtual IrrlichtDevice* getDevice()=0;
123 virtual bool isKnownSourceImage(const std::string &name)=0;
124 virtual video::ITexture* generateTextureFromMesh(
125 const TextureFromMeshParams ¶ms)=0;
127 virtual void processQueue()=0;
128 virtual void insertSourceImage(const std::string &name, video::IImage *img)=0;
129 virtual void rebuildImagesAndTextures()=0;
130 virtual video::ITexture* getNormalTexture(const std::string &name)=0;
133 IWritableTextureSource* createTextureSource(IrrlichtDevice *device);
137 * @param size get next npot2 value
138 * @return npot2 value
140 inline unsigned int npot2(unsigned int size)
142 if (size == 0) return 0;
143 unsigned int npot = 1;
145 while ((size >>= 1) > 0) {
151 video::IImage * Align2Npot2(video::IImage * image, video::IVideoDriver* driver);
157 TILE_MATERIAL_LIQUID_TRANSPARENT,
158 TILE_MATERIAL_LIQUID_OPAQUE,
159 TILE_MATERIAL_WAVING_LEAVES,
160 TILE_MATERIAL_WAVING_PLANTS
164 // Should backface culling be enabled?
165 #define MATERIAL_FLAG_BACKFACE_CULLING 0x01
166 // Should a crack be drawn?
167 #define MATERIAL_FLAG_CRACK 0x02
168 // Should the crack be drawn on transparent pixels (unset) or not (set)?
169 // Ignored if MATERIAL_FLAG_CRACK is not set.
170 #define MATERIAL_FLAG_CRACK_OVERLAY 0x04
171 // Animation made up by splitting the texture to vertical frames, as
172 // defined by extra parameters
173 #define MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES 0x08
176 This fully defines the looks of a tile.
177 The SMaterial of a tile is constructed according to this.
188 video::ITexture *texture;
189 video::ITexture *normal_texture;
197 normal_texture(NULL),
199 material_type(TILE_MATERIAL_BASIC),
201 //0 // <- DEBUG, Use the one below
202 MATERIAL_FLAG_BACKFACE_CULLING
205 animation_frame_count(1),
206 animation_frame_length_ms(0),
211 bool operator==(const TileSpec &other) const
214 texture_id == other.texture_id &&
215 /* texture == other.texture && */
216 alpha == other.alpha &&
217 material_type == other.material_type &&
218 material_flags == other.material_flags &&
219 rotation == other.rotation
223 bool operator!=(const TileSpec &other) const
225 return !(*this == other);
228 // Sets everything else except the texture in the material
229 void applyMaterialOptions(video::SMaterial &material) const
231 switch(material_type){
232 case TILE_MATERIAL_BASIC:
233 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
235 case TILE_MATERIAL_ALPHA:
236 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
238 case TILE_MATERIAL_LIQUID_TRANSPARENT:
239 material.MaterialType = video::EMT_TRANSPARENT_VERTEX_ALPHA;
241 case TILE_MATERIAL_LIQUID_OPAQUE:
242 material.MaterialType = video::EMT_SOLID;
244 case TILE_MATERIAL_WAVING_LEAVES:
245 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
247 case TILE_MATERIAL_WAVING_PLANTS:
248 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
251 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) ? true : false;
254 void applyMaterialOptionsWithShaders(video::SMaterial &material) const
256 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) ? true : false;
260 video::ITexture *texture;
261 video::ITexture *normal_texture;
263 // Vertex alpha (when MATERIAL_ALPHA_VERTEX is used)
265 // Material parameters
269 // Animation parameters
270 u8 animation_frame_count;
271 u16 animation_frame_length_ms;
272 std::map<u32, FrameSpec> frames;