CeresEngine::VoxelConeTracing::VoxelizationRenderTask Class Reference

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

Inheritance diagram for CeresEngine::VoxelConeTracing::VoxelizationRenderTask:

Public Member Functions
	VoxelizationRenderTask (RenderGraph &renderGraph, RendererScene &scene, RendererCamera &camera, const Settings &settings)
	Creates a new VoxelizationRenderTask.
	~VoxelizationRenderTask () final
Public Member Functions inherited from CeresEngine::SimpleGraphicsRenderTask
	SimpleGraphicsRenderTask (RenderGraph &renderGraph, const String &name)
StringView	getName () const override
	Returns a display name for the render task.
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 {
ImageRenderResourceRef   albedo
ImageRenderResourceRef   normal
ImageRenderResourceRef   emission
}	output

Protected Member Functions
void	compile (RenderTaskCompiler &compiler) final
	Compiles the render task.
void	initialize (GPUDevice &device) final
	Perform a sequence of steps that initialize the graphics render task.
void	execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer) final
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.
void	execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer, GPURenderTarget &renderTarget) override
virtual void	execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer, GPURenderTarget &renderTarget, GPUGraphicsPipeline &pipeline)=0
	Executes the graphics render task with the given commandBuffer, pipeline and renderTarget.
virtual void	execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer)=0
	Executes the render task with the given commandBuffer.
Protected Member Functions inherited from CeresEngine::SimpleGraphicsRenderTask
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
GPUSamplerPtr	mSampler
	The material sampler.
RendererScene &	mScene
RendererCamera &	mCamera
const Settings &	mSettings

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

Constructor & Destructor Documentation

VoxelizationRenderTask()

CeresEngine::VoxelConeTracing::VoxelizationRenderTask::VoxelizationRenderTask ( RenderGraph &  renderGraph, RendererScene &  scene, RendererCamera &  camera, const Settings &  settings  )

explicit

Creates a new VoxelizationRenderTask.

~VoxelizationRenderTask()

CeresEngine::VoxelConeTracing::VoxelizationRenderTask::~VoxelizationRenderTask ( )

final

Member Function Documentation

compile()

void CeresEngine::VoxelConeTracing::VoxelizationRenderTask::compile ( RenderTaskCompiler &  compiler )

finalprotectedvirtual

Compiles the render task.

Implements CeresEngine::RenderTask.

createGraphicsPipeline()

GPUGraphicsPipelinePtr CeresEngine::VoxelConeTracing::VoxelizationRenderTask::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() [1/5]

void CeresEngine::VoxelConeTracing::VoxelizationRenderTask::execute ( RenderGraphContext &  context, GPUCommandBuffer &  commandBuffer  )

finalprotectedvirtual

Reimplemented from CeresEngine::SimpleGraphicsRenderTask.

execute() [2/5]

virtual void CeresEngine::RenderTask::execute ( RenderGraphContext &  context, GPUCommandBuffer &  commandBuffer  )

protectedvirtual

Executes the render task with the given commandBuffer.

Parameters

commandBuffer

The command buffer to encode the render task to.

Reimplemented from CeresEngine::SimpleGraphicsRenderTask.

execute() [3/5]

void CeresEngine::SimpleGraphicsRenderTask::execute ( RenderGraphContext &  context, GPUCommandBuffer &  commandBuffer, GPURenderTarget &  renderTarget  )

overrideprotectedvirtual

Reimplemented from CeresEngine::SimpleGraphicsRenderTask.

execute() [4/5]

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

finalprotectedvirtual

Implements CeresEngine::SimpleGraphicsRenderTask.

execute() [5/5]

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

protectedvirtual

Executes the graphics render task with the given commandBuffer, pipeline and renderTarget.

Parameters

commandBuffer	The command buffer to encode the render task to.
renderTarget	The render target to render to.
pipeline	The graphics pipeline for the task.

Implements CeresEngine::SimpleGraphicsRenderTask.

initialize()

void CeresEngine::VoxelConeTracing::VoxelizationRenderTask::initialize ( GPUDevice &  device )

finalprotectedvirtual

Perform a sequence of steps that initialize the graphics render task.

These operations are only executed once in the first execution.

Reimplemented from CeresEngine::SimpleGraphicsRenderTask.

Member Data Documentation

albedo

ImageRenderResourceRef CeresEngine::VoxelConeTracing::VoxelizationRenderTask::albedo

emission

ImageRenderResourceRef CeresEngine::VoxelConeTracing::VoxelizationRenderTask::emission

mCamera

RendererCamera& CeresEngine::VoxelConeTracing::VoxelizationRenderTask::mCamera

private

mSampler

GPUSamplerPtr CeresEngine::VoxelConeTracing::VoxelizationRenderTask::mSampler

private

The material sampler.

mScene

RendererScene& CeresEngine::VoxelConeTracing::VoxelizationRenderTask::mScene

private

mSettings

const Settings& CeresEngine::VoxelConeTracing::VoxelizationRenderTask::mSettings

private

normal

ImageRenderResourceRef CeresEngine::VoxelConeTracing::VoxelizationRenderTask::normal

[struct]

struct { ... } CeresEngine::VoxelConeTracing::VoxelizationRenderTask::output

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Renderer/Rendering/VoxelConeTracing.hpp