Renderer.h

Go to the documentation of this file.

#pragma once
 
#include <vector>
#include "glm/glm.hpp"
#include <array>
 
#include "EngineTypes.h"
#include "Assets/Texture.h"
#include "Assets/StaticMesh.h"
#include "Assets/MaterialLite.h"
#include "Vertex.h"
#include "World.h"
#include "Constants.h"
#include "Log.h"
#include "Profiler.h"
 
class Widget;
class Console;
class StatsOverlay;
class CameraFrustum;
 
struct EngineState;
 
struct LightDistance2
{
    Light3D* mComponent = nullptr;
    float mDistance2 = 0.0f;
 
    LightDistance2(Light3D* comp, float dist2) : mComponent(comp), mDistance2(dist2) {}
};
 
// Per-method POLYPHASE_API on Get() only. A class-level export forces MSVC to
// emit Renderer's implicit ctor/dtor bodies in every TU that includes this
// header, which in turn instantiates ~SharedPtr<Console> / ~SharedPtr<StatsOverlay>
// against the forward declarations above → C4150 ("deletion of pointer to
// incomplete type"). Addons only need the singleton accessor anyway.
class Renderer
{
public:
 
    static void Create();
    static void Destroy();
    POLYPHASE_API static Renderer* Get();
 
    void Render(World* world, int32_t screenIndex);
#if EDITOR
    void RenderSecondScreen(World* world, class Image* colorTarget, class Image* depthTarget,
                            uint32_t width, uint32_t height, class Camera3D* cameraOverride = nullptr,
                            int32_t targetScreen = -1,
                            bool drawAccumulatedDebugDraws = true);
#endif
    ~Renderer();
    void Initialize();
 
    void GatherProperties(std::vector<Property>& props);
 
    void EnableStatsOverlay(bool enable);
    bool IsStatsOverlayEnabled() const;
    void EnableConsole(bool enable);
    bool IsConsoleEnabled();
 
    void DirtyAllWidgets();
 
    Console* GetConsoleWidget();
    StatsOverlay* GetStatsWidget();
 
    void SetEngineState(EngineState* engineState);
    uint32_t GetFrameNumber() const;
    uint32_t GetFrameIndex() const;
    uint32_t GetScreenIndex() const;
    bool IsRenderingFirstScreen() const;
    bool IsRenderingLastScreen() const;
    World* GetCurrentWorld();
 
    glm::vec2 GetScreenResolution(int32_t screen = -1);
    glm::vec2 GetActiveScreenResolution();
 
    float GetGlobalUiScale() const;
    void SetGlobalUiScale(float scale);
 
    Node3D* ProcessHitCheck(World* world, int32_t x, int32_t y, uint32_t* outInstance = nullptr);
 
    void SetDebugMode(DebugMode mode);
    DebugMode GetDebugMode() const;
    void EnableProxyRendering(bool enable);
    bool IsProxyRenderingEnabled() const;
    void SetBoundsDebugMode(BoundsDebugMode mode);
    BoundsDebugMode GetBoundsDebugMode() const;
 
    void EnableFrustumCulling(bool enable);
    bool IsFrustumCullingEnabled() const;
 
    // Fills a CameraFrustum from the camera's current matrices. Used by the
    // cull pass and by World::IsSeenByCamera.
    static void BuildCameraFrustum(Camera3D* camera, CameraFrustum& outFrustum);
 
    // Baked occlusion culling (see OcclusionData). Applies to game cameras;
    // the editor camera only culls when the preview toggle is on.
    void EnableOcclusionCulling(bool enable);
    bool IsOcclusionCullingEnabled() const;
    void EnableOcclusionPreview(bool enable);
    bool IsOcclusionPreviewEnabled() const;
    int32_t GetNumFrustumCulled() const;
    int32_t GetNumOcclusionCulled() const;
 
    void Enable3dRendering(bool enable);
    bool Is3dRenderingEnabled() const;
    void Enable2dRendering(bool enable);
    bool Is2dRenderingEnabled() const;
 
    void EnablePathTracing(bool enable);
    bool IsPathTracingEnabled() const;
 
    Texture* GetBlackTexture();
    MaterialLite* GetDefaultMaterial();
 
    void LoadDefaultTextures();
    void LoadDefaultMaterials();
    void LoadDefaultMeshes();
    void LoadDefaultFonts();
 
    void AddDebugDraw(const DebugDraw& draw);
    void RemoveDebugDrawsForNode(Node* node);
    const std::vector<DebugDraw>& GetDebugDraws() const;
 
