castor3d::OverlayRenderer Class Reference

#include <OverlayRenderer.hpp>

Inheritance diagram for castor3d::OverlayRenderer:

Collaboration diagram for castor3d::OverlayRenderer:

Classes
struct	ComputePipeline
struct	FontTextureDescriptorConnection
struct	OverlaysCommonData
struct	OverlaysComputeData
struct	OverlaysDrawData
struct	TextComputePipeline
struct	TextComputePipelineDescriptor

Public Types
using	PanelVertexBufferPool = OverlayVertexBufferPoolT< OverlayCategory::Vertex, 6u >
using	BorderPanelVertexBufferPool = OverlayVertexBufferPoolT< OverlayCategory::Vertex, 8u * 6u >
using	TextVertexBufferPool = OverlayVertexBufferPoolT< TextOverlay::Vertex, MaxCharsPerOverlay >

Public Member Functions
C3D_API	OverlayRenderer (RenderDevice const &device, Texture const &target, HdrConfigUbo const &hdrConfigUbo, crg::FramePassTimer &timer, VkCommandBufferLevel level=VK_COMMAND_BUFFER_LEVEL_PRIMARY)
	Constructor.
C3D_API void	update (GpuUpdater &updater)
	Updates the render pass, GPU wise.
C3D_API OverlayPreparer	beginPrepare (RenderDevice const &device, VkRenderPass renderPass, VkFramebuffer framebuffer, crg::Fence &fence)
	Begins the overlays preparation.
C3D_API void	upload (UploadData &uploader)
	Uploads all GPU buffers to VRAM.
C3D_API void	registerComputeCommands (crg::RecordContext &context, VkCommandBuffer commandBuffer) const
	Records compute commands.
ashes::CommandBuffer const &	getCommands () const noexcept
castor::Size const &	getSize () const noexcept
bool	isSizeChanged () const noexcept
Public Member Functions inherited from castor::OwnedBy< RenderSystem >
RenderSystem *	getOwner () const noexcept
void	setOwner (RenderSystem &owner) noexcept

Friends
class	OverlayPreparer

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< RenderSystem >
	OwnedBy (RenderSystem &owner) noexcept
	Constructor.

Member Typedef Documentation

BorderPanelVertexBufferPool

using castor3d::OverlayRenderer::BorderPanelVertexBufferPool = OverlayVertexBufferPoolT< OverlayCategory::Vertex, 8u * 6u >

PanelVertexBufferPool

using castor3d::OverlayRenderer::PanelVertexBufferPool = OverlayVertexBufferPoolT< OverlayCategory::Vertex, 6u >

TextVertexBufferPool

using castor3d::OverlayRenderer::TextVertexBufferPool = OverlayVertexBufferPoolT< TextOverlay::Vertex, MaxCharsPerOverlay >

Constructor & Destructor Documentation

OverlayRenderer()

C3D_API castor3d::OverlayRenderer::OverlayRenderer	(	RenderDevice const &	device,
		Texture const &	target,
		HdrConfigUbo const &	hdrConfigUbo,
		crg::FramePassTimer &	timer,
		VkCommandBufferLevel	level = VK_COMMAND_BUFFER_LEVEL_PRIMARY )

Constructor.

Parameters

[in]	device	The GPU device.
[in]	target	The target texture.
[in]	hdrConfigUbo	The HDR configuration used when rendering to an HDR screen.
[in]	timer	The timer for this pass.
[in]	level	The command buffer level.

Member Function Documentation

beginPrepare()

C3D_API OverlayPreparer castor3d::OverlayRenderer::beginPrepare	(	RenderDevice const &	device,
		VkRenderPass	renderPass,
		VkFramebuffer	framebuffer,
		crg::Fence &	fence )

Begins the overlays preparation.

Parameters

[in]	device	The render device.
[in]	renderPass	The render pass.
[in]	framebuffer	The framebuffer receiving the result.
[in]	fence	The fence to wait for before rendering.

getCommands()

ashes::CommandBuffer const & castor3d::OverlayRenderer::getCommands ( ) const

inlinenoexcept

name Getters.

References castor3d::CommandsSemaphore::commandBuffer, castor3d::OverlayRenderer::OverlaysDrawData::commands, and CU_Require.

getSize()

castor::Size const & castor3d::OverlayRenderer::getSize ( ) const

inlinenoexcept

isSizeChanged()

bool castor3d::OverlayRenderer::isSizeChanged ( ) const

inlinenoexcept

registerComputeCommands()

C3D_API void castor3d::OverlayRenderer::registerComputeCommands	(	crg::RecordContext &	context,
		VkCommandBuffer	commandBuffer ) const

Records compute commands.

Parameters

[in]	context	The recording context.
[in]	commandBuffer	The command buffer on which commands are recorded.

update()

C3D_API void castor3d::OverlayRenderer::update

(

GpuUpdater &

updater

)

Updates the render pass, GPU wise.

Parameters

[in,out]

updater

The update data.

upload()

C3D_API void castor3d::OverlayRenderer::upload

(

UploadData &

uploader

)

Uploads all GPU buffers to VRAM.

Parameters

[in,out]

uploader

Receives the upload requests.

Friends And Related Symbol Documentation

OverlayPreparer

friend class OverlayPreparer

friend

---

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

• Castor3D/Render/Overlays/OverlayRenderer.hpp