CeresEngine::VKResourceSet Class Reference

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

Inheritance diagram for CeresEngine::VKResourceSet:

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

Public Member Functions
	VKResourceSet (VKPipelineLayout &pipelineLayout, const GPUResourceSetDescriptor &descriptor, UInt32 set=0)
	~VKResourceSet () final
void	destroy () noexcept final
	operator VkDescriptorSet () const noexcept
	The pipeline layout used to create and allocate the ResourceSet object.
Public Member Functions inherited from CeresEngine::GPUResourceSet
	GPUResourceSet (GPUPipelineLayout &pipelineLayout, const GPUResourceSetDescriptor &descriptor)
	Default initializer.
	~GPUResourceSet () override
	Destroys the resource set object.
	GPUResourceSet (const GPUResourceSet &)=delete
	Deleted copy constructor.
GPUResourceSet &	operator= (const GPUResourceSet &)=delete
	GPUResourceSet (GPUResourceSet &&)=delete
	Deleted move constructor.
GPUResourceSet &	operator= (GPUResourceSet &&)=delete
Public Member Functions inherited from CeresEngine::TDeviceObject< GPUResourceSetDescriptor >
	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 VKResourceSet.
static void *	operator new (size_t size) noexcept
	Allocates memory for a new instance of VKResourceSet.
static void	operator delete (void *p, std::size_t sz) noexcept
	Deletes memory for an instance of VKResourceSet.
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
VkDescriptorSet	mDescriptorSet = {VK_NULL_HANDLE}
	The Vulkan ResourceSet object.
GPUResourceSetDescriptor	mDescriptor
	The descriptors holding the data for the ResourceSet.
VKPipelineLayoutPtr	mPipelineLayout
	The pipeline layout used to create and allocate the ResourceSet object.
SmallVector< VKImageViewPtr, 16, VKAllocator >	mImageViews {gVKAllocator()}
	The image views used by the resource set.
UInt32	mSet

Additional Inherited Members
Public Attributes inherited from CeresEngine::GPUResourceSet
GPUPipelineLayout &	pipelineLayout
	The owning pipeline layout object this ResourceSet was created from.
Public Attributes inherited from CeresEngine::TDeviceObject< GPUResourceSetDescriptor >
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< VKResourceSet, GPUResourceSet >
	VKDeviceObject (VKDevice &device) noexcept
	Creates a new VKDeviceObject from the given device.

Member Typedef Documentation

Allocator

using CeresEngine::VKResourceSet::Allocator = VKObjectAllocator

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

Constructor & Destructor Documentation

VKResourceSet()

CeresEngine::VKResourceSet::VKResourceSet	(	VKPipelineLayout &	pipelineLayout,
		const GPUResourceSetDescriptor &	descriptor,
		UInt32	set = 0
	)

~VKResourceSet()

CeresEngine::VKResourceSet::~VKResourceSet ( )

final

Member Function Documentation

destroy()

void CeresEngine::VKResourceSet::destroy ( )

finalvirtualnoexcept

Reimplemented from CeresEngine::GPUObject.

getAllocator()

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

staticnoexcept

Returns the allocator for VKResourceSet.

operator delete()

static void CeresEngine::VKResourceSet::operator delete ( void *  p, std::size_t  sz  )

staticnoexcept

Deletes memory for an instance of VKResourceSet.

operator new()

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

staticnoexcept

Allocates memory for a new instance of VKResourceSet.

operator VkDescriptorSet()

CeresEngine::VKResourceSet::operator VkDescriptorSet ( ) const

inlinenoexcept

The pipeline layout used to create and allocate the ResourceSet object.

Member Data Documentation

mDescriptor

GPUResourceSetDescriptor CeresEngine::VKResourceSet::mDescriptor

private

The descriptors holding the data for the ResourceSet.

mDescriptorSet

VkDescriptorSet CeresEngine::VKResourceSet::mDescriptorSet = {VK_NULL_HANDLE}

private

The Vulkan ResourceSet object.

mImageViews

SmallVector<VKImageViewPtr, 16, VKAllocator> CeresEngine::VKResourceSet::mImageViews {gVKAllocator()}

private

The image views used by the resource set.

mPipelineLayout

VKPipelineLayoutPtr CeresEngine::VKResourceSet::mPipelineLayout

private

The pipeline layout used to create and allocate the ResourceSet object.

mSet

UInt32 CeresEngine::VKResourceSet::mSet

private

---

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

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