    // ===== Custom Render Pass (for native addons) =====
    //
    // Lets an addon submit GFX_* draw calls during the engine's main forward
    // pass — i.e. inside an active BeginRenderPass/EndRenderPass and after the
    // camera's view/projection have been bound. Without this hook addons can
    // only submit Gizmos:: draws, which are #if EDITOR only.
    //
    // The callback is invoked after opaque + translucent + debug draws and
    // immediately before the engine draws the world's debug-line buffer, so
    // alpha-blended geometry composites correctly against the rendered scene.
    // Invoked once per frame per world Render() call. Order across multiple
    // registered passes is registration order.
    //
    // Hot-reload safe: addons should Unregister in their OnUnload.
    typedef void (*CustomRenderPassFn)(void* userData);
    POLYPHASE_API uint64_t RegisterCustomRenderPass(CustomRenderPassFn fn, void* userData);
    POLYPHASE_API void     UnregisterCustomRenderPass(uint64_t id);
 
    // Engine-internal: run all registered callbacks. Called from Renderer::Render.
    void RunCustomRenderPasses();
 
    const std::vector<LightData>& GetLightData() const;
 
    void SetClearColor(const glm::vec4& color);
    glm::vec4 GetClearColor() const;
 
    void BeginLightBake();
    void EndLightBake();
    bool IsLightBakeInProgress() const;
    float GetLightBakeProgress() const;
 
    bool IsLightFadeEnabled() const;
    void EnableLightFade(bool enable);
    void SetLightFadeLimit(uint32_t limit);
    uint32_t GetLightFadeLimit() const;
    void SetLightFadeSpeed(float speed);
    float GetLightFadeSpeed() const;
 
    void SetColorScale(float colorScale);
    float GetColorScale() const;
    float GetColorScaleInverse() const;
 
    void SetSelectedColor(const glm::vec4& color);
    glm::vec4 GetSelectedColor() const;
    void SetSelectedCheckerSize(float size);
    float GetSelectedCheckerSize() const;
 
    bool IsPostProcessPassEnabled(PostProcessPassId passId) const;
    void EnablePostProcessPass(PostProcessPassId passId, bool enable);
 
    void SetResolutionScale(float scale);
    float GetResolutionScale() const;
 
    uint32_t GetViewportX(int32_t screenIdx = -1);
    uint32_t GetViewportY(int32_t screenIdx = -1);
    uint32_t GetViewportWidth(int32_t screenIdx = -1);
    uint32_t GetViewportHeight(int32_t screenIdx = -1);
    glm::uvec4 GetViewport(int32_t screenIdx = -1);
    glm::uvec4 GetSceneViewport(int32_t screenIdx = -1);
 
    // Property Getters
    uint32_t GetRaysPerPixel() const;
    uint32_t GetMaxBounces() const;
    bool IsPathTraceAccumulationEnabled() const;
    uint32_t GetBakeRaysPerVertex() const;
    uint32_t GetBakeMaxBounces() const;
    float GetBakeShadowBias() const;
    uint32_t GetBakeIndirectIterations() const;
    uint32_t GetBakeDiffuseDirectPasses() const;
    uint32_t GetBakeDiffuseIndirectPasses() const;
    glm::vec4 GetSkyZenithColor() const;
    glm::vec4 GetSkyHorizonColor() const;
    glm::vec4 GetGroundColor() const;
 
    // Default Textures
    TextureRef mWhiteTexture;
    TextureRef mBlackTexture;
    TextureRef mDefaultColorTexture;
    TextureRef mDefaultColorAlphaTexture;
    TextureRef mDefaultNormalTexture;
    TextureRef mDefaultORMTexture;
 
    // Environment / IBL
    TextureRef mEnvironmentMap;
 
    // Default Materials
    MaterialRef mDefaultMaterial;
 
    // Default Meshes
    StaticMeshRef mConeMesh;
    StaticMeshRef mCubeMesh;
    StaticMeshRef mCylinderMesh;
    StaticMeshRef mPlaneMesh;
    StaticMeshRef mSphereMesh;
    StaticMeshRef mSphere112Mesh;
    StaticMeshRef mTorusMesh;
 
    // Default Fonts
    FontRef mRoboto32;
    FontRef mRoboto16;
    FontRef mRobotoMono16;
    FontRef mRobotoMono8;
 
private:
 
    static Renderer* sInstance;
    Renderer();
 
    void BeginFrame();
    void EndFrame();
 
