Implements a Vulkan render pass. More...

#include <vulkan.hpp>

Inherits LiteFX::Rendering::RenderPass< VulkanRenderPipeline, VulkanFrameBuffer, VulkanInputAttachmentMapping >, and LiteFX::Resource< VkRenderPass >.

Classes
class	VulkanRenderPassImpl

Public Member Functions
	VulkanRenderPass (const VulkanDevice &device, Span< RenderTarget > renderTargets, const UInt32 &commandBuffers=1, const MultiSamplingLevel &samples=MultiSamplingLevel::x1, Span< VulkanInputAttachmentMapping > inputAttachments={ })
	Creates and initializes a new Vulkan render pass instance. More...

	VulkanRenderPass (const VulkanDevice &device, const String &name, Span< RenderTarget > renderTargets, const UInt32 &commandBuffers=1, const MultiSamplingLevel &samples=MultiSamplingLevel::x1, Span< VulkanInputAttachmentMapping > inputAttachments={ })
	Creates and initializes a new Vulkan render pass instance. More...

	VulkanRenderPass (const VulkanRenderPass &)=delete

	VulkanRenderPass (VulkanRenderPass &&)=delete

virtual	~VulkanRenderPass () noexcept

virtual const VulkanFrameBuffer &	frameBuffer (const UInt32 &buffer) const override
	Returns the frame buffer with the index provided in buffer . More...

virtual const VulkanDevice &	device () const noexcept
	Returns a reference to the device that provides this queue. More...

virtual const VulkanFrameBuffer &	activeFrameBuffer () const override
	Returns the current frame buffer from of the render pass. More...

virtual Array< const VulkanFrameBuffer * >	frameBuffers () const noexcept override

virtual Array< const VulkanRenderPipeline * >	pipelines () const noexcept override

virtual const RenderTarget &	renderTarget (const UInt32 &location) const override
	Returns the render target mapped to the location provided by location . More...

virtual Span< const RenderTarget >	renderTargets () const noexcept override
	Returns the list of render targets, the render pass renders into. More...

virtual bool	hasPresentTarget () const noexcept override
	Returns `true`, if one of the render targets is used for presentation on a swap chain. More...

virtual Span< const VulkanInputAttachmentMapping >	inputAttachments () const noexcept override

virtual const MultiSamplingLevel &	multiSamplingLevel () const noexcept override
	Returns the input attachment the render pass is consuming. More...

virtual void	begin (const UInt32 &buffer) override
	Begins the render pass. More...

virtual void	end () const override
	Ends the render pass. More...

virtual void	resizeFrameBuffers (const Size2d &renderArea) override
	Resets the frame buffers of the render pass. More...

virtual void	changeMultiSamplingLevel (const MultiSamplingLevel &samples) override
	Changes the multi sampling level of the render pass. More...

virtual void	updateAttachments (const VulkanDescriptorSet &descriptorSet) const override

Public Member Functions inherited from LiteFX::Rendering::RenderPass< VulkanRenderPipeline, VulkanFrameBuffer, VulkanInputAttachmentMapping >
virtual	~RenderPass () noexcept=default

virtual const frame_buffer_type &	activeFrameBuffer () const=0
	Returns the current frame buffer from of the render pass. More...

virtual Array< const frame_buffer_type * >	frameBuffers () const noexcept=0

virtual Array< const render_pipeline_type * >	pipelines () const noexcept=0

virtual Span< const input_attachment_mapping_type >	inputAttachments () const noexcept=0

virtual void	updateAttachments (const descriptor_set_type &descriptorSet) const=0

Public Member Functions inherited from LiteFX::Rendering::StateResource
	StateResource (StringView name)
	Initializes a new state resource instance. More...

	StateResource (StateResource &&)=delete

	StateResource (const StateResource &)=delete

virtual	~StateResource () noexcept

virtual const String &	name () const noexcept override
	Returns the name of the resource. More...

Public Member Functions inherited from LiteFX::Rendering::IStateResource
virtual	~IStateResource () noexcept=default

virtual const String &	name () const noexcept=0
	Returns the name of the resource. More...

Public Member Functions inherited from LiteFX::Rendering::IRenderPass
virtual	~IRenderPass () noexcept=default

virtual const IFrameBuffer &	activeFrameBuffer () const =0
	Returns the current frame buffer from of the render pass. More...

Array< const IFrameBuffer * >	frameBuffers () const noexcept
	Returns a list of all frame buffers. More...

Array< const IRenderPipeline * >	pipelines () const noexcept
	Returns an array of all render pipelines, owned by the render pass. More...

virtual const RenderTarget &	renderTarget (const UInt32 &location) const =0
	Returns the render target mapped to the location provided by location . More...

virtual Span< const RenderTarget >	renderTargets () const noexcept=0
	Returns the list of render targets, the render pass renders into. More...

