ITexture.h

Go to the documentation of this file.

// Copyright (C) 2002-2011 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_TEXTURE_H_INCLUDED__
#define __I_TEXTURE_H_INCLUDED__

#include "IReferenceCounted.h"
#include "IImage.h"
#include "dimension2d.h"
#include "EDriverTypes.h"
#include "path.h"
#include "matrix4.h"

namespace irr
{
namespace video
{


enum E_TEXTURE_CREATION_FLAG
{
        ETCF_ALWAYS_16_BIT = 0x00000001,

        ETCF_ALWAYS_32_BIT = 0x00000002,

        ETCF_OPTIMIZED_FOR_QUALITY = 0x00000004,

        ETCF_OPTIMIZED_FOR_SPEED = 0x00000008,

        ETCF_CREATE_MIP_MAPS = 0x00000010,

        ETCF_NO_ALPHA_CHANNEL = 0x00000020,


        ETCF_ALLOW_NON_POWER_2 = 0x00000040,

        ETCF_FORCE_32_BIT_DO_NOT_USE = 0x7fffffff
};

enum E_TEXTURE_LOCK_MODE
{
        ETLM_READ_WRITE = 0,


        ETLM_READ_ONLY,


        ETLM_WRITE_ONLY
};


class ITexture : public virtual IReferenceCounted
{
public:

        ITexture(const io::path& name) : NamedPath(name)
        {
        }


        virtual void* lock(E_TEXTURE_LOCK_MODE mode=ETLM_READ_WRITE, u32 mipmapLevel=0) = 0;


        virtual void unlock() = 0;


        virtual const core::dimension2d<u32>& getOriginalSize() const = 0;


        virtual const core::dimension2d<u32>& getSize() const = 0;


        virtual E_DRIVER_TYPE getDriverType() const = 0;


        virtual ECOLOR_FORMAT getColorFormat() const = 0;


        virtual u32 getPitch() const = 0;


        virtual bool hasMipMaps() const { return false; }

        virtual bool hasAlpha() const {
                return getColorFormat () == video::ECF_A8R8G8B8 || getColorFormat () == video::ECF_A1R5G5B5;
        }


        virtual void regenerateMipMapLevels(void* mipmapData=0) = 0;


        virtual bool isRenderTarget() const { return false; }

        const io::SNamedPath& getName() const { return NamedPath; }

protected:


        inline E_TEXTURE_CREATION_FLAG getTextureFormatFromFlags(u32 flags)
        {
                if (flags & ETCF_OPTIMIZED_FOR_SPEED)
                        return ETCF_OPTIMIZED_FOR_SPEED;
                if (flags & ETCF_ALWAYS_16_BIT)
                        return ETCF_ALWAYS_16_BIT;
                if (flags & ETCF_ALWAYS_32_BIT)
                        return ETCF_ALWAYS_32_BIT;
                if (flags & ETCF_OPTIMIZED_FOR_QUALITY)
                        return ETCF_OPTIMIZED_FOR_QUALITY;
                return ETCF_OPTIMIZED_FOR_SPEED;
        }

        io::SNamedPath NamedPath;
};


} // end namespace video
} // end namespace irr

#endif