Magic_Game/src/kiwano/render/Renderer.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/base/Module.h>
#include <kiwano/render/Font.h>
#include <kiwano/render/GifImage.h>
#include <kiwano/render/TextStyle.h>
#include <kiwano/render/RenderContext.h>
#include <kiwano/platform/Window.h>

namespace kiwano
{

/**
 * \~chinese
 * \defgroup Render <EFBFBD><EFBFBD>Ⱦģ<EFBFBD><EFBFBD>
 */

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


/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD>Ⱦ<EFBFBD><EFBFBD>
 */
class KGE_API Renderer : public Module
{
public:
    /// \~chinese
    /// @brief <20><>ȡʵ<C8A1><CAB5>
    static Renderer& GetInstance();

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ɫ
    virtual Color GetClearColor() const;

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

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1>Ⱦ<EFBFBD><C8BE><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    RenderContext& GetContext();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ⱦ<EFBFBD><C8BE><EFBFBD><EFBFBD><EFBFBD><EFBFBD>С
    virtual void Resize(uint32_t width, uint32_t height) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ɫ
    void SetClearColor(const Color& clear_color);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>رմ<D8B1>ֱͬ<D6B1><CDAC>
    void SetVSyncEnabled(bool enabled);

    /// \~chinese
    /// @brief <20><><EFBFBD>ڴ<EFBFBD>С<EFBFBD>仯ʱ<E4BBAF>Զ<EFBFBD><D4B6><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ֱ<EFBFBD><D6B1><EFBFBD>
    void ResetResolutionWhenWindowResized(bool enabled);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] texture <20><><EFBFBD><EFBFBD>
    /// @param[in] file_path ͼƬ·<C6AC><C2B7>
    virtual void CreateTexture(Texture& texture, const String& file_path) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] texture <20><><EFBFBD><EFBFBD>
    /// @param[in] resource ͼƬ<CDBC><C6AC>Դ
    virtual void CreateTexture(Texture& texture, const Resource& resource) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>GIFͼ<46><CDBC><EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] gif GIFͼ<46><CDBC>
    /// @param[in] file_path ͼƬ·<C6AC><C2B7>
    virtual void CreateGifImage(GifImage& gif, const String& file_path) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>GIFͼ<46><CDBC><EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] gif GIFͼ<46><CDBC>
    /// @param[in] resource ͼƬ<CDBC><C6AC>Դ
    virtual void CreateGifImage(GifImage& gif, const Resource& resource) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>GIFͼ<46><CDBC>֡<EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] frame GIFͼ<46><CDBC>֡
    /// @param[in] gif GIFͼ<46><CDBC>
    /// @param[in] frame_index ֡<>±<EFBFBD>
    virtual void CreateGifImageFrame(GifImage::Frame& frame, const GifImage& gif, size_t frame_index) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>弯<EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] font <20><><EFBFBD><EFBFBD>
    /// @param[out] family_names <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param[in] file_paths <20><><EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD>·<EFBFBD><C2B7>
    virtual void CreateFontCollection(Font& font, Vector<String>& family_names, const String& file_path) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>弯<EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] font <20><><EFBFBD><EFBFBD>
    /// @param[out] family_names <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param[in] res_arr <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Դ
    virtual void CreateFontCollection(Font& font, Vector<String>& family_names, const Resource& res) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ֲ<EFBFBD><D6B2><EFBFBD><EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] layout <20><><EFBFBD>岼<EFBFBD><E5B2BC>
    /// @param text <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param style <20>ı<EFBFBD><C4B1><EFBFBD>ʽ
    virtual void CreateTextLayout(TextLayout& layout, const String& content, const TextStyle& style) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>߶<EFBFBD><DFB6><EFBFBD>״<EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] shape <20><>״
    /// @param[in] begin_pos <20>߶<EFBFBD><DFB6><EFBFBD><EFBFBD><EFBFBD>
    /// @param[in] end_pos <20>߶<EFBFBD><DFB6>յ<EFBFBD>
    virtual void CreateLineShape(Shape& shape, const Point& begin_pos, const Point& end_pos) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>״<EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] shape <20><>״
    /// @param[in] rect <20><><EFBFBD>δ<EFBFBD>С
    virtual void CreateRectShape(Shape& shape, const Rect& rect) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>Բ<EFBFBD>Ǿ<EFBFBD><C7BE><EFBFBD><EFBFBD><EFBFBD>״<EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] shape <20><>״
    /// @param[in] rect <20><><EFBFBD>δ<EFBFBD>С
    /// @param[in] radius Բ<>ǰ뾶
    virtual void CreateRoundedRectShape(Shape& shape, const Rect& rect, const Vec2& radius) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Բ<EFBFBD><D4B2>״<EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] shape <20><>״
    /// @param[in] center <20><>ԲԲ<D4B2><D4B2>
    /// @param[in] radius <20><>Բ<EFBFBD>뾶
    virtual void CreateEllipseShape(Shape& shape, const Point& center, const Vec2& radius) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ͼ<EFBFBD><CDBC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] maker <20><>״<EFBFBD><D7B4><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    virtual void CreateShapeSink(ShapeMaker& maker) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ɫ<EFBFBD><C9AB>ˢ<EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] brush <20><>ˢ
    /// @param[in] color <20><>ɫ
    virtual void CreateBrush(Brush& brush, const Color& color) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Խ<EFBFBD><D4BD>仭ˢ<E4BBAD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] brush <20><>ˢ
    /// @param[in] style <20><><EFBFBD>Խ<EFBFBD><D4BD><EFBFBD><EFBFBD><EFBFBD>ʽ
    virtual void CreateBrush(Brush& brush, const LinearGradientStyle& style) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>򽥱仭ˢ<E4BBAD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] brush <20><>ˢ
    /// @param[in] style <20><><EFBFBD>򽥱<EFBFBD><F2BDA5B1><EFBFBD>ʽ
    virtual void CreateBrush(Brush& brush, const RadialGradientStyle& style) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ˢ<EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] brush <20><>ˢ
    /// @param[in] texture <20><><EFBFBD><EFBFBD>
    virtual void CreateBrush(Brush& brush, TexturePtr texture) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ<EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>Դ
    /// @param[out] stroke_style <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @param[in] cap <20>߶ζ˵<CEB6><CBB5><EFBFBD>ʽ
    /// @param[in] line_join <20>߶<EFBFBD><DFB6>ཻ<EFBFBD><E0BDBB>ʽ
    /// @param[in] dash_array <20><><EFBFBD>߳<EFBFBD><DFB3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>϶<EFBFBD><CFB6><EFBFBD><EFBFBD>
    /// @param[in] dash_size <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>С
    /// @param[in] dash_offset <20><><EFBFBD><EFBFBD>ƫ<EFBFBD><C6AB><EFBFBD><EFBFBD>
    virtual void CreateStrokeStyle(StrokeStyle& stroke_style) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ⱦ<EFBFBD><C8BE><EFBFBD><EFBFBD><EFBFBD>ģ<EFBFBD><C4A3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ĵ<EFBFBD><C4B5><EFBFBD>Ⱦ<EFBFBD><C8BE><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param[in,out] texture <20><>Ⱦ<EFBFBD><C8BE><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param[in] desired_size <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>С
    /// @return <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ⱦ<EFBFBD><C8BE><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    virtual RenderContextPtr CreateTextureRenderContext(Texture& texture, const Size* desired_size = nullptr) = 0;

