CeresEngine::VKRenderTarget Class Reference

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

Inheritance diagram for CeresEngine::VKRenderTarget:

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

Public Member Functions
	VKRenderTarget (VKDevice &device, const GPURenderTargetDescriptor &descriptor)
	~VKRenderTarget () final
void	destroy () noexcept final
	operator VkFramebuffer () const noexcept
	The Vulkan framebuffer object.
Span< const VKImagePtr >	getImages () const
TExtent2< UInt32 >	getExtent () const
Public Member Functions inherited from CeresEngine::GPURenderTarget
	GPURenderTarget (const GPURenderTarget &)=delete
	Deleted copy constructor.
GPURenderTarget &	operator= (const GPURenderTarget &)=delete
	GPURenderTarget (GPURenderTarget &&)=delete
	Deleted move constructor.
GPURenderTarget &	operator= (GPURenderTarget &&)=delete
	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< GPURenderTargetDescriptor >
	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 VKRenderTarget.
static void *	operator new (size_t size) noexcept
	Allocates memory for a new instance of VKRenderTarget.
static void	operator delete (void *p, std::size_t sz) noexcept
	Deletes memory for an instance of VKRenderTarget.
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 GPURenderTargetDescriptor	descriptorVK
	The descriptor used to create the render target.
VkFramebuffer	mFramebuffer = VK_NULL_HANDLE
	The Vulkan framebuffer object.
SmallVector< VKImageViewPtr, 8, VKAllocator >	mImageViews {gVKAllocator()}
	A reference to the images views attached to the render target.
SmallVector< VKImagePtr, 8, VKAllocator >	mImages {gVKAllocator()}
	A reference to the images attached to the render target.
TExtent2< UInt32 >	mExtent

Additional Inherited Members
Public Attributes inherited from CeresEngine::TDeviceObject< GPURenderTargetDescriptor >
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< VKRenderTarget, GPURenderTarget >
	VKDeviceObject (VKDevice &device) noexcept
	Creates a new VKDeviceObject from the given device.

Member Typedef Documentation

Allocator

using CeresEngine::VKRenderTarget::Allocator = VKObjectAllocator

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

Constructor & Destructor Documentation

VKRenderTarget()

CeresEngine::VKRenderTarget::VKRenderTarget	(	VKDevice &	device,
		const GPURenderTargetDescriptor &	descriptor
	)

~VKRenderTarget()

CeresEngine::VKRenderTarget::~VKRenderTarget ( )

final

Member Function Documentation

destroy()

void CeresEngine::VKRenderTarget::destroy ( )

finalvirtualnoexcept

Reimplemented from CeresEngine::GPUObject.

getAllocator()

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

staticnoexcept

Returns the allocator for VKRenderTarget.

getExtent()

TExtent2< UInt32 > CeresEngine::VKRenderTarget::getExtent ( ) const

inline

getImages()

Span< const VKImagePtr > CeresEngine::VKRenderTarget::getImages ( ) const

inline

Returns

A reference to the images attached to the render target.

operator delete()

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

staticnoexcept

Deletes memory for an instance of VKRenderTarget.

operator new()

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

staticnoexcept

Allocates memory for a new instance of VKRenderTarget.

operator VkFramebuffer()

CeresEngine::VKRenderTarget::operator VkFramebuffer ( ) const

inlinenoexcept

The Vulkan framebuffer object.

Member Data Documentation

descriptorVK

const GPURenderTargetDescriptor CeresEngine::VKRenderTarget::descriptorVK

private

The descriptor used to create the render target.

mExtent

TExtent2<UInt32> CeresEngine::VKRenderTarget::mExtent

private

mFramebuffer

VkFramebuffer CeresEngine::VKRenderTarget::mFramebuffer = VK_NULL_HANDLE

private

The Vulkan framebuffer object.

mImages

SmallVector<VKImagePtr, 8, VKAllocator> CeresEngine::VKRenderTarget::mImages {gVKAllocator()}

private

A reference to the images attached to the render target.

mImageViews

SmallVector<VKImageViewPtr, 8, VKAllocator> CeresEngine::VKRenderTarget::mImageViews {gVKAllocator()}

private

A reference to the images views attached to the render target.

---

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

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