Utilizes rasterization to render a GBuffer output. More...

#include <foray_gbuffer.hpp>

Inheritance diagram for foray::stages::GBufferStage:

Classes
struct	PerImageInfo

Public Types
enum class	EOutput { Position , Normal , Albedo , Motion , MaterialIdx , MeshInstanceIdx , LinearZ , Depth , MaxEnum }

Public Member Functions
	GBufferStage ()=default

virtual void	Init (core::Context context, scene::Scene scene, std::string_view vertexShaderPath="", std::string_view fragmentShaderPath="", bench::DeviceBenchmark *benchmark=nullptr)

virtual void	RecordFrame (VkCommandBuffer cmdBuffer, base::FrameRenderInfo &renderInfo) override
	Records a frame to cmdBuffer.

virtual void	Resize (const VkExtent2D &extent) override
	Default implementation accesses mImageOutputs and calls ManagedImage::Resize(extent) on any set image.

virtual void	Destroy () override
	Destroy the render stage. Finalizes all components.

core::ManagedImage *	GetImageEOutput (EOutput output, bool noThrow=false)

Public Member Functions inherited from foray::stages::RasterizedRenderStage
	RasterizedRenderStage ()=default

virtual void	UpdateDescriptors ()

Public Member Functions inherited from foray::stages::RenderStage
	RenderStage ()=default

std::vector< core::ManagedImage * >	GetImageOutputs ()
	Gets a vector to all color attachments that will be included in a texture array and can be referenced in the shader pass.

core::ManagedImage *	GetImageOutput (std::string_view name, bool noThrow=false)
	Gets an image output.

virtual void	OnShadersRecompiled (const std::unordered_set< uint64_t > &recompiled)
	Notifies the stage that the shader compiler instance has recompiled a shader.

virtual	~RenderStage ()

Static Public Attributes
static constexpr std::string_view	PositionOutputName = "Gbuf.Position"

static constexpr std::string_view	NormalOutputName = "Gbuf.Normal"

static constexpr std::string_view	AlbedoOutputName = "Gbuf.Albedo"

static constexpr std::string_view	MotionOutputName = "Gbuf.Motion"

static constexpr std::string_view	MaterialIdxOutputName = "Gbuf.MaterialIdx"

static constexpr std::string_view	MeshInstanceIdOutputName = "Gbuf.MeshInstanceIdx"

static constexpr std::string_view	LinearZOutputName = "Gbuf.LinearZ"

static constexpr std::string_view	DepthOutputName = "Gbuf.Depth"

Protected Member Functions
virtual void	DestroyFrameBufferAndRenderpass ()

void	CreateImages ()

void	PrepareRenderpass ()

virtual void	SetupDescriptors () override

virtual void	CreateDescriptorSets () override

virtual void	CreatePipelineLayout () override

void	CreatePipeline ()

Protected Member Functions inherited from foray::stages::RenderStage
virtual void	ReloadShaders ()
	Override this to reload all shaders and rebuild pipelines after a registered shader has been recompiled.

virtual void	DestroyOutputImages ()
	Calls Destroy() on any image in mImageOutputs and clears mImageOutputs.

Protected Attributes
scene::Scene *	mScene

std::array< PerImageInfo,(size_t) EOutput::MaxEnum >	mImageInfos

std::string	mVertexShaderPath = ""

std::string	mFragmentShaderPath = ""

core::ShaderModule	mVertexShaderModule

core::ShaderModule	mFragmentShaderModule

bench::DeviceBenchmark *	mBenchmark = nullptr

Protected Attributes inherited from foray::stages::RasterizedRenderStage
VkFramebuffer	mFrameBuffer = nullptr

VkRenderPass	mRenderpass = nullptr

core::DescriptorSet	mDescriptorSet

VkPipeline	mPipeline = nullptr

util::PipelineLayout	mPipelineLayout

Protected Attributes inherited from foray::stages::RenderStage
std::unordered_map< std::string, core::ManagedImage * >	mImageOutputs
	Inheriting types should emplace their images onto this collection to provide them in GetImageOutput interface.

std::vector< uint64_t >	mShaderKeys
	Inheriting types should emplace their shader keys onto this collection such that if a shader has been recompiled, ReloadShaders() will be called.

core::Context *	mContext = nullptr
	Context object the renderstage is built upon.

