MyGUI  3.0.1
MyGUI_ITexture.h
Go to the documentation of this file.
00001 
00007 /*
00008     This file is part of MyGUI.
00009 
00010     MyGUI is free software: you can redistribute it and/or modify
00011     it under the terms of the GNU Lesser General Public License as published by
00012     the Free Software Foundation, either version 3 of the License, or
00013     (at your option) any later version.
00014 
00015     MyGUI is distributed in the hope that it will be useful,
00016     but WITHOUT ANY WARRANTY; without even the implied warranty of
00017     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018     GNU Lesser General Public License for more details.
00019 
00020     You should have received a copy of the GNU Lesser General Public License
00021     along with MyGUI.  If not, see <http://www.gnu.org/licenses/>.
00022 */
00023 #ifndef __MYGUI_I_TEXTURE_H__
00024 #define __MYGUI_I_TEXTURE_H__
00025 
00026 #include "MyGUI_Prerequest.h"
00027 #include "MyGUI_IRenderTarget.h"
00028 #include "MyGUI_RenderFormat.h"
00029 #include <string>
00030 
00031 namespace MyGUI
00032 {
00033     class ITexture;
00034 
00035     class MYGUI_EXPORT ITextureInvalidateListener
00036     {
00037     public:
00038         virtual void textureInvalidate(ITexture* _texture) = 0;
00039     };
00040 
00041     class MYGUI_EXPORT ITexture
00042     {
00043     public:
00044         virtual ~ITexture() { }
00045 
00046         virtual const std::string& getName() const = 0;
00047 
00048         virtual void createManual(int _width, int _height, TextureUsage _usage, PixelFormat _format) = 0;
00049         virtual void loadFromFile(const std::string& _filename) = 0;
00050         virtual void saveToFile(const std::string& _filename) = 0;
00051 
00052         virtual void setInvalidateListener(ITextureInvalidateListener* _listener) { }
00053 
00054         virtual void destroy() = 0;
00055 
00056         virtual void* lock(TextureUsage _access) = 0;
00057         virtual void unlock() = 0;
00058         virtual bool isLocked() = 0;
00059 
00060         virtual int getWidth() = 0;
00061         virtual int getHeight() = 0;
00062 
00063         virtual PixelFormat getFormat() = 0;
00064         virtual TextureUsage getUsage() = 0;
00065         virtual size_t getNumElemBytes() = 0;
00066 
00067         virtual IRenderTarget* getRenderTarget() { return nullptr; }
00068 
00069     };
00070 
00071 } // namespace MyGUI
00072 
00073 #endif // __MYGUI_I_TEXTURE_H__