XCEngine/engine/src/Rendering/CameraRenderer.cpp

#include "Rendering/CameraRenderer.h"

#include "Rendering/Passes/BuiltinDepthOnlyPass.h"
#include "Rendering/Passes/BuiltinObjectIdPass.h"
#include "Rendering/Passes/BuiltinShadowCasterPass.h"
#include "Rendering/Pipelines/BuiltinForwardPipeline.h"
#include "Rendering/RenderPipelineAsset.h"
#include "Rendering/RenderSurface.h"
#include "RHI/RHIDevice.h"
#include "RHI/RHIResourceView.h"
#include "RHI/RHITexture.h"
#include "Scene/Scene.h"

namespace XCEngine {
namespace Rendering {

namespace {

struct OwnedShadowSurfaceResources {
    RHI::RHITexture* depthTexture = nullptr;
    RHI::RHIResourceView* depthView = nullptr;
    RHI::RHIResourceView* shaderView = nullptr;
    RenderSurface surface = {};

    OwnedShadowSurfaceResources() = default;
    OwnedShadowSurfaceResources(const OwnedShadowSurfaceResources&) = delete;
    OwnedShadowSurfaceResources& operator=(const OwnedShadowSurfaceResources&) = delete;

    ~OwnedShadowSurfaceResources() {
        Reset();
    }