Static Protected Attributes
static const char *	TIMESTAMP_VERT_BEGIN = "Vertex Begin"

static const char *	TIMESTAMP_VERT_END = "Vertex End"

static const char *	TIMESTAMP_FRAG_BEGIN = "Fragment Begin"

static const char *	TIMESTAMP_FRAG_END = "Fragment End"

Detailed Description

Utilizes rasterization to render a GBuffer output.

Outputs

Position rgba16f Worldspace positions of fragments
Normal rgba16f Worldspace normals
Albedo rgba16f Fragment Albedo
Motion rg16f Motion vectors. Translates Current -> Previous in UV coordinates
MaterialIdx r32i Material Indices. -1 indicates no material set.
MeshInstanceIdx r32u Mesh Instance Index. Unique for every ncomp::MeshInstance component
LinearZ rg16f Linear Depth (projected.z * projected.w), absolute linear depth Gradient
Depth d32f Vulkan Depth output

Member Enumeration Documentation

◆ EOutput

enum class foray::stages::GBufferStage::EOutput

strong

Enumerator
Position
Normal
Albedo
Motion
MaterialIdx
MeshInstanceIdx
LinearZ
Depth
MaxEnum

Constructor & Destructor Documentation

◆ GBufferStage()

foray::stages::GBufferStage::GBufferStage ( )

default

Member Function Documentation

◆ CreateDescriptorSets()

virtual void foray::stages::GBufferStage::CreateDescriptorSets ( )

overrideprotectedvirtual

Reimplemented from foray::stages::RasterizedRenderStage.

◆ CreateImages()

void foray::stages::GBufferStage::CreateImages ( )

protected

◆ CreatePipeline()

void foray::stages::GBufferStage::CreatePipeline ( )

protected

◆ CreatePipelineLayout()

virtual void foray::stages::GBufferStage::CreatePipelineLayout ( )

overrideprotectedvirtual

Reimplemented from foray::stages::RasterizedRenderStage.

◆ Destroy()

virtual void foray::stages::GBufferStage::Destroy ( )

overridevirtual

Destroy the render stage. Finalizes all components.

Reimplemented from foray::stages::RenderStage.

◆ DestroyFrameBufferAndRenderpass()

virtual void foray::stages::GBufferStage::DestroyFrameBufferAndRenderpass ( )

protectedvirtual

◆ GetImageEOutput()

core::ManagedImage * foray::stages::GBufferStage::GetImageEOutput	(	EOutput	output,
		bool	noThrow = `false`
	)

◆ Init()

virtual void foray::stages::GBufferStage::Init	(	core::Context *	context,
		scene::Scene *	scene,
		std::string_view	vertexShaderPath = `""`,
		std::string_view	fragmentShaderPath = `""`,
		bench::DeviceBenchmark *	benchmark = `nullptr`
	)

virtual

Parameters

scene	Scene required for transforms, vertex/index buffers, materials, textures, ...
vertexShaderPath	(optional) override with a custom vertex shader
fragmentShaderPath	(optional) override with a custom fragment shader
benchmark	(optional) enable benchmarking by passing a devicebenchmark object here

◆ PrepareRenderpass()

void foray::stages::GBufferStage::PrepareRenderpass ( )

protected

◆ RecordFrame()

virtual void foray::stages::GBufferStage::RecordFrame	(	VkCommandBuffer	cmdBuffer,
		base::FrameRenderInfo &	renderInfo
	)

overridevirtual

Records a frame to cmdBuffer.

Parameters

cmdBuffer	Command buffer to record to
renderInfo	Additional information about the current frame being rendered

Inheriting

Any resources accessed (images, buffers) must be protected by pipeline barriers, unless the providing entity defines them as constants
All commands must be submitted to cmdBuffer

Reimplemented from foray::stages::RenderStage.

◆ Resize()

virtual void foray::stages::GBufferStage::Resize ( const VkExtent2D & extent )

overridevirtual

Default implementation accesses mImageOutputs and calls ManagedImage::Resize(extent) on any set image.

Parameters

extent New render size

Remarks: Inheriting stages may override to update descriptor sets

Reimplemented from foray::stages::RenderStage.

◆ SetupDescriptors()

virtual void foray::stages::GBufferStage::SetupDescriptors ( )

overrideprotectedvirtual

Reimplemented from foray::stages::RasterizedRenderStage.