virtual bool	hasPresentTarget () const noexcept=0
	Returns `true`, if one of the render targets is used for presentation on a swap chain. More...

virtual const MultiSamplingLevel &	multiSamplingLevel () const noexcept=0
	Returns the input attachment the render pass is consuming. More...

virtual void	begin (const UInt32 &buffer)=0
	Begins the render pass. More...

virtual void	end () const =0
	Ends the render pass. More...

virtual void	resizeFrameBuffers (const Size2d &renderArea)=0
	Resets the frame buffers of the render pass. More...

virtual void	changeMultiSamplingLevel (const MultiSamplingLevel &samples)=0
	Changes the multi sampling level of the render pass. More...

void	updateAttachments (const IDescriptorSet &descriptorSet) const
	Resolves the input attachments mapped to the render pass and updates them on the descriptor set provided with descriptorSet. More...

Public Member Functions inherited from LiteFX::Rendering::IInputAttachmentMappingSource< VulkanFrameBuffer >
virtual	~IInputAttachmentMappingSource () noexcept=default

virtual const frame_buffer_type &	frameBuffer (const UInt32 &buffer) const=0
	Returns the frame buffer with the index provided in buffer . More...

Public Member Functions inherited from LiteFX::Resource< VkRenderPass >
	Resource (const Resource &)=delete

	Resource (Resource &&)=delete

virtual	~Resource () noexcept=default

const VkRenderPass &	handle () const noexcept override
	Returns the resource managed by the class. More...

Public Member Functions inherited from LiteFX::IResource< VkRenderPass >
virtual	~IResource () noexcept=default

virtual const VkRenderPass &	handle () const noexcept=0
	Returns the resource managed by the class. More...

Additional Inherited Members
Public Types inherited from LiteFX::Rendering::RenderPass< VulkanRenderPipeline, VulkanFrameBuffer, VulkanInputAttachmentMapping >
using	frame_buffer_type = VulkanFrameBuffer

using	render_pipeline_type = VulkanRenderPipeline

using	input_attachment_mapping_type = VulkanInputAttachmentMapping

using	pipeline_layout_type = render_pipeline_type::pipeline_layout_type

using	descriptor_set_layout_type = pipeline_layout_type::descriptor_set_layout_type

using	descriptor_set_type = descriptor_set_layout_type::descriptor_set_type

Public Types inherited from LiteFX::Rendering::IInputAttachmentMappingSource< VulkanFrameBuffer >
using	frame_buffer_type = VulkanFrameBuffer

Protected Member Functions inherited from LiteFX::Rendering::StateResource
	StateResource () noexcept

String &	name () noexcept

Protected Member Functions inherited from LiteFX::Resource< VkRenderPass >
	Resource (const VkRenderPass handle) noexcept
	Initializes the managed resource. More...

VkRenderPass &	handle () noexcept override
	Returns the resource managed by the class. More...

virtual VkRenderPass &	handle () noexcept=0
	Returns the resource managed by the class. More...

Detailed Description

Implements a Vulkan render pass.

See also: VulkanRenderPassBuilder

Constructor & Destructor Documentation

◆ VulkanRenderPass() [1/4]

VulkanRenderPass::VulkanRenderPass	(	const VulkanDevice &	device,
		Span< RenderTarget >	renderTargets,
		const UInt32 &	commandBuffers = `1`,
		const MultiSamplingLevel &	samples = `MultiSamplingLevel::x1`,
		Span< VulkanInputAttachmentMapping >	inputAttachments = `{ }`
	)

explicit

Creates and initializes a new Vulkan render pass instance.

Parameters

device	The parent device instance.
commandBuffers	The number of command buffers in each frame buffer.
renderTargets	The render targets that are output by the render pass.
samples	The number of samples for the render targets in this render pass.
inputAttachments	The input attachments that are read by the render pass.

◆ VulkanRenderPass() [2/4]

VulkanRenderPass::VulkanRenderPass	(	const VulkanDevice &	device,
		const String &	name,
		Span< RenderTarget >	renderTargets,
		const UInt32 &	commandBuffers = `1`,
		const MultiSamplingLevel &	samples = `MultiSamplingLevel::x1`,
		Span< VulkanInputAttachmentMapping >	inputAttachments = `{ }`
	)

explicit

Creates and initializes a new Vulkan render pass instance.

Parameters

device	The parent device instance.
name	The name of the render pass state resource.
commandBuffers	The number of command buffers in each frame buffer.
renderTargets	The render targets that are output by the render pass.
samples	The number of samples for the render targets in this render pass.
inputAttachments	The input attachments that are read by the render pass.

◆ VulkanRenderPass() [3/4]

LiteFX::Rendering::Backends::VulkanRenderPass::VulkanRenderPass ( const VulkanRenderPass & )

