CeresEngine::GPUSwapchain Class Reference

#include <CeresEngine/RenderAPI/GPUSwapchain.hpp>

Inheritance diagram for CeresEngine::GPUSwapchain:

Public Member Functions
	GPUSwapchain (const GPUSwapchain &)=delete
	Deleted copy constructor.
GPUSwapchain &	operator= (const GPUSwapchain &)=delete
	GPUSwapchain (GPUSwapchain &&)=delete
	Deleted move constructor.
GPUSwapchain &	operator= (GPUSwapchain &&)=delete
virtual GPUImagePtr	nextRenderImage ()=0
virtual void	present ()=0
	Presents a image from the getSwapchain. The command buffer that signals.
	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< GPUSwapchainDescriptor >
	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.

Additional Inherited Members
Public Types inherited from CeresEngine::TDeviceObject< GPUSwapchainDescriptor >
using	Descriptor = GPUSwapchainDescriptor
	An type-alias to the descriptor struct type.
Public Attributes inherited from CeresEngine::TDeviceObject< GPUSwapchainDescriptor >
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.

Constructor & Destructor Documentation

GPUSwapchain() [1/2]

CeresEngine::GPUSwapchain::GPUSwapchain ( const GPUSwapchain &  )

delete

Deleted copy constructor.

GPUSwapchain() [2/2]

CeresEngine::GPUSwapchain::GPUSwapchain ( GPUSwapchain &&  )

delete

Deleted move constructor.

Member Function Documentation

nextRenderImage()

virtual GPUImagePtr CeresEngine::GPUSwapchain::nextRenderImage ( )

pure virtual

Returns

The next render image in the getSwapchain

Implemented in CeresEngine::MTSwapchain, CeresEngine::MKSwapchain, CeresEngine::NLSwapchain, CeresEngine::VKSwapchain, and CeresEngine::WGSwapchain.

operator=() [1/2]

GPUSwapchain & CeresEngine::GPUSwapchain::operator= ( const GPUSwapchain &  )

delete

operator=() [2/2]

GPUSwapchain & CeresEngine::GPUSwapchain::operator= ( GPUSwapchain &&  )

delete

present()

virtual void CeresEngine::GPUSwapchain::present ( )

pure virtual

Presents a image from the getSwapchain. The command buffer that signals.

Implemented in CeresEngine::MTSwapchain, CeresEngine::MKSwapchain, CeresEngine::NLSwapchain, CeresEngine::VKSwapchain, and CeresEngine::WGSwapchain.

TDeviceObject() [1/3]

CeresEngine::TDeviceObject< TDescriptor, TParent >::TDeviceObject ( const TDeviceObject &  )

delete

Inherited constructors.

TDeviceObject() [2/3]

CeresEngine::TDeviceObject< TDescriptor, TParent >::TDeviceObject ( GPUDevice &  device, const Descriptor &  descriptor  )

inlineexplicit

Inherited constructors.

TDeviceObject() [3/3]

CeresEngine::TDeviceObject< TDescriptor, TParent >::TDeviceObject ( TDeviceObject &&  )

delete

Inherited constructors.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/GPUSwapchain.hpp