sid/NazaraEngine
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Renderer: Refactor transient resources (allow access at any time)

Browse Source
This commit is contained in:
SirLynix
2023-07-21 08:51:39 +02:00
committed by Jérôme Leclercq
parent de68033a0e
commit 4db5b59ec9
21 changed files with 265 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/Nazara/Renderer/RenderDevice.hpp
View File

@@ -22,7 +22,7 @@
#include <Nazara/Renderer/Texture.hpp>
#include <Nazara/Renderer/TextureSampler.hpp>
#include <Nazara/Utility/PixelFormat.hpp>
#include <Nazara/Utils/FunctionRef.hpp>
#include <NazaraUtils/FunctionRef.hpp>
#include <NZSL/ShaderWriter.hpp>
#include <NZSL/Ast/Module.hpp>
#include <memory>
@@ -40,8 +40,6 @@ namespace Nz
RenderDevice() = default;
virtual ~RenderDevice();
virtual void Execute(const FunctionRef<void(CommandBufferBuilder& builder)>& callback, QueueType queueType) = 0;
virtual const RenderDeviceInfo& GetDeviceInfo() const = 0;
virtual const RenderDeviceFeatures& GetEnabledFeatures() const = 0;

41
include/Nazara/Renderer/RenderFrame.inl
View File