delete

◆ VulkanRenderPass() [4/4]

LiteFX::Rendering::Backends::VulkanRenderPass::VulkanRenderPass ( VulkanRenderPass && )

delete

◆ ~VulkanRenderPass()

VulkanRenderPass::~VulkanRenderPass ( )

virtualnoexcept

Member Function Documentation

◆ activeFrameBuffer()

const VulkanFrameBuffer & VulkanRenderPass::activeFrameBuffer ( ) const

overridevirtual

Returns the current frame buffer from of the render pass.

Implements LiteFX::Rendering::RenderPass< VulkanRenderPipeline, VulkanFrameBuffer, VulkanInputAttachmentMapping >.

◆ begin()

void VulkanRenderPass::begin ( const UInt32 & buffer )

overridevirtual

Begins the render pass.

Implements LiteFX::Rendering::IRenderPass.

◆ changeMultiSamplingLevel()

void VulkanRenderPass::changeMultiSamplingLevel ( const MultiSamplingLevel & samples )

overridevirtual

Changes the multi sampling level of the render pass.

Implements LiteFX::Rendering::IRenderPass.

◆ device()

const VulkanDevice & VulkanRenderPass::device ( ) const

virtualnoexcept

Returns a reference to the device that provides this queue.

Returns: A reference to the queue's parent device.

◆ end()

void VulkanRenderPass::end ( ) const

overridevirtual

Ends the render pass.

Implements LiteFX::Rendering::IRenderPass.

◆ frameBuffer()

const VulkanFrameBuffer & VulkanRenderPass::frameBuffer ( const UInt32 & buffer ) const

overridevirtual

Returns the frame buffer with the index provided in buffer .

Implements LiteFX::Rendering::IInputAttachmentMappingSource< VulkanFrameBuffer >.

◆ frameBuffers()

Array< const VulkanFrameBuffer * > VulkanRenderPass::frameBuffers ( ) const

overridevirtualnoexcept

Implements LiteFX::Rendering::RenderPass< VulkanRenderPipeline, VulkanFrameBuffer, VulkanInputAttachmentMapping >.

◆ hasPresentTarget()

bool VulkanRenderPass::hasPresentTarget ( ) const

overridevirtualnoexcept

Returns true, if one of the render targets is used for presentation on a swap chain.

Implements LiteFX::Rendering::IRenderPass.

◆ inputAttachments()

Span< const VulkanInputAttachmentMapping > VulkanRenderPass::inputAttachments ( ) const

overridevirtualnoexcept

Implements LiteFX::Rendering::RenderPass< VulkanRenderPipeline, VulkanFrameBuffer, VulkanInputAttachmentMapping >.

◆ multiSamplingLevel()

const MultiSamplingLevel & VulkanRenderPass::multiSamplingLevel ( ) const

overridevirtualnoexcept

Returns the input attachment the render pass is consuming.

Implements LiteFX::Rendering::IRenderPass.

◆ pipelines()

Array< const VulkanRenderPipeline * > VulkanRenderPass::pipelines ( ) const

overridevirtualnoexcept

Implements LiteFX::Rendering::RenderPass< VulkanRenderPipeline, VulkanFrameBuffer, VulkanInputAttachmentMapping >.

◆ renderTarget()

const RenderTarget & VulkanRenderPass::renderTarget ( const UInt32 & location ) const

overridevirtual

Returns the render target mapped to the location provided by location .

Implements LiteFX::Rendering::IRenderPass.

◆ renderTargets()

Span< const RenderTarget > VulkanRenderPass::renderTargets ( ) const

overridevirtualnoexcept

Returns the list of render targets, the render pass renders into.

Implements LiteFX::Rendering::IRenderPass.

◆ resizeFrameBuffers()

void VulkanRenderPass::resizeFrameBuffers ( const Size2d & renderArea )

overridevirtual

Resets the frame buffers of the render pass.

Implements LiteFX::Rendering::IRenderPass.

◆ updateAttachments()

void VulkanRenderPass::updateAttachments ( const VulkanDescriptorSet & descriptorSet ) const

overridevirtual

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VulkanRenderPass() [1/4]

◆ VulkanRenderPass() [2/4]

◆ VulkanRenderPass() [3/4]

◆ VulkanRenderPass() [4/4]

◆ ~VulkanRenderPass()

Member Function Documentation

◆ activeFrameBuffer()

◆ begin()

◆ changeMultiSamplingLevel()

◆ device()

◆ end()

◆ frameBuffer()

◆ frameBuffers()

◆ hasPresentTarget()

◆ inputAttachments()

◆ multiSamplingLevel()

◆ pipelines()

◆ renderTarget()

◆ renderTargets()

◆ resizeFrameBuffers()

◆ updateAttachments()