ITexture.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 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 "EDriverTypes.h"
#include <string>
 
namespace saga
{
namespace video
{
 
 
class ITexture
{
public:
 
    ITexture(const std::string& name, E_TEXTURE_TYPE type)
    :    NamedPath(name), DriverType(E_DRIVER_TYPE::NULL_DRIVER),
         OriginalColorFormat(E_PIXEL_FORMAT::UNKNOWN),
         ColorFormat(E_PIXEL_FORMAT::UNKNOWN), Pitch(0),
         HasMipMaps(false), IsRenderTarget(false),
         Source(E_TEXTURE_SOURCE::UNKNOWN), Type(type)
  {
  }
 
 
    virtual void* lock(E_TEXTURE_LOCK_MODE mode = E_TEXTURE_LOCK_MODE::READ_WRITE, std::uint32_t layer = 0) = 0;
 
 
  virtual void unlock() = 0;
 
 
  virtual void regenerateMipMapLevels(void* data = 0, std::uint32_t layer = 0) = 0;
 
 
  const glm::uvec2& getOriginalSize() const { return OriginalSize; };
 
 
  const glm::uvec2& getSize() const { return Size; };
 
 
  E_DRIVER_TYPE getDriverType() const { return DriverType; };
 
 
  E_PIXEL_FORMAT getColorFormat() const { return ColorFormat; };
 
 
  std::uint32_t getPitch() const { return Pitch; };
 
 
  bool hasMipMaps() const { return HasMipMaps; }
 
 
  bool isRenderTarget() const { return IsRenderTarget; }
 
  const std::string& getName() const { return NamedPath; }
 
  E_TEXTURE_SOURCE getSource() const { return Source; }
 
  void updateSource(E_TEXTURE_SOURCE source) { Source = source; }
 
  bool hasAlpha() const
  {
    bool status = false;
 
    switch (ColorFormat)
    {
        case E_PIXEL_FORMAT::RGBA8:
        case E_PIXEL_FORMAT::DXT1:
        case E_PIXEL_FORMAT::DXT2:
        case E_PIXEL_FORMAT::DXT3:
        case E_PIXEL_FORMAT::DXT4:
        case E_PIXEL_FORMAT::DXT5:
        case E_PIXEL_FORMAT::A16B16G16R16F:
        case E_PIXEL_FORMAT::A32B32G32R32F:
      status = true;
      break;
    default:
      break;
    }
 
    return status;
  }
 
  E_TEXTURE_TYPE getType() const { return Type; }
 
protected:
  std::string NamedPath;
  glm::uvec2 OriginalSize;
  glm::uvec2 Size;
  E_DRIVER_TYPE DriverType;
  E_PIXEL_FORMAT OriginalColorFormat;
  E_PIXEL_FORMAT ColorFormat;
  std::uint32_t Pitch;
  bool HasMipMaps;
  bool IsRenderTarget;
  E_TEXTURE_SOURCE Source;
  E_TEXTURE_TYPE Type;
};
 
 
} // namespace video
} // namespace saga
 
#endif