Member Data Documentation

◆ AlbedoOutputName

constexpr std::string_view foray::stages::GBufferStage::AlbedoOutputName = "Gbuf.Albedo"

inlinestaticconstexpr

◆ DepthOutputName

constexpr std::string_view foray::stages::GBufferStage::DepthOutputName = "Gbuf.Depth"

inlinestaticconstexpr

◆ LinearZOutputName

constexpr std::string_view foray::stages::GBufferStage::LinearZOutputName = "Gbuf.LinearZ"

inlinestaticconstexpr

◆ MaterialIdxOutputName

constexpr std::string_view foray::stages::GBufferStage::MaterialIdxOutputName = "Gbuf.MaterialIdx"

inlinestaticconstexpr

◆ mBenchmark

bench::DeviceBenchmark* foray::stages::GBufferStage::mBenchmark = nullptr

protected

◆ MeshInstanceIdOutputName

constexpr std::string_view foray::stages::GBufferStage::MeshInstanceIdOutputName = "Gbuf.MeshInstanceIdx"

inlinestaticconstexpr

◆ mFragmentShaderModule

core::ShaderModule foray::stages::GBufferStage::mFragmentShaderModule

protected

◆ mFragmentShaderPath

std::string foray::stages::GBufferStage::mFragmentShaderPath = ""

protected

◆ mImageInfos

std::array<PerImageInfo, (size_t)EOutput::MaxEnum> foray::stages::GBufferStage::mImageInfos

protected

◆ MotionOutputName

constexpr std::string_view foray::stages::GBufferStage::MotionOutputName = "Gbuf.Motion"

inlinestaticconstexpr

◆ mScene

scene::Scene* foray::stages::GBufferStage::mScene

protected

◆ mVertexShaderModule

core::ShaderModule foray::stages::GBufferStage::mVertexShaderModule

protected

◆ mVertexShaderPath

std::string foray::stages::GBufferStage::mVertexShaderPath = ""

protected

◆ NormalOutputName

constexpr std::string_view foray::stages::GBufferStage::NormalOutputName = "Gbuf.Normal"

inlinestaticconstexpr

◆ PositionOutputName

constexpr std::string_view foray::stages::GBufferStage::PositionOutputName = "Gbuf.Position"

inlinestaticconstexpr

◆ TIMESTAMP_FRAG_BEGIN

const char* foray::stages::GBufferStage::TIMESTAMP_FRAG_BEGIN = "Fragment Begin"

inlinestaticprotected

◆ TIMESTAMP_FRAG_END

const char* foray::stages::GBufferStage::TIMESTAMP_FRAG_END = "Fragment End"

inlinestaticprotected

◆ TIMESTAMP_VERT_BEGIN

const char* foray::stages::GBufferStage::TIMESTAMP_VERT_BEGIN = "Vertex Begin"

inlinestaticprotected

◆ TIMESTAMP_VERT_END

const char* foray::stages::GBufferStage::TIMESTAMP_VERT_END = "Vertex End"

inlinestaticprotected

The documentation for this class was generated from the following file:

src/stages/foray_gbuffer.hpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Outputs

Member Enumeration Documentation

◆ EOutput

Constructor & Destructor Documentation

◆ GBufferStage()

Member Function Documentation

◆ CreateDescriptorSets()

◆ CreateImages()

◆ CreatePipeline()

◆ CreatePipelineLayout()

◆ Destroy()

◆ DestroyFrameBufferAndRenderpass()

◆ GetImageEOutput()

◆ Init()

◆ PrepareRenderpass()

◆ RecordFrame()

Inheriting

◆ Resize()

◆ SetupDescriptors()

Member Data Documentation

◆ AlbedoOutputName

◆ DepthOutputName

◆ LinearZOutputName

◆ MaterialIdxOutputName

◆ mBenchmark

◆ MeshInstanceIdOutputName

◆ mFragmentShaderModule

◆ mFragmentShaderPath

◆ mImageInfos

◆ MotionOutputName

◆ mScene

◆ mVertexShaderModule

◆ mVertexShaderPath

◆ NormalOutputName

◆ PositionOutputName

◆ TIMESTAMP_FRAG_BEGIN

◆ TIMESTAMP_FRAG_END

◆ TIMESTAMP_VERT_BEGIN

◆ TIMESTAMP_VERT_END