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

Null RenderAPI graphics pipeline object. More...

#include <CeresEngine/RenderAPI/Null/NLGraphicsPipeline.hpp>

Inheritance diagram for CeresEngine::NLGraphicsPipeline:
CeresEngine::GPUGraphicsPipeline CeresEngine::NLDeviceObject< NLGraphicsPipeline, GPUGraphicsPipeline > CeresEngine::TDeviceObject< GPUGraphicsPipelineDescriptor > CeresEngine::NLObject< ChildTypeName, ParentType > CeresEngine::GPUDeviceObject CeresEngine::GPUObject

Public Member Functions

 NLGraphicsPipeline (NLDevicePtr device, const GPUGraphicsPipelineDescriptor &descriptor)
 
 ~NLGraphicsPipeline () final
 
GPUResourceSetPtr createResourceSet (const GPUResourceSetDescriptor &descriptor, UInt32 set=0) final
 
void begin (GPUCommandBuffer &commandBuffer) final
 
void end (GPUCommandBuffer &commandBuffer) final
 
- Public Member Functions inherited from CeresEngine::GPUGraphicsPipeline
 GPUGraphicsPipeline (const GPUGraphicsPipeline &)=delete
 Deleted copy constructor.
 
GPUGraphicsPipelineoperator= (const GPUGraphicsPipeline &)=delete
 
 GPUGraphicsPipeline (GPUGraphicsPipeline &&)=delete
 Deleted move constructor.
 
GPUGraphicsPipelineoperator= (GPUGraphicsPipeline &&)=delete
 
template<typename Func , typename... Args>
decltype(autowith (GPUCommandBuffer &commandBuffer, Func &&func)
 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< GPUGraphicsPipelineDescriptor >
 TDeviceObject (GPUDevice &device, const Descriptor &descriptor)
 Initializes a new RenderAPI device object instance.
 
 TDeviceObject (const TDeviceObject &)=delete
 
 TDeviceObject (TDeviceObject &&)=delete
 
 ~TDeviceObject () override=default
 
TDeviceObjectoperator= (const TDeviceObject &)=delete
 
TDeviceObjectoperator= (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
 
GPUObjectoperator= (const GPUObject &)=delete
 
 GPUObject (GPUObject &&)=delete
 
GPUObjectoperator= (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.
 

Private Attributes

const GPUGraphicsPipelineDescriptor mDescriptor
 A object that describes the graphics pipeline object.
 
NLRenderPassPtr mRenderPass
 The Null render pass.
 
NLPipelineLayoutPtr mPipelineLayout
 The Null pipeline layout.
 
NLShaderProgramPtr mShaderProgram
 A vector of all pipelines stages in the pipeline.
 

Additional Inherited Members

- Public Types inherited from CeresEngine::TDeviceObject< GPUGraphicsPipelineDescriptor >
using Descriptor = GPUGraphicsPipelineDescriptor
 An type-alias to the descriptor struct type.
 
- Static Public Member Functions inherited from CeresEngine::NLObject< ChildTypeName, ParentType >
static RC< ChildTypeNamecast (const RC< ParentType > &ptr)
 Casts a RC containing a ParentType pointer to a pointer to a pointer to a ChildTypeName.
 
static RC< ChildTypeNamesafeCast (const RC< ParentType > &ptr)
 Safely casts a RC containing a ParentType pointer to a pointer to a pointer to a ChildTypeName.
 
static ChildTypeNamecast (ParentType &object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
static const ChildTypeNamecast (const ParentType &object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
static ChildTypeNamecast (ParentType *object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
static const ChildTypeNamecast (const ParentType *object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
static ChildTypeNamesafeCast (ParentType *object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
static const ChildTypeNamesafeCast (const ParentType *object)
 Casts a object of type ParentType to a object of type ChildTypeName.
 
- Public Attributes inherited from CeresEngine::TDeviceObject< GPUGraphicsPipelineDescriptor >
const Descriptordescriptor
 A structure that describes the object and it's properties.
 
- Public Attributes inherited from CeresEngine::GPUDeviceObject
GPUDevicedevice
 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.
 
- Protected Member Functions inherited from CeresEngine::NLDeviceObject< NLGraphicsPipeline, GPUGraphicsPipeline >
 NLDeviceObject (NLDevicePtr device)
 Creates a new NLDeviceObject from the given device.
 
- Protected Attributes inherited from CeresEngine::NLDeviceObject< NLGraphicsPipeline, GPUGraphicsPipeline >
NLDevicedeviceNL
 The owning NLDevice instance.
 

Detailed Description

Null RenderAPI graphics pipeline object.

Constructor & Destructor Documentation

◆ NLGraphicsPipeline()

CeresEngine::NLGraphicsPipeline::NLGraphicsPipeline ( NLDevicePtr  device,
const GPUGraphicsPipelineDescriptor descriptor 
)

◆ ~NLGraphicsPipeline()

CeresEngine::NLGraphicsPipeline::~NLGraphicsPipeline ( )
final

Member Function Documentation

◆ begin()

void CeresEngine::NLGraphicsPipeline::begin ( GPUCommandBuffer commandBuffer)
finalvirtual

◆ createResourceSet()

GPUResourceSetPtr CeresEngine::NLGraphicsPipeline::createResourceSet ( const GPUResourceSetDescriptor descriptor,
UInt32  set = 0 
)
finalvirtual

◆ end()

void CeresEngine::NLGraphicsPipeline::end ( GPUCommandBuffer commandBuffer)
finalvirtual

Member Data Documentation

◆ mDescriptor

const GPUGraphicsPipelineDescriptor CeresEngine::NLGraphicsPipeline::mDescriptor
private

A object that describes the graphics pipeline object.

◆ mPipelineLayout

NLPipelineLayoutPtr CeresEngine::NLGraphicsPipeline::mPipelineLayout
private

The Null pipeline layout.

◆ mRenderPass

NLRenderPassPtr CeresEngine::NLGraphicsPipeline::mRenderPass
private

The Null render pass.

◆ mShaderProgram

NLShaderProgramPtr CeresEngine::NLGraphicsPipeline::mShaderProgram
private

A vector of all pipelines stages in the pipeline.


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