public:
    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    virtual void Clear() = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ݳ<EFBFBD><DDB3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @throw kiwano::SystemError <20><><EFBFBD><EFBFBD>ʧ<EFBFBD><CAA7>ʱ<EFBFBD>׳<EFBFBD>
    virtual void Present() = 0;

    /// \~chinese
    /// @brief Ϊ<><CEAA><EFBFBD>ڴ<EFBFBD><DAB4><EFBFBD><EFBFBD><EFBFBD>Ⱦ<EFBFBD><C8BE><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @throw kiwano::SystemError <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʧ<EFBFBD><CAA7>ʱ<EFBFBD>׳<EFBFBD>
    virtual void MakeContextForWindow(WindowPtr window) = 0;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ⱦ<EFBFBD><C8BE><EFBFBD><EFBFBD>Դ
    virtual void Destroy();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD>
    void HandleEvent(EventModuleContext& ctx) override;

protected:
    Renderer();

protected:
    bool             vsync_;
    bool             auto_reset_resolution_;
    Color            clear_color_;
    Size             output_size_;
    RenderContextPtr render_ctx_;
};

/** @} */

inline RenderContext& Renderer::GetContext()
{
    return *render_ctx_;
}

inline Size Renderer::GetOutputSize() const
{
    return output_size_;
}

inline Color Renderer::GetClearColor() const
{
    return clear_color_;
}

}  // namespace kiwano