1 /* 2 * This source file is part of libRocket, the HTML/CSS Interface Middleware 3 * 4 * For the latest information, see http://www.librocket.com 5 * 6 * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd 7 * 8 * Permission is hereby granted, free of charge, to any person obtaining a copy 9 * of this software and associated documentation files (the "Software"), to deal 10 * in the Software without restriction, including without limitation the rights 11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 12 * copies of the Software, and to permit persons to whom the Software is 13 * furnished to do so, subject to the following conditions: 14 * 15 * The above copyright notice and this permission notice shall be included in 16 * all copies or substantial portions of the Software. 17 * 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 24 * THE SOFTWARE. 25 * 26 */ 27 28 #ifndef ROCKETCORETEXTURE_H 29 #define ROCKETCORETEXTURE_H 30 31 #include "Header.h" 32 #include "Types.h" 33 34 namespace Rocket { 35 namespace Core { 36 37 class TextureResource; 38 class RenderInterface; 39 40 /** 41 Abstraction of a two-dimensional texture image, with an application-specific texture handle. 42 43 @author Peter Curry 44 */ 45 46 struct ROCKETCORE_API Texture 47 { 48 public: 49 /// Constructs an unloaded texture with no resource. 50 Texture(); 51 /// Constructs a texture sharing the resource of another. 52 Texture(const Texture&); 53 ~Texture(); 54 55 /// Attempts to load a texture. 56 /// @param[in] source The name of the texture. 57 /// @param[in] source_path The path of the resource that is requesting the texture (ie, the RCSS file in which it was specified, etc). 58 /// @return True if the texture loaded successfully, false if not. 59 bool Load(const String& source, const String& source_path = ""); 60 61 /// Returns the texture's source name. This is usually the name of the file the texture was loaded from. 62 /// @return The name of the this texture's source. This will be the empty string if this texture is not loaded. 63 String GetSource() const; 64 /// Returns the texture's handle. 65 /// @param[in] The render interface that is requesting the handle. 66 /// @return The texture's handle. This will be NULL if the texture isn't loaded. 67 TextureHandle GetHandle(RenderInterface* render_interface) const; 68 /// Returns the texture's dimensions. 69 /// @param[in] The render interface that is requesting the dimensions. 70 /// @return The texture's dimensions. This will be (0, 0) if the texture isn't loaded. 71 Vector2i GetDimensions(RenderInterface* render_interface) const; 72 73 /// Releases this texture's resource (if any), and sets it to another texture's resource. 74 const Texture& operator=(const Texture&); 75 76 private: 77 TextureResource* resource; 78 }; 79 80 } 81 } 82 83 #endif 84