YiRenderer.h

Go to the documentation of this file.

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

#include "framework/YiPredef.h"
#include "renderer/YiRenderSystem.h"

#include <glm/fwd.hpp>

#include <functional>
#include <memory>
#include <vector>

class CYIAbstractCameraSceneNode;
class CYISceneNode;
class CYIMaterial;
class CYIMesh;
class IYIShaderProgram;
class IYIUniformBufferObject;

class IYIRenderer
{
public:
    struct Command
    {
    public:
        using CommandFunction = std::function<void()>;

        enum CommandType
        {
            NODE_DRAW = 1,
            NODE_PUSH_CLIPPING,        
            NODE_POP_CLIPPING,         
            NODE_PUSH_TARGET,          
            NODE_POP_TARGET,           
            NODE_PUSH_BLENDING,        
            NODE_POP_BLENDING,         
            NODE_PUSH_MASKING,         
            NODE_POP_MASKING,          
            NODE_PUSH_EFFECT_FBO,      
            NODE_POP_EFFECT_FBO,       
            NODE_APPLY_EFFECTS,        
            NODE_PUSH_TARGET_NO_CLEAR, 
            PUSH_CURRENT_CAMERA,       
            NODE_REPLACE_CAMERA,       
            NODE_APPLY_CAMERA,         
            POP_CAMERA,                
            CLEAR_TARGET,              
            RECALCULATE_CLIPPING,      
            CUSTOM_FUNCTION,           
        };

        union CommandData {
            CommandData(const CYISceneNode *pNode) :
                pNode(pNode) {}
            CommandData(const CYIAbstractCameraSceneNode *pCamera) :
                pCamera(pCamera) {}
            CommandData(const CommandFunction *pCallFunction) :
                pCallFunction(pCallFunction) {}

            const CYISceneNode *pNode;
            const CYIAbstractCameraSceneNode *pCamera;
            const CommandFunction *pCallFunction;
        };

        CommandType m_type;
        CommandData m_data;
    };

    IYIRenderer() {}

    virtual ~IYIRenderer() {}

    virtual void SetScreenFrameBufferBinding(int32_t nFBO_ID = 0) = 0;

    virtual void SetFrontFaceWinding(CYIRenderSystem::YI_WINDING eWinding) = 0;

    virtual void SetDepthTest(CYIRenderSystem::YI_DEPTH_TEST eTest) = 0;

    virtual void SetBlendMode(CYIRenderSystem::YI_BLEND_MODE mode) = 0;

    virtual void SetBlendColor(float fRed, float fGreen, float fBlue, float fAlpha) = 0;

    virtual void RenderNodes(const std::vector<Command> &renderList) = 0;

    virtual const std::shared_ptr<IYIShaderProgram> &GetActiveShader() const = 0;

    virtual void Draw(const std::shared_ptr<CYIMesh> &pMesh,
                      const std::shared_ptr<CYIMaterial> &pMat,
                      const std::shared_ptr<IYIUniformBufferObject> &pNodeProperties,
                      const glm::mat4 *pModelMatrixOverride) = 0;

    virtual void PushScreenClipping(const YI_RECT_REL &clipBox) = 0;

    virtual void PushScreenClippingDisabled() = 0;

    virtual void PopScreenClipping() = 0;
};

#endif // _YI_RENDERER_H_