#include <OverlayPass.hpp>

Inheritance diagram for castor3d::OverlayPass:

Collaboration diagram for castor3d::OverlayPass:

Public Member Functions
C3D_API	OverlayPass (crg::FramePass const &pass, crg::GraphContext &context, crg::RunnableGraph &graph, RenderDevice const &device, Scene const &scene, VkExtent2D const &size, Texture const &output, HdrConfigUbo const &hdrConfigUbo, bool drawGlobal=false)
	Constructor.

C3D_API void	update (CpuUpdater &updater)
	Updates the render pass, CPU wise.

C3D_API void	update (GpuUpdater &updater)
	Updates the render pass, GPU wise.

C3D_API void	upload (UploadData &uploader)
	Uploads overlays GPU buffers to VRAM.

Constructor & Destructor Documentation

◆ OverlayPass()

C3D_API castor3d::OverlayPass::OverlayPass	(	crg::FramePass const &	pass,
		crg::GraphContext &	context,
		crg::RunnableGraph &	graph,
		RenderDevice const &	device,
		Scene const &	scene,
		VkExtent2D const &	size,
		Texture const &	output,
		HdrConfigUbo const &	hdrConfigUbo,
		bool	drawGlobal = false )

Constructor.

Parameters

[in]	pass	The parent frame pass.
[in]	context	The rendering context.
[in]	graph	The runnable graph.
[in]	device	The GPU device.
[in]	scene	The scene.
[in]	size	The render area dimensions.
[in]	output	The result texture.
[in]	hdrConfigUbo	The HDR configuration used when rendering to an HDR screen.
[in]	drawGlobal	`true` to also draw global overlays.

C3D_API void castor3d::OverlayPass::update ( CpuUpdater & updater )

Updates the render pass, CPU wise.

Parameters

[in,out] updater The update data.

C3D_API void castor3d::OverlayPass::update ( GpuUpdater & updater )

Updates the render pass, GPU wise.

Parameters

[in,out] updater The update data.

C3D_API void castor3d::OverlayPass::upload ( UploadData & uploader )

Uploads overlays GPU buffers to VRAM.

Parameters

[in,out] uploader Receives the upload requests.

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