@@ -19,6 +19,14 @@ namespace Nz
{
}
inline void RenderFrame::Execute(const FunctionRef<void(CommandBufferBuilder& builder)>& callback, QueueTypeFlags queueTypeFlags)
{
if NAZARA_UNLIKELY(!m_image)
throw std::runtime_error("frame is either invalid or has already been presented");
return m_image->Execute(callback, queueTypeFlags);
}
inline std::size_t RenderFrame::GetFramebufferIndex() const
{
return m_framebufferIndex;
@@ -29,6 +37,14 @@ namespace Nz
return m_size;
}
inline UploadPool& RenderFrame::GetUploadPool()
{
if NAZARA_UNLIKELY(!m_image)
throw std::runtime_error("frame is either invalid or has already been presented");
return m_image->GetUploadPool();
}
inline bool RenderFrame::IsFramebufferInvalidated() const
{
return m_framebufferInvalidation;
@@ -37,18 +53,39 @@ namespace Nz
template<typename T>
void RenderFrame::PushForRelease(T&& value)
{
return PushReleaseCallback([v = std::forward<T>(value)] {});
if NAZARA_UNLIKELY(!m_image)
throw std::runtime_error("frame is either invalid or has already been presented");
m_image->PushForRelease(std::forward<T>(value));
}
template<typename F>
void RenderFrame::PushReleaseCallback(F&& releaseCallback)
{
if (!m_image)
if NAZARA_UNLIKELY(!m_image)
throw std::runtime_error("frame is either invalid or has already been presented");
m_image->PushReleaseCallback(std::forward<F>(releaseCallback));
}
inline void RenderFrame::Present()
{
if NAZARA_UNLIKELY(!m_image)
throw std::runtime_error("frame is either invalid or has already been presented");
m_image->Present();
m_image = nullptr;
}
inline void RenderFrame::SubmitCommandBuffer(CommandBuffer* commandBuffer, QueueTypeFlags queueTypeFlags)
{
if NAZARA_UNLIKELY(!m_image)
throw std::runtime_error("frame is either invalid or has already been presented");
m_image->SubmitCommandBuffer(commandBuffer, queueTypeFlags);
}
inline RenderFrame::operator bool()
{
return m_image != nullptr;

66
include/Nazara/Renderer/RenderImage.hpp
View File

@@ -8,76 +8,14 @@
#define NAZARA_RENDERER_RENDERIMAGE_HPP
#include <NazaraUtils/Prerequisites.hpp>
#include <Nazara/Renderer/Config.hpp>
#include <Nazara/Renderer/Enums.hpp>
#include <NazaraUtils/FunctionRef.hpp>
#include <functional>
#include <vector>
#include <Nazara/Renderer/TransientResources.hpp>
namespace Nz
{
class CommandBuffer;
class CommandBufferBuilder;
class UploadPool;
class NAZARA_RENDERER_API RenderImage
class NAZARA_RENDERER_API RenderImage : public TransientResources
{
public:
class Releasable;
template<typename T> class ReleasableLambda;
virtual ~RenderImage();
virtual void Execute(const FunctionRef<void(CommandBufferBuilder& builder)>& callback, QueueTypeFlags queueTypeFlags) = 0;
inline void FlushReleaseQueue();
virtual UploadPool& GetUploadPool() = 0;
virtual void Present() = 0;
template<typename F> void PushReleaseCallback(F&& callback);
virtual void SubmitCommandBuffer(CommandBuffer* commandBuffer, QueueTypeFlags queueTypeFlags) = 0;
protected:
RenderImage() = default;
RenderImage(const RenderImage&) = delete;
RenderImage(RenderImage&&) = delete;
private:
static constexpr std::size_t BlockSize = 4 * 1024 * 1024;
using Block = std::vector<UInt8>;
std::vector<Releasable*> m_releaseQueue;
std::vector<Block> m_releaseMemoryPool;
};
class NAZARA_RENDERER_API RenderImage::Releasable
{
public:
virtual ~Releasable();
virtual void Release() = 0;
};
template<typename T>
class RenderImage::ReleasableLambda : public Releasable
{
public:
template<typename U> ReleasableLambda(U&& lambda);
ReleasableLambda(const ReleasableLambda&) = delete;
ReleasableLambda(ReleasableLambda&&) = delete;
~ReleasableLambda() = default;
void Release() override;
ReleasableLambda& operator=(const ReleasableLambda&) = delete;
ReleasableLambda& operator=(ReleasableLambda&&) = delete;
private:
T m_lambda;
};
}

81
include/Nazara/Renderer/RenderImage.inl
View File

@@ -2,91 +2,10 @@
// This file is part of the "Nazara Engine - Renderer module"
// For conditions of distribution and use, see copyright notice in Config.hpp
#include <Nazara/Core/Algorithm.hpp>
#include <NazaraUtils/MemoryHelper.hpp>
#include <Nazara/Renderer/Debug.hpp>
namespace Nz
{
inline void RenderImage::FlushReleaseQueue()
{
for (Releasable* releasable : m_releaseQueue)
{
releasable->Release();
PlacementDestroy(releasable);
}
m_releaseQueue.clear();
for (auto& memoryblock : m_releaseMemoryPool)
memoryblock.clear();
}
template<typename F>
void RenderImage::PushReleaseCallback(F&& callback)
{
using Functor = ReleasableLambda<std::remove_cv_t<std::remove_reference_t<F>>>;
constexpr std::size_t functorSize = sizeof(Functor);
constexpr std::size_t functorAlignment = alignof(Functor);
// Try to minimize lost space
struct
{
Block* block = nullptr;
UInt64 alignedOffset = 0;
UInt64 lostSpace = 0;
} bestBlock;
for (Block& block : m_releaseMemoryPool)
{
std::size_t freeOffset = block.size();
UInt64 alignedOffset = Align(freeOffset, functorAlignment);
if (alignedOffset + functorSize > block.capacity())
continue; //< Not enough space
UInt64 lostSpace = alignedOffset - freeOffset;
if (!bestBlock.block || lostSpace < bestBlock.lostSpace)
{
bestBlock.block = &block;
bestBlock.alignedOffset = alignedOffset;
bestBlock.lostSpace = lostSpace;
}
}
// No block found, allocate a new one
if (!bestBlock.block)
{
Block newBlock;
newBlock.reserve(BlockSize);
bestBlock.block = &m_releaseMemoryPool.emplace_back(std::move(newBlock));
bestBlock.alignedOffset = 0;
bestBlock.lostSpace = 0;
}
Block& targetBlock = *bestBlock.block;
targetBlock.resize(bestBlock.alignedOffset + functorSize);
Functor* releasable = reinterpret_cast<Functor*>(&targetBlock[bestBlock.alignedOffset]);
PlacementNew(releasable, std::forward<F>(callback));
m_releaseQueue.push_back(releasable);
}
template<typename T>
template<typename U>
RenderImage::ReleasableLambda<T>::ReleasableLambda(U&& lambda) :
m_lambda(std::forward<U>(lambda))
{
}
template<typename T>
void RenderImage::ReleasableLambda<T>::Release()
{
m_lambda();
}
}
#include <Nazara/Renderer/DebugOff.hpp>

3
include/Nazara/Renderer/Swapchain.hpp
View File

@@ -20,6 +20,7 @@ namespace Nz
{
class CommandPool;
class RenderDevice;
class TransientResources;
class NAZARA_RENDERER_API Swapchain : public RenderTarget
{
@@ -33,6 +34,8 @@ namespace Nz
virtual void NotifyResize(const Vector2ui& newSize) = 0;
virtual TransientResources& Transient() = 0;
protected:
static void BuildRenderPass(PixelFormat colorFormat, PixelFormat depthFormat, std::vector<RenderPass::Attachment>& attachments, std::vector<RenderPass::SubpassDescription>& subpassDescriptions, std::vector<RenderPass::SubpassDependency>& subpassDependencies);
};

87
include/Nazara/Renderer/TransientResources.hpp Normal file
View File

@@ -0,0 +1,87 @@
// Copyright (C) 2023 Jérôme "Lynix" Leclercq (lynix680@gmail.com)
// This file is part of the "Nazara Engine - Renderer module"
// For conditions of distribution and use, see copyright notice in Config.hpp
#pragma once
#ifndef NAZARA_RENDERER_TRANSIENTRESOURCES_HPP
#define NAZARA_RENDERER_TRANSIENTRESOURCES_HPP
#include <NazaraUtils/Prerequisites.hpp>
#include <Nazara/Renderer/Config.hpp>
#include <Nazara/Renderer/Enums.hpp>
#include <NazaraUtils/FunctionRef.hpp>
#include <functional>
#include <type_traits>
#include <vector>
namespace Nz
{
class CommandBuffer;
class CommandBufferBuilder;
class UploadPool;
class NAZARA_RENDERER_API TransientResources
{
public:
class Releasable;
template<typename T> class ReleasableLambda;
virtual ~TransientResources();
virtual void Execute(const FunctionRef<void(CommandBufferBuilder& builder)>& callback, QueueTypeFlags queueTypeFlags) = 0;
inline void FlushReleaseQueue();
virtual UploadPool& GetUploadPool() = 0;
template<typename T> void PushForRelease(const T& value) = delete;
template<typename T> void PushForRelease(T&& value);
template<typename F> void PushReleaseCallback(F&& callback);
virtual void SubmitCommandBuffer(CommandBuffer* commandBuffer, QueueTypeFlags queueTypeFlags) = 0;
protected:
TransientResources() = default;
TransientResources(const TransientResources&) = delete;
TransientResources(TransientResources&&) = delete;
private:
static constexpr std::size_t BlockSize = 4 * 1024 * 1024;
using Block = std::vector<UInt8>;
std::vector<Releasable*> m_releaseQueue;
std::vector<Block> m_releaseMemoryPool;
};
class NAZARA_RENDERER_API TransientResources::Releasable
{
public:
virtual ~Releasable();
virtual void Release() = 0;
};
template<typename T>
class TransientResources::ReleasableLambda : public Releasable
{
public:
template<typename U> ReleasableLambda(U&& lambda);
ReleasableLambda(const ReleasableLambda&) = delete;
ReleasableLambda(ReleasableLambda&&) = delete;
~ReleasableLambda() = default;
void Release() override;
ReleasableLambda& operator=(const ReleasableLambda&) = delete;
ReleasableLambda& operator=(ReleasableLambda&&) = delete;
private:
T m_lambda;
};
}
#include <Nazara/Renderer/TransientResources.inl>
#endif // NAZARA_RENDERER_TRANSIENTRESOURCES_HPP

100
include/Nazara/Renderer/TransientResources.inl Normal file
View File

@@ -0,0 +1,100 @@
// Copyright (C) 2023 Jérôme "Lynix" Leclercq (lynix680@gmail.com)
// This file is part of the "Nazara Engine - Renderer module"
// For conditions of distribution and use, see copyright notice in Config.hpp
#include <NazaraUtils/Algorithm.hpp>
#include <NazaraUtils/MemoryHelper.hpp>
#include <Nazara/Renderer/Debug.hpp>
namespace Nz
{
inline void TransientResources::FlushReleaseQueue()
{
for (Releasable* releasable : m_releaseQueue)
{
releasable->Release();
PlacementDestroy(releasable);
}
m_releaseQueue.clear();
for (auto& memoryblock : m_releaseMemoryPool)
memoryblock.clear();
}
template<typename T>
void TransientResources::PushForRelease(T&& value)
{
static_assert(std::is_rvalue_reference_v<decltype(value)>);
return PushReleaseCallback([v = std::move(value)] {});
}
template<typename F>
void TransientResources::PushReleaseCallback(F&& callback)
{
using Functor = ReleasableLambda<std::remove_cv_t<std::remove_reference_t<F>>>;
constexpr std::size_t functorSize = sizeof(Functor);
constexpr std::size_t functorAlignment = alignof(Functor);
// Try to minimize lost space
struct
{
Block* block = nullptr;
UInt64 alignedOffset = 0;
UInt64 lostSpace = 0;
} bestBlock;
for (Block& block : m_releaseMemoryPool)
{
std::size_t freeOffset = block.size();
UInt64 alignedOffset = Align(freeOffset, functorAlignment);
if (alignedOffset + functorSize > block.capacity())
continue; //< Not enough space
UInt64 lostSpace = alignedOffset - freeOffset;
if (!bestBlock.block || lostSpace < bestBlock.lostSpace)
{
bestBlock.block = &block;
bestBlock.alignedOffset = alignedOffset;
bestBlock.lostSpace = lostSpace;
}
}
// No block found, allocate a new one
if (!bestBlock.block)
{
Block newBlock;
newBlock.reserve(BlockSize);
bestBlock.block = &m_releaseMemoryPool.emplace_back(std::move(newBlock));
bestBlock.alignedOffset = 0;
bestBlock.lostSpace = 0;
}
Block& targetBlock = *bestBlock.block;
targetBlock.resize(bestBlock.alignedOffset + functorSize);
Functor* releasable = reinterpret_cast<Functor*>(&targetBlock[bestBlock.alignedOffset]);
PlacementNew(releasable, std::forward<F>(callback));
m_releaseQueue.push_back(releasable);
}
template<typename T>
template<typename U>
TransientResources::ReleasableLambda<T>::ReleasableLambda(U&& lambda) :
m_lambda(std::forward<U>(lambda))
{
}
template<typename T>
void TransientResources::ReleasableLambda<T>::Release()
{
m_lambda();
}
}
#include <Nazara/Renderer/DebugOff.hpp>

2
include/Nazara/Renderer/WindowSwapchain.hpp
View File

@@ -40,6 +40,8 @@ namespace Nz
inline Swapchain& GetSwapchain();
inline const Swapchain& GetSwapchain() const;
inline TransientResources& Transient();
WindowSwapchain& operator=(const WindowSwapchain&) = delete;
WindowSwapchain& operator=(WindowSwapchain&& windowSwapchain) = delete;

5
include/Nazara/Renderer/WindowSwapchain.inl
View File

@@ -40,6 +40,11 @@ namespace Nz
return *m_swapchain;
}
inline TransientResources& WindowSwapchain::Transient()
{
return m_swapchain->Transient();
}
void WindowSwapchain::DisconnectSignals()
{
m_onGainedFocus.Disconnect();