    void GatherDrawData(World* world);
    void GatherLightData(World* world);
    bool PassesTargetScreenFilter(Node* node, World* world) const;
    void RenderDraws(const std::vector<DrawData>& drawData);
    void RenderDraws(const std::vector<DrawData>& drawData, PipelineConfig pipelineConfig);
    void RenderDebugDraws(const std::vector<DebugDraw>& draws, PipelineConfig pipelineConfig = PipelineConfig::Count);
    void FrustumCull(Camera3D* camera);
    void OcclusionCull(World* world, Camera3D* camera);
    int32_t OcclusionCullDraws(const class OcclusionData& data, int32_t cell, const uint32_t* visibleSet, std::vector<DrawData>& drawData);
    bool IsDrawOcclusionVisible(const class OcclusionData& data, int32_t cell, const uint32_t* visibleSet, const DrawData& draw) const;
    void DrawOcclusionDebug(World* world, const class OcclusionData* data, int32_t cell, const uint32_t* visibleSet);
    int32_t FrustumCullDraws(const CameraFrustum& frustum, std::vector<DrawData>& drawData);
    int32_t FrustumCullDraws(const CameraFrustum& frustum, std::vector<DebugDraw>& drawData);
    int32_t FrustumCullLights(const CameraFrustum& frustum, std::vector<LightData>& lightData);
 
    void RenderShadowCasters(World* world);
    void RenderSelectedGeometry(World* world);
 
    void UpdateDebugDraws();
 
    SharedPtr<StatsOverlay> mStatsWidget;
    SharedPtr<Console> mConsoleWidget;
 
    EngineState* mEngineState = nullptr;
 
    bool mInitialized = false;
 
    std::vector<DrawData> mShadowDraws;
    std::vector<DrawData> mOpaqueDraws;
    std::vector<DrawData> mSimpleShadowDraws;
    std::vector<DrawData> mPostShadowOpaqueDraws; // (post-simple-shadow opaques. not talking about shadow mapping)
    std::vector<DrawData> mTranslucentDraws;
    std::vector<DrawData> mWireframeDraws;
    std::vector<DrawData> mWidgetDraws;
 
    std::vector<LightData> mLightData;
 
    std::vector<DebugDraw> mDebugDraws;
    std::vector<DebugDraw> mCollisionDraws;
 
    // Custom render passes registered by native addons. See RegisterCustomRenderPass.
    struct CustomRenderPassEntry
    {
        uint64_t           mId;
        CustomRenderPassFn mFn;
        void*              mUserData;
    };
    std::vector<CustomRenderPassEntry> mCustomRenderPasses;
    uint64_t                           mNextCustomRenderPassId = 1;
 
    World* mCurrentWorld = nullptr;
    uint32_t mFrameIndex = 0;
    uint32_t mScreenIndex = 0;
    int32_t mTargetScreenFilter = -1;  // -1 = no filter, 0 = top screen, 1 = bottom screen
    uint32_t mFrameNumber = 0;
    float mGlobalUiScale = 1.0f;
    DebugMode mDebugMode = DEBUG_NONE;
    BoundsDebugMode mBoundsDebugMode = BoundsDebugMode::Off;
    bool mFrustumCulling = true;
    bool mOcclusionCulling = true;
    bool mOcclusionPreview = false;
    int32_t mNumFrustumCulled = 0;
    int32_t mNumOcclusionCulled = 0;
    bool mEnableProxyRendering = false;
    bool mEnable3dRendering = true;
    bool mEnable2dRendering = true;
    bool mEnablePathTracing = false;
    bool mEnableLightFade = false;
    uint32_t mLightFadeLimit = 4;
    float mLightFadeSpeed = 1.0f;
    glm::vec4 mClearColor = {};
    float mColorScale = 1.0f;
    glm::vec4 mSelectedColor = { 0.2f, 0.1f, 1.0f, 0.6f };
    float mSelectedCheckerSize = 8.0f;
 
    // Path tracing
    uint32_t mRaysPerPixel = 4;
    uint32_t mMaxBounces = 4;
    bool mPathTraceAccumulate = true;
    glm::vec4 mSkyZenithColor = { 0.0f, 0.0f, 0.0f, 1.0f };
    glm::vec4 mSkyHorizonColor = { 0.0f, 0.0f, 0.0f, 1.0f };
    glm::vec4 mGroundColor = { 0.0f, 0.0f, 0.0f, 1.0f };
 
    // Light Bake
    uint32_t mBakeRaysPerVertex = 4;
    uint32_t mBakeMaxBounces = 4;
    float mBakeShadowBias = 0.001f;
    uint32_t mBakeIndirectIterations = 20;
    uint32_t mBakeDiffuseDirectPasses = 2;
    uint32_t mBakeDiffuseIndirectPasses = 2;
 
    // Post Process
    bool mPostProcessEnables[(uint32_t)PostProcessPassId::Count] = { };
 
};