YiRenderTarget.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_RENDER_TARGET_H_
#define _YI_RENDER_TARGET_H_

#include "asset/YiAssetFramebuffer.h"
#include "renderer/YiViewport.h"
#include "utility/YiColor.h"

#include <glm/fwd.hpp>

class CYIOffscreenRenderTarget;
class CYIScreenRenderTarget;

class CYIRenderTarget
{
public:

    enum RENDER_TARGET_ATTRIBUTE
    {
        CLEAR_COLOR_BUFFER = 1,
        CLEAR_DEPTH_BUFFER = 2,
        CLEAR = CLEAR_COLOR_BUFFER | CLEAR_DEPTH_BUFFER // The rest should go 4, 8, 16, etc...
    };

    enum RENDER_TARGET_TYPE
    {
        SCREEN = 1,                 
        OFFSCREEN_COLOR_ONLY,       
        OFFSCREEN_DEPTH_ONLY,       
        OFFSCREEN_COLOR_AND_DEPTH   
    };

    static std::unique_ptr<CYIScreenRenderTarget> CreateScreenTarget(const CYIViewport &viewport);

    static std::unique_ptr<CYIOffscreenRenderTarget> CreateOffscreenTarget(RENDER_TARGET_TYPE eTargetType, uint32_t uTargetWidth, uint32_t uTargetHeight);

    virtual ~CYIRenderTarget();

    void SetViewport(const CYIViewport &viewport);

    const CYIViewport &GetViewport() const;

    std::shared_ptr<IYIGPUObject> GetFramebuffer() const;

    std::shared_ptr<CYIAssetFramebuffer> GetFramebufferAsset() const;

    RENDER_TARGET_TYPE GetTargetType() const;

    void SetDeviceHorizontalPixelRatio(float fDevicePixelRatio);

    void SetDeviceVerticalPixelRatio(float fDevicePixelRatio);

    void SetDeviceDiagonalPixelRatio(float fDevicePixelRatio);

    float GetDeviceHorizontalPixelRatio() const;

    float GetDeviceVerticalPixelRatio() const;

    float GetDeviceDiagonalPixelRatio() const;

    void SetClearColor(const CYIColor &clearColor);

    const CYIColor &GetClearColor() const;

    void SetAttribute(RENDER_TARGET_ATTRIBUTE eAttribute, bool bValue);
    bool GetAttribute(RENDER_TARGET_ATTRIBUTE eAttribute) const;

protected:
    CYIRenderTarget();

    std::shared_ptr<CYIAssetFramebuffer> m_pFramebuffer;

private:
    float m_fDeviceHorizontalPixelRatio;
    float m_fDeviceVerticalPixelRatio;
    float m_fDeviceDiagonalPixelRatio;

    CYIViewport           m_Viewport;
    CYIColor              m_ClearColor;

    RENDER_TARGET_TYPE    m_Type;

    uint32_t m_AttributeFlags;

    YI_TYPE_BASES(CYIRenderTarget)
};

#endif // _YI_RENDER_TARGET_H_