Magic_Game/src/kiwano/render/Texture.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// 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 <kiwano/core/Resource.h>
#include <kiwano/render/NativeObject.h>

namespace kiwano
{

KGE_DECLARE_SMART_PTR(Texture);

/**
 * \addtogroup Render
 * @{
 */

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD>ֵģʽ
 * @details <EFBFBD><EFBFBD>ֵģʽָ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>λͼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ź<EFBFBD><EFBFBD><EFBFBD>תʱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ɫ<EFBFBD>ļ<EFBFBD><EFBFBD>㷽ʽ
 */
enum class InterpolationMode
{
    Linear,  ///< ˫<><CBAB><EFBFBD>Բ<EFBFBD>ֵ<EFBFBD><D6B5><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Χ<EFBFBD>ĸ<EFBFBD><C4B8><EFBFBD><EFBFBD>ؽ<EFBFBD><D8BD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Բ<EFBFBD>ֵ<EFBFBD><D6B5><EFBFBD>㣬<EFBFBD><E3A3AC>ͼ<EFBFBD><CDBC><EFBFBD>Ŵ<EFBFBD>ʱ<EFBFBD><CAB1><EFBFBD>ܻ<EFBFBD>ģ<EFBFBD><C4A3>
    Nearest  ///< <20><><EFBFBD>ڽ<EFBFBD><DABD><EFBFBD>ֵ<EFBFBD><D6B5>ȡ<EFBFBD><C8A1><EFBFBD>ڽ<EFBFBD><DABD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ص<EFBFBD><D8B5><EFBFBD><EFBFBD><EFBFBD>ɫֵ
};

/// \~chinese
/// @brief <20><><EFBFBD>ش<EFBFBD>С
typedef math::Vec2T<uint32_t> PixelSize;

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
class KGE_API Texture : public NativeObject
{
public:
    /// \~chinese
    /// @brief Ԥ<><D4A4><EFBFBD>ر<EFBFBD><D8B1><EFBFBD>ͼƬ
    static TexturePtr Preload(const String& file_path);

    /// \~chinese
    /// @brief Ԥ<><D4A4><EFBFBD><EFBFBD>ͼƬ<CDBC><C6AC>Դ
    static TexturePtr Preload(const Resource& res);

    Texture();

    /// \~chinese
    /// @brief <20>ӱ<EFBFBD><D3B1><EFBFBD><EFBFBD>ļ<EFBFBD><C4BC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    Texture(const String& file_path);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>Դ<EFBFBD><D4B4><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    Texture(const Resource& res);

    virtual ~Texture();

    /// \~chinese
    /// @brief <20><><EFBFBD>ر<EFBFBD><D8B1><EFBFBD><EFBFBD>ļ<EFBFBD>
    bool Load(const String& file_path);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Դ
    bool Load(const Resource& res);

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    float GetWidth() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD>߶<EFBFBD>
    float GetHeight() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>С
    Size GetSize() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD>ؿ<EFBFBD><D8BF><EFBFBD>
    uint32_t GetWidthInPixels() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD>ظ߶<D8B8>
    uint32_t GetHeightInPixels() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD>ش<EFBFBD>С
    PixelSize GetSizeInPixels() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD>ز<EFBFBD>ֵ<EFBFBD><D6B5>ʽ
    InterpolationMode GetBitmapInterpolationMode() const;
    /// \~chinese
    /// @brief <20><><EFBFBD>ô<EFBFBD>С
    void SetSize(const Size& size);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ش<EFBFBD>С
    void SetSizeInPixels(const PixelSize& size);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ز<EFBFBD>ֵ<EFBFBD><D6B5>ʽ
    void SetInterpolationMode(InterpolationMode mode);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param copy_from Դ<><D4B4><EFBFBD><EFBFBD>
    void CopyFrom(TexturePtr copy_from);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param copy_from Դ<><D4B4><EFBFBD><EFBFBD>
    /// @param src_rect Դ<><D4B4><EFBFBD><EFBFBD><EFBFBD>ü<EFBFBD><C3BC><EFBFBD><EFBFBD><EFBFBD>
    /// @param dest_point <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ŀ<EFBFBD><C4BF>λ<EFBFBD><CEBB>
    void CopyFrom(TexturePtr copy_from, const Rect& src_rect, const Point& dest_point);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>Ĭ<EFBFBD>ϵ<EFBFBD><CFB5><EFBFBD><EFBFBD>ز<EFBFBD>ֵ<EFBFBD><D6B5>ʽ
    static void SetDefaultInterpolationMode(InterpolationMode mode);

    /// \~chinese
    /// @brief <20><>ȡĬ<C8A1>ϵ<EFBFBD><CFB5><EFBFBD><EFBFBD>ز<EFBFBD>ֵ<EFBFBD><D6B5>ʽ
    static InterpolationMode GetDefaultInterpolationMode();

private:
    Size              size_;
    PixelSize         size_in_pixels_;
    InterpolationMode interpolation_mode_;

    static InterpolationMode default_interpolation_mode_;
};

/** @} */

inline float Texture::GetWidth() const
{
    return size_.x;
}

inline float Texture::GetHeight() const
{
    return size_.y;
}

inline Size Texture::GetSize() const
{
    return size_;
}

inline uint32_t Texture::GetWidthInPixels() const
{
    return size_in_pixels_.x;
}

inline uint32_t Texture::GetHeightInPixels() const
{
    return size_in_pixels_.y;
}

inline PixelSize Texture::GetSizeInPixels() const
{
    return size_in_pixels_;
}

inline InterpolationMode Texture::GetBitmapInterpolationMode() const
{
    return interpolation_mode_;
}

inline void Texture::SetSize(const Size& size)
{
    size_ = size;
}

inline void Texture::SetSizeInPixels(const PixelSize& size)
{
    size_in_pixels_ = size;
}

}  // namespace kiwano