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

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

Inheritance diagram for CeresEngine::BasePassRenderTask:
CeresEngine::SimpleGraphicsRenderTask2 CeresEngine::GraphicsRenderTask CeresEngine::RenderTask CeresEngine::RefCounted< RenderTask >

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

 BasePassRenderTask (RenderGraph &renderGraph, RendererScene &scene, RendererView &view, bool loadDepth=false)
 
 ~BasePassRenderTask () final
 
- Public Member Functions inherited from CeresEngine::SimpleGraphicsRenderTask2
 SimpleGraphicsRenderTask2 (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 CeresEngine::BasePassRenderTask::Input input
 
struct CeresEngine::BasePassRenderTask::Output output
 

Protected Member Functions

void compile (RenderTaskCompiler &compiler) final
 Compiles the render task.
 
void execute (RenderGraphContext &context, GPUCommandBuffer &commandBuffer, GPURenderTarget &renderTarget, RendererGraphicsPipeline &graphicsPipeline) final
 
RendererShaderPtr createShader (RendererShaderManager &shaderManager, GPURenderPass &renderPass) final
 Creates a new shader instance for the render task.
 
RendererGraphicsPipelinePtr createGraphicsPipeline (RendererGraphicsPipelineManager &graphicsPipelineManager, RendererShader &shader, GPURenderPass &renderPass) final
 Creates a new graphics pipeline instance for the render task.
 
- Protected Member Functions inherited from CeresEngine::SimpleGraphicsRenderTask2
virtual void initialize (GPUDevice &device)
 Perform a sequence of steps that initialize the graphics render task.
 
virtual bool isShaderDirty (RendererShader &shader, GPURenderPass &renderPass) const
 Checks if the shader is dirty and needs to be recreated.
 
virtual bool isGraphicsPipelineDirty (RendererGraphicsPipeline &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

RendererScenemScene
 
RendererViewmView
 
RendererShaderPtr mRendererShader
 
bool mLoadDepth = false
 If set to true, will try to load the depth data rather than clear it.
 

Additional Inherited Members

- Protected Attributes inherited from CeresEngine::SimpleGraphicsRenderTask2
RendererShaderPtr mShader
 The cached graphics pipeline instance.
 
RendererGraphicsPipelinePtr 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

◆ BasePassRenderTask()

CeresEngine::BasePassRenderTask::BasePassRenderTask ( RenderGraph renderGraph,
RendererScene scene,
RendererView view,
bool  loadDepth = false 
)

◆ ~BasePassRenderTask()

CeresEngine::BasePassRenderTask::~BasePassRenderTask ( )
final

Member Function Documentation

◆ compile()

void CeresEngine::BasePassRenderTask::compile ( RenderTaskCompiler compiler)
finalprotectedvirtual

Compiles the render task.

Implements CeresEngine::RenderTask.

◆ createGraphicsPipeline()

RendererGraphicsPipelinePtr CeresEngine::BasePassRenderTask::createGraphicsPipeline ( RendererGraphicsPipelineManager graphicsPipelineManager,
RendererShader shader,
GPURenderPass renderPass 
)
finalprotectedvirtual

Creates a new graphics pipeline instance for the render task.

Parameters
graphicsPipelineManagerThe manager to be used when creating a new pipeline.
renderPassA reference to the current render pass. The implementation must use this render pass to create the new graphics pipeline.

Implements CeresEngine::SimpleGraphicsRenderTask2.

◆ createShader()

RendererShaderPtr CeresEngine::BasePassRenderTask::createShader ( RendererShaderManager shaderManager,
GPURenderPass renderPass 
)
finalprotectedvirtual

Creates a new shader instance for the render task.

Parameters
shaderManagerThe manager to be used when creating a new shader.
renderPassA reference to the current render pass. The implementation must use this render pass to create the new shader.

Implements CeresEngine::SimpleGraphicsRenderTask2.

◆ execute()

void CeresEngine::BasePassRenderTask::execute ( RenderGraphContext context,
GPUCommandBuffer commandBuffer,
GPURenderTarget renderTarget,
RendererGraphicsPipeline graphicsPipeline 
)
finalprotectedvirtual

Member Data Documentation

◆ input

struct CeresEngine::BasePassRenderTask::Input CeresEngine::BasePassRenderTask::input

◆ mLoadDepth

bool CeresEngine::BasePassRenderTask::mLoadDepth = false
private

If set to true, will try to load the depth data rather than clear it.

◆ mRendererShader

RendererShaderPtr CeresEngine::BasePassRenderTask::mRendererShader
private

◆ mScene

RendererScene& CeresEngine::BasePassRenderTask::mScene
private

◆ mView

RendererView& CeresEngine::BasePassRenderTask::mView
private

◆ output

struct CeresEngine::BasePassRenderTask::Output CeresEngine::BasePassRenderTask::output

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