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

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

Inheritance diagram for CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask:
CeresEngine::SimpleComputeRenderTask CeresEngine::ComputeRenderTask CeresEngine::RenderTask CeresEngine::RefCounted< RenderTask >

Public Member Functions

 PropagateRadianceRenderTask (RenderGraph &renderGraph, Renderer &renderer, RendererCamera &camera, const Settings &settings, bool shouldClear=true)
 Creates a new PropagateRadianceRenderTask.
 
 ~PropagateRadianceRenderTask () final
 
- Public Member Functions inherited from CeresEngine::SimpleComputeRenderTask
 SimpleComputeRenderTask (RenderGraph &renderGraph, const String &name)
 
void execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer) override
 
StringView getName () const override
 Returns a display name for the render task.
 
- Public Member Functions inherited from CeresEngine::ComputeRenderTask
 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   albedo 
 
   ImageRenderResourceRef   normal 
 
   ImageRenderResourceRef   voxel 
 
input 
 
struct { 
 
   ImageRenderResourceRef   voxel 
 
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 compute render task.
 
void execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer) final
 
void execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer, GPUComputePipeline &pipeline) final
 
GPUComputePipelinePtr createComputePipeline (GPUDevice &device) final
 Creates a new compute pipeline instance for the render task.
 
- Protected Member Functions inherited from CeresEngine::SimpleComputeRenderTask
virtual bool isComputePipelineDirty (GPUComputePipeline &computePipeline) const
 Checks if the compute pipeline is dirty and needs to be recreated.
 
- 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

RenderermRenderer
 
RendererCameramCamera
 
const SettingsmSettings
 
bool mShouldClear
 
GPUSamplerPtr mSampler
 A sampler used to sample voxels from the radiance voxel map.
 

Additional Inherited Members

- Protected Attributes inherited from CeresEngine::RenderTask
RenderTaskResourceUsage mResourceUsage
 

Constructor & Destructor Documentation

◆ PropagateRadianceRenderTask()

CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::PropagateRadianceRenderTask ( RenderGraph renderGraph,
Renderer renderer,
RendererCamera camera,
const Settings settings,
bool  shouldClear = true 
)
explicit

◆ ~PropagateRadianceRenderTask()

CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::~PropagateRadianceRenderTask ( )
final

Member Function Documentation

◆ compile()

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

Compiles the render task.

Implements CeresEngine::RenderTask.

◆ createComputePipeline()

GPUComputePipelinePtr CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::createComputePipeline ( GPUDevice device)
finalprotectedvirtual

Creates a new compute pipeline instance for the render task.

Parameters
deviceThe device in which the implementation should create the compute pipeline instance from.

Implements CeresEngine::SimpleComputeRenderTask.

◆ execute() [1/2]

void CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::execute ( RenderGraphContext context,
GPUCommandBuffer commandBuffer 
)
finalprotectedvirtual

◆ execute() [2/2]

void CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::execute ( RenderGraphContext context,
GPUCommandBuffer commandBuffer,
GPUComputePipeline pipeline 
)
finalprotectedvirtual

◆ initialize()

void CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::initialize ( GPUDevice device)
finalprotectedvirtual

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

These operations are only executed once in the first execution.

Reimplemented from CeresEngine::SimpleComputeRenderTask.

Member Data Documentation

◆ albedo

ImageRenderResourceRef CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::albedo

◆ [struct]

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

◆ mCamera

RendererCamera& CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::mCamera
private

◆ mRenderer

Renderer& CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::mRenderer
private

◆ mSampler

GPUSamplerPtr CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::mSampler
private

A sampler used to sample voxels from the radiance voxel map.

◆ mSettings

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

◆ mShouldClear

bool CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::mShouldClear
private

◆ normal

ImageRenderResourceRef CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::normal

◆ [struct]

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

◆ voxel

ImageRenderResourceRef CeresEngine::VoxelConeTracing::PropagateRadianceRenderTask::voxel

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