CeresEngine::GPUComputePipeline Class Reference

#include <CeresEngine/RenderAPI/GPUComputePipeline.hpp>

Inheritance diagram for CeresEngine::GPUComputePipeline:

Classes
class	Scope
	A helper class that begins a scoped compute pipeline recording. More...

Public Member Functions
	GPUComputePipeline (const GPUComputePipeline &)=delete
	Deleted copy constructor.
GPUComputePipeline &	operator= (const GPUComputePipeline &)=delete
	GPUComputePipeline (GPUComputePipeline &&)=delete
	Deleted move constructor.
GPUComputePipeline &	operator= (GPUComputePipeline &&)=delete
virtual GPUResourceSetPtr	createResourceSet (const GPUResourceSetDescriptor &descriptor)=0
	Creates a new ResourceSet for the given ComputePipeline.
virtual void	begin (GPUCommandBuffer &commandBuffer)=0
	Prepares the pipeline for execution.
virtual void	end (GPUCommandBuffer &commandBuffer)=0
	Finishes the pipeline execution.
template<typename Func , typename... Args>
decltype(auto)	with (GPUCommandBuffer &commandBuffer, Func &&func, Args &&... args)
	Prepares the pipeline for execution.
	TDeviceObject (GPUDevice &device, const Descriptor &descriptor)
	Inherited constructors.
	TDeviceObject (const TDeviceObject &)=delete
	Inherited constructors.
	TDeviceObject (TDeviceObject &&)=delete
	Inherited constructors.
Public Member Functions inherited from CeresEngine::TDeviceObject< GPUComputePipelineDescriptor >
	TDeviceObject (GPUDevice &device, const Descriptor &descriptor)
	Initializes a new RenderAPI device object instance.
	TDeviceObject (const TDeviceObject &)=delete
	TDeviceObject (TDeviceObject &&)=delete
	~TDeviceObject () override=default
TDeviceObject &	operator= (const TDeviceObject &)=delete
TDeviceObject &	operator= (TDeviceObject &&)=delete
Public Member Functions inherited from CeresEngine::GPUDeviceObject
	GPUDeviceObject (GPUDevice &device)
	~GPUDeviceObject () override
Public Member Functions inherited from CeresEngine::GPUObject
	GPUObject ()=default
virtual	~GPUObject ()=default
	GPUObject (const GPUObject &)=delete
GPUObject &	operator= (const GPUObject &)=delete
	GPUObject (GPUObject &&)=delete
GPUObject &	operator= (GPUObject &&)=delete
void	retain () noexcept
	Retains the object by increment it's reference count by one.
bool	release () noexcept
	Releases the object by decrementing it's reference count by one.

Additional Inherited Members
Public Types inherited from CeresEngine::TDeviceObject< GPUComputePipelineDescriptor >
using	Descriptor = GPUComputePipelineDescriptor
	An type-alias to the descriptor struct type.
Public Attributes inherited from CeresEngine::TDeviceObject< GPUComputePipelineDescriptor >
const Descriptor &	descriptor
	A structure that describes the object and it's properties.
Public Attributes inherited from CeresEngine::GPUDeviceObject
GPUDevice &	device
	The owning device this object was created from.
Protected Member Functions inherited from CeresEngine::GPUObject
virtual void	destroy () noexcept
	A internal method called by the system when the object reference count reaches zero.

Constructor & Destructor Documentation

GPUComputePipeline() [1/2]

CeresEngine::GPUComputePipeline::GPUComputePipeline ( const GPUComputePipeline &  )

delete

Deleted copy constructor.

GPUComputePipeline() [2/2]

CeresEngine::GPUComputePipeline::GPUComputePipeline ( GPUComputePipeline &&  )

delete

Deleted move constructor.

Member Function Documentation

begin()

virtual void CeresEngine::GPUComputePipeline::begin ( GPUCommandBuffer &  commandBuffer )

pure virtual

Prepares the pipeline for execution.

Implemented in CeresEngine::MTComputePipeline, CeresEngine::MKComputePipeline, CeresEngine::NLComputePipeline, CeresEngine::GLComputePipeline, CeresEngine::VKComputePipeline, and CeresEngine::WGComputePipeline.

createResourceSet()

virtual GPUResourceSetPtr CeresEngine::GPUComputePipeline::createResourceSet ( const GPUResourceSetDescriptor &  descriptor )

pure virtual

Creates a new ResourceSet for the given ComputePipeline.

Parameters

descriptor

The descriptor that describes the resources bound to the resource set.

Returns

A newly created ResourceSet.

Implemented in CeresEngine::MTComputePipeline, CeresEngine::MKComputePipeline, CeresEngine::NLComputePipeline, CeresEngine::GLComputePipeline, CeresEngine::VKComputePipeline, and CeresEngine::WGComputePipeline.

end()

virtual void CeresEngine::GPUComputePipeline::end ( GPUCommandBuffer &  commandBuffer )

pure virtual

Finishes the pipeline execution.

Implemented in CeresEngine::MTComputePipeline, CeresEngine::MKComputePipeline, CeresEngine::NLComputePipeline, CeresEngine::GLComputePipeline, CeresEngine::VKComputePipeline, and CeresEngine::WGComputePipeline.

operator=() [1/2]

GPUComputePipeline & CeresEngine::GPUComputePipeline::operator= ( const GPUComputePipeline &  )

delete

operator=() [2/2]

GPUComputePipeline & CeresEngine::GPUComputePipeline::operator= ( GPUComputePipeline &&  )

delete

TDeviceObject() [1/3]

CeresEngine::TDeviceObject< TDescriptor, TParent >::TDeviceObject ( const TDeviceObject &  )

delete

Inherited constructors.

TDeviceObject() [2/3]

CeresEngine::TDeviceObject< TDescriptor, TParent >::TDeviceObject ( GPUDevice &  device, const Descriptor &  descriptor  )

inlineexplicit

Inherited constructors.

TDeviceObject() [3/3]

CeresEngine::TDeviceObject< TDescriptor, TParent >::TDeviceObject ( TDeviceObject &&  )

delete

Inherited constructors.

with()

template<typename Func , typename... Args>

decltype(auto) CeresEngine::GPUComputePipeline::with ( GPUCommandBuffer &  commandBuffer, Func &&  func, Args &&...  args  )

inline

Prepares the pipeline for execution.

When ready, the renderer must call func() so that the user can fill the command buffer within the scope of execution of the pipeline.

Parameters

commandBuffer	The command buffer responsible for queuing rendering commands.
func	The rendering block.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/GPUComputePipeline.hpp