CEGUITexture.h

/***********************************************************************
        filename:       CEGUITexture.h
        created:        21/2/2004
        author:         Paul D Turner
        
        purpose:        Defines abstract interface for texture objects.  Texture
                                objects are created & destroyed by the Renderer.
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUITexture_h_
#define _CEGUITexture_h_

#include "CEGUIBase.h"
#include "CEGUIString.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT Texture
{
public:
    enum PixelFormat
    {
        PF_RGB,
        PF_RGBA
    };

        /*************************************************************************
                Abstract Interface
        *************************************************************************/
        virtual ushort  getWidth(void) const = 0;

    virtual ushort getOriginalWidth(void) const { return getWidth(); }

    virtual float getXScale(void) const { return 1.0f / static_cast<float>(getOriginalWidth()); } 

        virtual ushort  getHeight(void) const = 0;

    virtual ushort getOriginalHeight(void) const { return getHeight(); }

    virtual float getYScale(void) const { return 1.0f / static_cast<float>(getOriginalHeight()); }

        virtual void    loadFromFile(const String& filename, const String& resourceGroup) = 0;


        virtual void    loadFromMemory(const void* buffPtr, uint buffWidth, uint buffHeight, PixelFormat pixelFormat) = 0;


        Renderer*       getRenderer(void) const                 {return d_owner;}


protected:
        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
        Texture(Renderer* owner) : d_owner(owner) {}

        virtual ~Texture(void) {}

private:
        Renderer* d_owner;              //<! Renderer object that created and owns this texture
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUITexture_h_