CeresEngine::GLShaderProgram Class Reference

#include <CeresEngine/RenderAPI/OpenGL/GLShader.hpp>

Inheritance diagram for CeresEngine::GLShaderProgram:

Public Member Functions
	GLShaderProgram (GLDevicePtr device, const GPUShaderProgramDescriptor &descriptor)
	~GLShaderProgram () final
GPUPipelineLayoutPtr	getPipelineLayout () const override
	The pipeline layout deduced for this shader program.
void	activate (GLCommandBuffer &commandBuffer) const
	Activates the shader for rendering in OpenGL.
GLuint	handle () const
Public Member Functions inherited from CeresEngine::GPUShaderProgram
	GPUShaderProgram (GPUDevice &device, const Descriptor &descriptor, const GPUShaderReflectionDescriptor &reflection)
	Initializes a new ShaderProgram object instance.
	GPUShaderProgram (const GPUShaderProgram &)=delete
	Deleted copy constructor.
GPUShaderProgram &	operator= (const GPUShaderProgram &)=delete
	GPUShaderProgram (GPUShaderProgram &&)=delete
	Deleted move constructor.
GPUShaderProgram &	operator= (GPUShaderProgram &&)=delete
const GPUShaderReflectionDescriptor &	reflect () const
	Extracts reflection information from the shader.
	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< GPUShaderProgramDescriptor >
	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.

Private Attributes
const GPUShaderProgramDescriptor	descriptorGL
	A structure that describes the shader program and it's properties.
GLObjectHandle<&glad_glCreateProgram, &glad_glDeleteProgram, false >	programID {}
	The OpenGL shader program object.
GPUShaderProgramDescriptor	mDescriptor
	The shader descriptor.
GPUShaderReflectionDescriptor	mReflectionDescriptor
	The shader reflection descriptor.
GLPipelineLayoutPtr	mPipelineLayout = nullptr
	The pipeline layout for this shader program.

Additional Inherited Members
Public Types inherited from CeresEngine::TDeviceObject< GPUShaderProgramDescriptor >
using	Descriptor = GPUShaderProgramDescriptor
	An type-alias to the descriptor struct type.
Static Public Member Functions inherited from CeresEngine::GLObject< ChildTypeName, ParentType >
static RC< ChildTypeName >	cast (const RC< ParentType > &ptr)
	Casts a RC containing a ParentType pointer to a pointer to a pointer to a ChildTypeName.
static RC< ChildTypeName >	safeCast (const RC< ParentType > &ptr)
	Safely casts a RC containing a ParentType pointer to a pointer to a pointer to a ChildTypeName.
static ChildTypeName &	cast (ParentType &object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static const ChildTypeName &	cast (const ParentType &object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static ChildTypeName *	cast (ParentType *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static const ChildTypeName *	cast (const ParentType *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static ChildTypeName *	safeCast (ParentType *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static const ChildTypeName *	safeCast (const ParentType *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
Public Attributes inherited from CeresEngine::GPUShaderProgram
const GPUShaderReflectionDescriptor &	reflection
	The shader reflection descriptor.
Public Attributes inherited from CeresEngine::TDeviceObject< GPUShaderProgramDescriptor >
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.
Protected Member Functions inherited from CeresEngine::GLDeviceObject< GLShaderProgram, GPUShaderProgram >
	GLDeviceObject (GLDevicePtr device)
	Creates a new GLDeviceObject from the given device.
Protected Attributes inherited from CeresEngine::GLDeviceObject< GLShaderProgram, GPUShaderProgram >
GLDevice &	deviceGL
	The owning GLDevice instance.

Constructor & Destructor Documentation

GLShaderProgram()

CeresEngine::GLShaderProgram::GLShaderProgram	(	GLDevicePtr	device,
		const GPUShaderProgramDescriptor &	descriptor
	)

~GLShaderProgram()

CeresEngine::GLShaderProgram::~GLShaderProgram ( )

final

Member Function Documentation

activate()

void CeresEngine::GLShaderProgram::activate

(

GLCommandBuffer &

commandBuffer

)

const

Activates the shader for rendering in OpenGL.

getPipelineLayout()

GPUPipelineLayoutPtr CeresEngine::GLShaderProgram::getPipelineLayout ( ) const

inlineoverridevirtual

The pipeline layout deduced for this shader program.

Will be used if the user doesn't provide another when creating a new pipeline.

Can be null if the shader doesn't have any reflection metadata to create a pipeline layout for the program.

Implements CeresEngine::GPUShaderProgram.

handle()

GLuint CeresEngine::GLShaderProgram::handle ( ) const

inline

Returns

The OpenGL object handle

Member Data Documentation

descriptorGL

const GPUShaderProgramDescriptor CeresEngine::GLShaderProgram::descriptorGL

private

A structure that describes the shader program and it's properties.

mDescriptor

GPUShaderProgramDescriptor CeresEngine::GLShaderProgram::mDescriptor

private

The shader descriptor.

mPipelineLayout

GLPipelineLayoutPtr CeresEngine::GLShaderProgram::mPipelineLayout = nullptr

private

The pipeline layout for this shader program.

Will be used in-case the user doesn't provide another when creating a new pipeline.

mReflectionDescriptor

GPUShaderReflectionDescriptor CeresEngine::GLShaderProgram::mReflectionDescriptor

private

The shader reflection descriptor.

programID

GLObjectHandle<& glad_glCreateProgram , & glad_glDeleteProgram , false> CeresEngine::GLShaderProgram::programID {}

private

The OpenGL shader program object.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/OpenGL/GLShader.hpp