urho3d/Engine/Graphics/Texture.h

//
// Urho3D Engine
// Copyright (c) 2008-2011 Lasse Öörni
//
// 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 OR COPYRIGHT HOLDERS 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.
//

#pragma once

#include "Color.h"
#include "GPUObject.h"
#include "Image.h"
#include "GraphicsDefs.h"
#include "Resource.h"

static const int MAX_TEXTURE_QUALITY_LEVELS = 3;

class XMLFile;

/// Base class for texture resources
class Texture : public Resource, public GPUObject
{
public:
    /// Construct
    Texture(Context* context);
    /// Destruct
    virtual ~Texture();
    
    /// Set number of requested mipmap levels. Needs to be called before setting size
    void SetNumLevels(unsigned levels);
    /// Set filtering mode
    void SetFilterMode(TextureFilterMode filter);
    /// Set addressing mode by texture coordinate
    void SetAddressMode(TextureCoordinate coord, TextureAddressMode address);
    /// Set border color for border addressing mode
    void SetBorderColor(const Color& color);
    /// Set backup texture to use when rendering to this texture
    void SetBackupTexture(Texture* texture);
    /// Clear default pool data lost flag
    void ClearDataLost();
    
    /// Return texture usage type
    TextureUsage GetUsage() const;
    /// Return texture format
    unsigned GetFormat() const { return format_; }
    /// Return number of mipmap levels
    unsigned GetLevels() const { return levels_; }
    /// Return width
    int GetWidth() const { return width_; }
    /// Return height
    int GetHeight() const { return height_; }
    /// Return whether default pool data is lost
    bool IsDataLost() const { return dataLost_; }
    /// Return filtering mode
    TextureFilterMode GetFilterMode() const { return filterMode_; }
    /// Return addressing mode by texture coordinate
    TextureAddressMode GetAddressMode(TextureCoordinate coord) const { return addressMode_[coord]; }
    /// Return border color
    const Color& GetBorderColor() const { return borderColor_; }
    /// Return backup texture
    Texture* GetBackupTexture() const { return backupTexture_; }
    /// Return compressed format
    static unsigned GetCompressedD3DFormat(CompressedFormat format);
    
protected:
    /// Load parameters
    void LoadParameters();
    /// Load parameters from an XML file
    void LoadParameters(XMLFile* xml);
    /// Check whether texture memory budget has been exceeded. Free unused materials in that case to release the texture references
    void CheckTextureBudget(ShortStringHash type);
    
    /// Texture format
    unsigned format_;
    /// Memory pool
    unsigned pool_;
    /// Texture usage type
    unsigned usage_;
    /// Current mipmap levels
    unsigned levels_;
    /// Requested mipmap levels
    unsigned requestedLevels_;
    /// Texture width
    int width_;
    /// Texture height
    int height_;
    /// Default pool data lost flag
    bool dataLost_;
    /// Filtering mode
    TextureFilterMode filterMode_;
    /// Addressing mode
    TextureAddressMode addressMode_[MAX_COORDS];
    /// Mipmaps to skip when loading
    unsigned mipsToSkip_[MAX_TEXTURE_QUALITY_LEVELS];
    /// Border color
    Color borderColor_;
    /// Backup texture
    SharedPtr<Texture> backupTexture_;
};