CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::VoxelConeTracing::DebugRenderTask Class Referencefinal

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

Inheritance diagram for CeresEngine::VoxelConeTracing::DebugRenderTask:
CeresEngine::SimpleGraphicsRenderTask CeresEngine::GraphicsRenderTask CeresEngine::RenderTask CeresEngine::RefCounted< RenderTask >

Public Member Functions

 DebugRenderTask (RenderGraph &renderGraph, RendererCamera &camera, const Settings &settings)
 Creates a new DebugRenderTask.
 
 ~DebugRenderTask () 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 ()
 
RenderTaskResourceUsagecompile ()
 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 RenderTaskResourceUsagegetResourceUsage () 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   voxel 
 
input 
 
struct { 
 
   ImageRenderResourceRef   color 
 
   ImageRenderResourceRef   depth 
 
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.
 
ImageRenderResourcecreate (const GPUImageDescriptor &descriptor)
 
BufferRenderResourcecreate (const GPUBufferDescriptor &descriptor)
 

Private Attributes

GPUGraphicsPipelinePtr mPipeline
 The graphics pipeline used to render the voxel scene for debug purposes.
 
RendererCameramCamera
 
const SettingsmSettings
 

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

◆ DebugRenderTask()

CeresEngine::VoxelConeTracing::DebugRenderTask::DebugRenderTask ( RenderGraph renderGraph,
RendererCamera camera,
const Settings settings 
)
explicit

Creates a new DebugRenderTask.

◆ ~DebugRenderTask()

CeresEngine::VoxelConeTracing::DebugRenderTask::~DebugRenderTask ( )
final

Member Function Documentation

◆ compile()

void CeresEngine::VoxelConeTracing::DebugRenderTask::compile ( RenderTaskCompiler compiler)
finalprotectedvirtual

Compiles the render task.

Implements CeresEngine::RenderTask.

◆ createGraphicsPipeline()

GPUGraphicsPipelinePtr CeresEngine::VoxelConeTracing::DebugRenderTask::createGraphicsPipeline ( GPUDevice device,
GPURenderPass renderPass 
)
finalprotectedvirtual

Creates a new graphics pipeline instance for the render task.

Parameters
deviceThe device in which the implementation should create the graphics pipeline instance from.
renderPassA 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::VoxelConeTracing::DebugRenderTask::execute ( RenderGraphContext context,
GPUCommandBuffer commandBuffer,
GPURenderTarget renderTarget,
GPUGraphicsPipeline pipeline 
)
finalprotectedvirtual

Member Data Documentation

◆ color

ImageRenderResourceRef CeresEngine::VoxelConeTracing::DebugRenderTask::color

◆ depth

ImageRenderResourceRef CeresEngine::VoxelConeTracing::DebugRenderTask::depth

◆ [struct]

struct { ... } CeresEngine::VoxelConeTracing::DebugRenderTask::input

◆ mCamera

RendererCamera& CeresEngine::VoxelConeTracing::DebugRenderTask::mCamera
private

◆ mPipeline

GPUGraphicsPipelinePtr CeresEngine::VoxelConeTracing::DebugRenderTask::mPipeline
private

The graphics pipeline used to render the voxel scene for debug purposes.

◆ mSettings

const Settings& CeresEngine::VoxelConeTracing::DebugRenderTask::mSettings
private

◆ [struct]

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

◆ voxel

ImageRenderResourceRef CeresEngine::VoxelConeTracing::DebugRenderTask::voxel

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