    void Reset() {
        if (shaderView != nullptr) {
            shaderView->Shutdown();
            delete shaderView;
            shaderView = nullptr;
        }

        if (depthView != nullptr) {
            depthView->Shutdown();
            delete depthView;
            depthView = nullptr;
        }

        if (depthTexture != nullptr) {
            depthTexture->Shutdown();
            delete depthTexture;
            depthTexture = nullptr;
        }

        surface = RenderSurface();
    }
};

bool InitializePassSequence(
    RenderPassSequence* sequence,
    const RenderContext& context,
    bool& initialized) {
    if (sequence == nullptr) {
        initialized = false;
        return true;
    }

    initialized = sequence->Initialize(context);
    if (!initialized) {
        sequence->Shutdown();
    }

    return initialized;
}

void ShutdownPassSequence(RenderPassSequence* sequence, bool initialized) {
    if (sequence != nullptr && initialized) {
        sequence->Shutdown();
    }
}

std::shared_ptr<const RenderPipelineAsset> CreateDefaultPipelineAsset() {
    static const std::shared_ptr<const RenderPipelineAsset> s_defaultPipelineAsset =
        std::make_shared<Pipelines::BuiltinForwardPipelineAsset>();
    return s_defaultPipelineAsset;
}

std::unique_ptr<RenderPass> CreateDefaultDepthOnlyPass() {
    return std::make_unique<Passes::BuiltinDepthOnlyPass>();
}

std::unique_ptr<RenderPass> CreateDefaultShadowCasterPass() {
    return std::make_unique<Passes::BuiltinShadowCasterPass>();
}

std::unique_ptr<RenderPipeline> CreatePipelineFromAsset(
    const std::shared_ptr<const RenderPipelineAsset>& pipelineAsset) {
    if (pipelineAsset != nullptr) {
        std::unique_ptr<RenderPipeline> pipeline = pipelineAsset->CreatePipeline();
        if (pipeline != nullptr) {
            return pipeline;
        }
    }

    return std::make_unique<Pipelines::BuiltinForwardPipeline>();
}

bool InitializeStandalonePass(
    RenderPass* pass,
    const RenderContext& context) {
    if (pass == nullptr) {
        return false;
    }

    if (pass->Initialize(context)) {
        return true;
    }

    pass->Shutdown();
    return false;
}

bool ExecuteScenePassRequest(
    RenderPass* pass,
    const ScenePassRenderRequest& request,
    const RenderContext& context,
    const RenderSceneData& baseSceneData) {
    if (!request.IsRequested()) {
        return true;
    }

    if (!InitializeStandalonePass(pass, context)) {
        return false;
    }

    RenderSceneData sceneData = baseSceneData;
    if (request.hasCameraDataOverride) {
        sceneData.cameraData = request.cameraDataOverride;
    }

    sceneData.cameraData.viewportWidth = request.surface.GetRenderAreaWidth();
    sceneData.cameraData.viewportHeight = request.surface.GetRenderAreaHeight();
    sceneData.cameraData.clearFlags = request.clearFlags;
    if (request.hasClearColorOverride) {
        sceneData.cameraData.clearColor = request.clearColorOverride;
    }

    const RenderPassContext passContext = {
        context,
        request.surface,
        sceneData
    };
    return pass->Execute(passContext);
}

bool CreateDirectionalShadowSurface(
    const RenderContext& context,
    const DirectionalShadowRenderPlan& plan,
    OwnedShadowSurfaceResources& outResources) {
    if (!context.IsValid() || !plan.IsValid()) {
        return false;
    }

    RHI::TextureDesc depthDesc = {};
    depthDesc.width = plan.mapWidth;
    depthDesc.height = plan.mapHeight;
    depthDesc.depth = 1;
    depthDesc.mipLevels = 1;
    depthDesc.arraySize = 1;
    depthDesc.format = static_cast<uint32_t>(RHI::Format::D24_UNorm_S8_UInt);
    depthDesc.textureType = static_cast<uint32_t>(RHI::TextureType::Texture2D);
    depthDesc.sampleCount = 1;
    depthDesc.sampleQuality = 0;
    depthDesc.flags = 0;

    RHI::RHITexture* depthTexture = context.device->CreateTexture(depthDesc);
    if (depthTexture == nullptr) {
        return false;
    }

    RHI::ResourceViewDesc depthViewDesc = {};
    depthViewDesc.format = static_cast<uint32_t>(RHI::Format::D24_UNorm_S8_UInt);
    depthViewDesc.dimension = RHI::ResourceViewDimension::Texture2D;
    depthViewDesc.mipLevel = 0;

    RHI::RHIResourceView* depthView =
        context.device->CreateDepthStencilView(depthTexture, depthViewDesc);
    if (depthView == nullptr) {
        depthTexture->Shutdown();
        delete depthTexture;
        return false;
    }

    RHI::ResourceViewDesc shaderViewDesc = {};
    shaderViewDesc.format = depthDesc.format;
    shaderViewDesc.dimension = RHI::ResourceViewDimension::Texture2D;
    shaderViewDesc.mipLevel = 0;
    RHI::RHIResourceView* shaderView =
        context.device->CreateShaderResourceView(depthTexture, shaderViewDesc);
    if (shaderView == nullptr) {
        depthView->Shutdown();
        delete depthView;
        depthTexture->Shutdown();
        delete depthTexture;
        return false;
    }

    outResources.Reset();
    outResources.depthTexture = depthTexture;
    outResources.depthView = depthView;
    outResources.shaderView = shaderView;
    outResources.surface = RenderSurface(plan.mapWidth, plan.mapHeight);
    outResources.surface.SetDepthAttachment(depthView);
    return true;
}

RenderDirectionalShadowData BuildDirectionalShadowData(
    const DirectionalShadowRenderPlan& plan,
    RHI::RHIResourceView* shadowMapView) {
    RenderDirectionalShadowData shadowData = {};
    if (!plan.IsValid() || shadowMapView == nullptr) {
        return shadowData;
    }

    shadowData.enabled = true;
    shadowData.viewProjection = plan.cameraData.viewProjection;
    shadowData.shadowMap = shadowMapView;
    shadowData.shadowParams = Math::Vector4(
        0.0015f,
        1.0f / static_cast<float>(plan.mapWidth),
        1.0f / static_cast<float>(plan.mapHeight),
        0.85f);
    return shadowData;
}

} // namespace

CameraRenderer::CameraRenderer()
    : CameraRenderer(CreateDefaultPipelineAsset()) {
}

CameraRenderer::CameraRenderer(std::unique_ptr<RenderPipeline> pipeline)
    : CameraRenderer(
        std::move(pipeline),
        std::make_unique<Passes::BuiltinObjectIdPass>(),
        CreateDefaultDepthOnlyPass(),
        CreateDefaultShadowCasterPass()) {
}

CameraRenderer::CameraRenderer(
    std::unique_ptr<RenderPipeline> pipeline,
    std::unique_ptr<ObjectIdPass> objectIdPass,
    std::unique_ptr<RenderPass> depthOnlyPass,
    std::unique_ptr<RenderPass> shadowCasterPass)
    : m_pipelineAsset(nullptr)
    , m_objectIdPass(std::move(objectIdPass))
    , m_depthOnlyPass(std::move(depthOnlyPass))
    , m_shadowCasterPass(std::move(shadowCasterPass)) {
    if (m_objectIdPass == nullptr) {
        m_objectIdPass = std::make_unique<Passes::BuiltinObjectIdPass>();
    }
    if (m_depthOnlyPass == nullptr) {
        m_depthOnlyPass = CreateDefaultDepthOnlyPass();
    }
    if (m_shadowCasterPass == nullptr) {
        m_shadowCasterPass = CreateDefaultShadowCasterPass();
    }
    ResetPipeline(std::move(pipeline));
}

CameraRenderer::CameraRenderer(std::shared_ptr<const RenderPipelineAsset> pipelineAsset)
    : m_pipelineAsset(std::move(pipelineAsset))
    , m_objectIdPass(std::make_unique<Passes::BuiltinObjectIdPass>())
    , m_depthOnlyPass(CreateDefaultDepthOnlyPass())
    , m_shadowCasterPass(CreateDefaultShadowCasterPass()) {
    SetPipelineAsset(m_pipelineAsset);
}

CameraRenderer::~CameraRenderer() {
    if (m_pipeline) {
        m_pipeline->Shutdown();
    }
    if (m_objectIdPass != nullptr) {
        m_objectIdPass->Shutdown();
    }
    if (m_depthOnlyPass != nullptr) {
        m_depthOnlyPass->Shutdown();
    }
    if (m_shadowCasterPass != nullptr) {
        m_shadowCasterPass->Shutdown();
    }
}

void CameraRenderer::SetPipeline(std::unique_ptr<RenderPipeline> pipeline) {
    m_pipelineAsset.reset();
    ResetPipeline(std::move(pipeline));
}

void CameraRenderer::SetPipelineAsset(std::shared_ptr<const RenderPipelineAsset> pipelineAsset) {
    m_pipelineAsset = pipelineAsset != nullptr ? std::move(pipelineAsset) : CreateDefaultPipelineAsset();
    ResetPipeline(CreatePipelineFromAsset(m_pipelineAsset));
}

void CameraRenderer::SetObjectIdPass(std::unique_ptr<ObjectIdPass> objectIdPass) {
    if (m_objectIdPass != nullptr) {
        m_objectIdPass->Shutdown();
    }

    m_objectIdPass = std::move(objectIdPass);
    if (m_objectIdPass == nullptr) {
        m_objectIdPass = std::make_unique<Passes::BuiltinObjectIdPass>();
    }
}

void CameraRenderer::SetDepthOnlyPass(std::unique_ptr<RenderPass> depthOnlyPass) {
    if (m_depthOnlyPass != nullptr) {
        m_depthOnlyPass->Shutdown();
    }

    m_depthOnlyPass = std::move(depthOnlyPass);
    if (m_depthOnlyPass == nullptr) {
        m_depthOnlyPass = CreateDefaultDepthOnlyPass();
    }
}

void CameraRenderer::SetShadowCasterPass(std::unique_ptr<RenderPass> shadowCasterPass) {
    if (m_shadowCasterPass != nullptr) {
        m_shadowCasterPass->Shutdown();
    }

    m_shadowCasterPass = std::move(shadowCasterPass);
    if (m_shadowCasterPass == nullptr) {
        m_shadowCasterPass = CreateDefaultShadowCasterPass();
    }
}

void CameraRenderer::ResetPipeline(std::unique_ptr<RenderPipeline> pipeline) {
    if (m_pipeline != nullptr) {
        m_pipeline->Shutdown();
    }

    m_pipeline = std::move(pipeline);
    if (m_pipeline == nullptr) {
        m_pipelineAsset = CreateDefaultPipelineAsset();
        m_pipeline = CreatePipelineFromAsset(m_pipelineAsset);
    }
}

bool CameraRenderer::Render(
    const CameraRenderRequest& request) {
    if (!request.IsValid() || m_pipeline == nullptr) {
        return false;
    }

    if (request.surface.GetRenderAreaWidth() == 0 ||
        request.surface.GetRenderAreaHeight() == 0) {
        return false;
    }
    if (request.depthOnly.IsRequested() &&
        !request.depthOnly.IsValid()) {
        return false;
    }
    if (request.objectId.IsRequested() &&
        !request.objectId.IsValid()) {
        return false;
    }

    ShadowCasterRenderRequest resolvedShadowCaster = request.shadowCaster;
    OwnedShadowSurfaceResources ownedShadowSurface;
    if (resolvedShadowCaster.IsRequested()) {
        if (!resolvedShadowCaster.IsValid()) {
            return false;
        }
    } else if (request.directionalShadow.IsValid()) {
        if (!CreateDirectionalShadowSurface(
                request.context,
                request.directionalShadow,
                ownedShadowSurface)) {
            return false;
        }

        resolvedShadowCaster.surface = ownedShadowSurface.surface;
        if (!resolvedShadowCaster.hasCameraDataOverride) {
            resolvedShadowCaster.hasCameraDataOverride = true;
            resolvedShadowCaster.cameraDataOverride = request.directionalShadow.cameraData;
        }
    }

    RenderSceneData sceneData = m_sceneExtractor.ExtractForCamera(
        *request.scene,
        *request.camera,
        request.surface.GetRenderAreaWidth(),
        request.surface.GetRenderAreaHeight());
    if (!sceneData.HasCamera()) {
        return false;
    }

    if (request.directionalShadow.IsValid()) {
        RHI::RHIResourceView* shadowMapView = ownedShadowSurface.shaderView;
        sceneData.lighting.mainDirectionalShadow =
            BuildDirectionalShadowData(request.directionalShadow, shadowMapView);
    }

    sceneData.cameraData.clearFlags = request.clearFlags;
    if (request.hasClearColorOverride) {
        sceneData.cameraData.clearColor = request.clearColorOverride;
    }
    const RenderPassContext passContext = {
        request.context,
        request.surface,
        sceneData
    };

    bool preScenePassesInitialized = false;
    if (!InitializePassSequence(
            request.preScenePasses,
            request.context,
            preScenePassesInitialized)) {
        return false;
    }
    if (request.preScenePasses != nullptr &&
        !request.preScenePasses->Execute(passContext)) {
        ShutdownPassSequence(request.preScenePasses, preScenePassesInitialized);
        return false;
    }

    if (!ExecuteScenePassRequest(
            m_shadowCasterPass.get(),
            resolvedShadowCaster,
            request.context,
            sceneData)) {
        ShutdownPassSequence(request.preScenePasses, preScenePassesInitialized);
        return false;
    }

    if (!ExecuteScenePassRequest(
            m_depthOnlyPass.get(),
            request.depthOnly,
            request.context,
            sceneData)) {
        ShutdownPassSequence(request.preScenePasses, preScenePassesInitialized);
        return false;
    }

    if (!m_pipeline->Render(request.context, request.surface, sceneData)) {
        ShutdownPassSequence(request.preScenePasses, preScenePassesInitialized);
        return false;
    }

    if (request.objectId.IsRequested() &&
        (m_objectIdPass == nullptr ||
         !m_objectIdPass->Render(request.context, request.objectId.surface, sceneData))) {
        ShutdownPassSequence(request.preScenePasses, preScenePassesInitialized);
        return false;
    }

    bool postScenePassesInitialized = false;
    if (!InitializePassSequence(
            request.postScenePasses,
            request.context,
            postScenePassesInitialized)) {
        ShutdownPassSequence(request.preScenePasses, preScenePassesInitialized);
        return false;
    }
    if (request.postScenePasses != nullptr &&
        !request.postScenePasses->Execute(passContext)) {
        ShutdownPassSequence(request.postScenePasses, postScenePassesInitialized);
        ShutdownPassSequence(request.preScenePasses, preScenePassesInitialized);
        return false;
    }

    bool overlayPassesInitialized = false;
    if (!InitializePassSequence(
            request.overlayPasses,
            request.context,
            overlayPassesInitialized)) {
        ShutdownPassSequence(request.postScenePasses, postScenePassesInitialized);
        ShutdownPassSequence(request.preScenePasses, preScenePassesInitialized);
        return false;
    }
    if (request.overlayPasses != nullptr &&
        !request.overlayPasses->Execute(passContext)) {
        ShutdownPassSequence(request.overlayPasses, overlayPassesInitialized);
        ShutdownPassSequence(request.postScenePasses, postScenePassesInitialized);
        ShutdownPassSequence(request.preScenePasses, preScenePassesInitialized);
        return false;
    }

    ShutdownPassSequence(request.overlayPasses, overlayPassesInitialized);
    ShutdownPassSequence(request.postScenePasses, postScenePassesInitialized);
    ShutdownPassSequence(request.preScenePasses, preScenePassesInitialized);

    return true;
}

} // namespace Rendering
} // namespace XCEngine