A render task that renders the scene skybox. More...

#include <CeresEngine/Renderer/Rendering/Shading.hpp>

Inheritance diagram for CeresEngine::SkyboxRenderTask:

Classes
struct	Input
	A set of resources used as input for the render task. More...

struct	Output
	A set of resources used as output for the render task. More...

Public Member Functions
	SkyboxRenderTask (RenderGraph &renderGraph, RendererView &view)
	Cretaes a new skybox render task.

	~SkyboxRenderTask () final

Public Member Functions inherited from CeresEngine::SimpleGraphicsRenderTask
	SimpleGraphicsRenderTask (RenderGraph &renderGraph, const String &name)

void	execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer, GPURenderTarget &renderTarget) override

StringView	getName () const override
	Returns a display name for the render task.

virtual void	execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer)=0
	Executes the render task with the given `commandBuffer`.

Public Member Functions inherited from CeresEngine::GraphicsRenderTask
	RenderTask (RenderGraph &renderGraph)

Public Member Functions inherited from CeresEngine::RenderTask
	RenderTask (RenderGraph &renderGraph)

virtual	~RenderTask ()

RenderTaskResourceUsage &	compile ()
	Compiles the render task.

virtual RenderTaskStatus	check () const
	Returns true if the task is dirty and needs to be run.

virtual Any	getSettings () const
	Gets a const-reference to the render task settings.

virtual Any	getSettings ()
	Gets a reference to the render task settings.

const Vector< InputSlot * > &	getInputs () const

const Vector< OutputSlot * > &	getOutputs () const

const RenderTaskResourceUsage &	getResourceUsage () const

Public Member Functions inherited from CeresEngine::RefCounted< RenderTask >
	RefCounted (Args &&... args)
	Creates a new `RefCounted` object and constructs a new `Deleter` by forwarding `Args` to it.

void	retain () noexcept
	Retains the object by increment it's reference count by one.

bool	release () noexcept
	Relases the object by decrementing it's reference count by one.

Public Attributes
struct CeresEngine::SkyboxRenderTask::Input	input

struct CeresEngine::SkyboxRenderTask::Output	output

Protected Member Functions
void	compile (RenderTaskCompiler &compiler) final
	Compiles the render task.

void	execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer, GPURenderTarget &renderTarget, GPUGraphicsPipeline &pipeline) final

GPUGraphicsPipelinePtr	createGraphicsPipeline (GPUDevice &device, GPURenderPass &renderPass) final
	Creates a new graphics pipeline instance for the render task.

Protected Member Functions inherited from CeresEngine::SimpleGraphicsRenderTask
virtual void	initialize (GPUDevice &device)
	Perform a sequence of steps that initialize the graphics render task.

virtual bool	isGraphicsPipelineDirty (GPUGraphicsPipeline &graphicsPipeline, GPURenderPass &renderPass) const
	Checks if the graphics pipeline is dirty and needs to be recreated.

Protected Member Functions inherited from CeresEngine::GraphicsRenderTask
virtual bool	isRenderPassDirty (GPURenderPass &renderPass) const
	Checks if the render pass is dirty and needs to be recreated.

virtual GPURenderPassPtr	createRenderPass (GPUDevice &device)
	Creates a new render pass instance for the render task.

virtual bool	isRenderTargetDirty (GPURenderTarget &renderTarget, GPURenderPass &renderPass) const
	Checks if the render target is dirty and needs to be recreated.

virtual GPURenderTargetPtr	createRenderTarget (GPUDevice &device, GPURenderPass &renderPass)
	Creates a new render target instance for the render task.

Protected Member Functions inherited from CeresEngine::RenderTask
virtual bool	shouldConnect (const Slot &slot, const Slot &targetSlot) const
	An internal method called whenever a new connection is being made.

virtual void	willConnect (Slot &slot, Slot &targetSlot)
	An internal method called before the slot is connected.

virtual void	didConnect (Slot &slot, Connection &connection)
	An internal method called after the slot is connected.

virtual bool	shouldDisconnect (const Slot &slot, const Connection &connection) const
	An internal method called whenever a new disconnection is being made.

virtual void	willDisconnect (Slot &slot, Connection &connection)
	An internal method called before the slot is disconnected.

virtual void	didDisconnect (Slot &slot, Connection &connection)
	An internal method called whenever the slot is disconnected.

ImageRenderResource &	create (const GPUImageDescriptor &descriptor)

BufferRenderResource &	create (const GPUBufferDescriptor &descriptor)

Private Attributes
RendererView &	mView
	The view to render the skybox for.

Additional Inherited Members
Protected Attributes inherited from CeresEngine::SimpleGraphicsRenderTask
GPUGraphicsPipelinePtr	mPipeline
	The cached graphics pipeline instance.

Protected Attributes inherited from CeresEngine::GraphicsRenderTask
GPURenderPassPtr	mRenderPass
	The cached render pass instance.

GPURenderTargetPtr	mRenderTarget
	The cached render target instance.

Protected Attributes inherited from CeresEngine::RenderTask
RenderTaskResourceUsage	mResourceUsage

Detailed Description

A render task that renders the scene skybox.

Constructor & Destructor Documentation

◆ SkyboxRenderTask()

CeresEngine::SkyboxRenderTask::SkyboxRenderTask	(	RenderGraph &	renderGraph,
		RendererView &	view
	)

Cretaes a new skybox render task.

Parameters

renderGraph	The render graph the skybox task is attached to.
view	The view to render the skybox for.

◆ ~SkyboxRenderTask()

CeresEngine::SkyboxRenderTask::~SkyboxRenderTask ( )

final

Member Function Documentation

◆ compile()

void CeresEngine::SkyboxRenderTask::compile ( RenderTaskCompiler & compiler )

finalprotectedvirtual

Compiles the render task.

Implements CeresEngine::RenderTask.

◆ createGraphicsPipeline()

GPUGraphicsPipelinePtr CeresEngine::SkyboxRenderTask::createGraphicsPipeline	(	GPUDevice &	device,
		GPURenderPass &	renderPass
	)

finalprotectedvirtual

Creates a new graphics pipeline instance for the render task.

Parameters

device	The device in which the implementation should create the graphics pipeline instance from.
renderPass	A reference to the current render pass. The implementation must use this render pass to create the new graphics pipeline.

Implements CeresEngine::SimpleGraphicsRenderTask.

◆ execute()

void CeresEngine::SkyboxRenderTask::execute	(	RenderGraphContext &	context,
		GPUCommandBuffer &	commandBuffer,
		GPURenderTarget &	renderTarget,
		GPUGraphicsPipeline &	pipeline
	)

finalprotectedvirtual

Implements CeresEngine::SimpleGraphicsRenderTask.

Member Data Documentation

◆ input

struct CeresEngine::SkyboxRenderTask::Input CeresEngine::SkyboxRenderTask::input

◆ mView

RendererView& CeresEngine::SkyboxRenderTask::mView

private

The view to render the skybox for.

◆ output

struct CeresEngine::SkyboxRenderTask::Output CeresEngine::SkyboxRenderTask::output

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

/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Renderer/Rendering/Shading.hpp

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SkyboxRenderTask()

◆ ~SkyboxRenderTask()

Member Function Documentation

◆ compile()

◆ createGraphicsPipeline()

◆ execute()

Member Data Documentation

◆ input

◆ mView

◆ output