CeresEngine::VKShader Class Reference

#include <CeresEngine/RenderAPI/Vulkan/VKShader.hpp>

Inheritance diagram for CeresEngine::VKShader:

Public Types
using	Allocator = VKObjectAllocator
	An allocator type used to allocate new VKShader instances from a memory pool.
Public Types inherited from CeresEngine::TDeviceObject< GPUShaderDescriptor >
using	Descriptor = GPUShaderDescriptor
	An type-alias to the descriptor struct type.

Public Member Functions
	VKShader (VKDevice &device, const GPUShaderDescriptor &descriptor)
	~VKShader () final
void	destroy () noexcept final
Public Member Functions inherited from CeresEngine::GPUShader
	GPUShader (GPUDevice &device, const Descriptor &descriptor, const GPUShaderReflectionDescriptor &reflection)
	Initializes a new Shader object instance.
	GPUShader (const GPUShader &)=delete
	Deleted copy constructor.
GPUShader &	operator= (const GPUShader &)=delete
	GPUShader (GPUShader &&)=delete
	Deleted move constructor.
GPUShader &	operator= (GPUShader &&)=delete
const GPUShaderReflectionDescriptor &	reflect () const
	Extracts reflection information from the shader.
Public Member Functions inherited from CeresEngine::TDeviceObject< GPUShaderDescriptor >
	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.
Public Member Functions inherited from CeresEngine::VKDeviceObjectBase
	VKDeviceObjectBase (VKDevice &device) noexcept
	Creates a new VKDeviceObjectBase from the given device.
	~VKDeviceObjectBase () noexcept
	Destroys the VKDeviceObjectBase.

Static Public Member Functions
static Allocator &	getAllocator () noexcept
	Returns the allocator for VKShader.
static void *	operator new (size_t size) noexcept
	Allocates memory for a new instance of VKShader.
static void	operator delete (void *p, std::size_t size) noexcept
	Deletes memory for an instance of VKShader.
Static Public Member Functions inherited from CeresEngine::VKObject< 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 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 Public Member Functions inherited from CeresEngine::VKObjectBase
static void *	operator new (size_t size) noexcept
static void	operator delete (void *p, std::size_t sz) noexcept

Private Attributes
const GPUShaderDescriptor	descriptorVK
	A structure that describes the shader and it's properties.
VkShaderModule	mShaderModule = VK_NULL_HANDLE
	The Vulkan shader module object.
ShaderType	mType
	The shader type.
GPUShaderReflectionDescriptor	mReflectionDescriptor
	The shader reflection descriptor.

Friends
class	VKShaderProgram

Additional Inherited Members
Public Attributes inherited from CeresEngine::GPUShader
const GPUShaderReflectionDescriptor &	reflection
	The shader reflection descriptor.
Public Attributes inherited from CeresEngine::TDeviceObject< GPUShaderDescriptor >
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.
Public Attributes inherited from CeresEngine::VKDeviceObjectBase
VKDevice &	deviceVK
	The owning VKDevice instance.
Protected Member Functions inherited from CeresEngine::VKDeviceObject< VKShader, GPUShader >
	VKDeviceObject (VKDevice &device) noexcept
	Creates a new VKDeviceObject from the given device.

Member Typedef Documentation

Allocator

using CeresEngine::VKShader::Allocator = VKObjectAllocator

An allocator type used to allocate new VKShader instances from a memory pool.

Constructor & Destructor Documentation

VKShader()

CeresEngine::VKShader::VKShader	(	VKDevice &	device,
		const GPUShaderDescriptor &	descriptor
	)

~VKShader()

CeresEngine::VKShader::~VKShader ( )

final

Member Function Documentation

destroy()

void CeresEngine::VKShader::destroy ( )

finalvirtualnoexcept

Reimplemented from CeresEngine::GPUObject.

getAllocator()

static Allocator & CeresEngine::VKShader::getAllocator ( )

staticnoexcept

Returns the allocator for VKShader.

operator delete()

static void CeresEngine::VKShader::operator delete ( void *  p, std::size_t  size  )

staticnoexcept

Deletes memory for an instance of VKShader.

operator new()

static void * CeresEngine::VKShader::operator new ( size_t  size )

staticnoexcept

Allocates memory for a new instance of VKShader.

Friends And Related Symbol Documentation

VKShaderProgram

friend class VKShaderProgram

friend

Member Data Documentation

descriptorVK

const GPUShaderDescriptor CeresEngine::VKShader::descriptorVK

private

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

mReflectionDescriptor

GPUShaderReflectionDescriptor CeresEngine::VKShader::mReflectionDescriptor

private

The shader reflection descriptor.

mShaderModule

VkShaderModule CeresEngine::VKShader::mShaderModule = VK_NULL_HANDLE

private

The Vulkan shader module object.

mType

ShaderType CeresEngine::VKShader::mType

private

The shader type.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/Vulkan/VKShader.hpp