CeresEngine::RenderAPI Class Reference

#include <CeresEngine/RenderAPI/RenderAPI.hpp>

Inheritance diagram for CeresEngine::RenderAPI:

Public Member Functions
	RenderAPI ()=default
	Default initializer.
virtual	~RenderAPI ()=default
	Destroys the renderer object.
	RenderAPI (const RenderAPI &)=delete
	Deleted copy constructor.
RenderAPI &	operator= (const RenderAPI &)=delete
	RenderAPI (RenderAPI &&)=delete
	Deleted move constructor.
RenderAPI &	operator= (RenderAPI &&)=delete
virtual GPUDevicePtr	createDevice (const GPUDeviceDescriptor &descriptor, const DevicePickerFunc &pickerFunc=nullptr)=0
	Creates a new Device object.
virtual GPUDevicePtr	getDefaultDevice ()=0
virtual void	update ()=0
	An update method that must be called on the beginning of very frame to finish command buffers in execution.

Constructor & Destructor Documentation

RenderAPI() [1/3]

CeresEngine::RenderAPI::RenderAPI ( )

default

Default initializer.

~RenderAPI()

virtual CeresEngine::RenderAPI::~RenderAPI ( )

virtualdefault

Destroys the renderer object.

RenderAPI() [2/3]

CeresEngine::RenderAPI::RenderAPI ( const RenderAPI &  )

delete

Deleted copy constructor.

RenderAPI() [3/3]

CeresEngine::RenderAPI::RenderAPI ( RenderAPI &&  )

delete

Deleted move constructor.

Member Function Documentation

createDevice()

virtual GPUDevicePtr CeresEngine::RenderAPI::createDevice ( const GPUDeviceDescriptor &  descriptor, const DevicePickerFunc &  pickerFunc = nullptr  )

pure virtual

Creates a new Device object.

Parameters

descriptor	A structure that describes the object to be created
pickerFunc	A functor that picks a device based on its info and capabilities.

Returns

The created Device object.

Implemented in CeresEngine::MTRenderAPI, CeresEngine::MKRenderAPI, CeresEngine::NLRenderAPI, CeresEngine::GLRenderAPI, CeresEngine::VKRenderAPI, and CeresEngine::WGRenderAPI.

getDefaultDevice()

virtual GPUDevicePtr CeresEngine::RenderAPI::getDefaultDevice ( )

pure virtual

Returns

The default rendering device

Implemented in CeresEngine::MTRenderAPI, CeresEngine::MKRenderAPI, CeresEngine::NLRenderAPI, CeresEngine::GLRenderAPI, CeresEngine::VKRenderAPI, and CeresEngine::WGRenderAPI.

operator=() [1/2]

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

delete

operator=() [2/2]

RenderAPI & CeresEngine::RenderAPI::operator= ( RenderAPI &&  )

delete

update()

virtual void CeresEngine::RenderAPI::update ( )

pure virtual

An update method that must be called on the beginning of very frame to finish command buffers in execution.

Implemented in CeresEngine::MTRenderAPI, CeresEngine::MKRenderAPI, CeresEngine::NLRenderAPI, CeresEngine::GLRenderAPI, CeresEngine::VKRenderAPI, and CeresEngine::WGRenderAPI.

---

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

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