CeresEngine::UIBackingStore Class Reference

The BackingStore represents store for a window or view. More...

#include <CeresEngine/UI/UIBackingStore.hpp>

Inheritance diagram for CeresEngine::UIBackingStore:

Public Member Functions
	UIBackingStore ()=default
virtual	~UIBackingStore () noexcept=default
virtual Extent2UI	getSize () const =0
virtual void	setSize (const Extent2UI &size)=0
virtual bool	isAntiAliasing () const noexcept=0
virtual void	setAntiAliasing (bool antiAliasing)=0
virtual Optional< UInt32 >	getSampleCount () const noexcept=0
virtual void	setSampleCount (const Optional< UInt32 > &sampleCount)=0
Public Member Functions inherited from CeresEngine::RefCounted< UIBackingStore >
	RefCounted (Args &&... args)
	Creates a new RefCounted object and constructs a new Deleter by forwarding Args to it.
void	retain () noexcept
	Retains the object by increment it's reference count by one.
bool	release () noexcept
	Relases the object by decrementing it's reference count by one.

Friends
class	UIWindow

Detailed Description

The BackingStore represents store for a window or view.

There are multiple implementations available and their behavior differ in performance, memory requirements and functionality of what is possible on the UI.

The Framebuffer implementation is very basic and only renders the contents into a texture, without doing anything further with it. Data is externally available and users can use it once the rendering is done.

Constructor & Destructor Documentation

UIBackingStore()

CeresEngine::UIBackingStore::UIBackingStore ( )

explicitdefault

~UIBackingStore()

virtual CeresEngine::UIBackingStore::~UIBackingStore ( )

virtualdefaultnoexcept

Member Function Documentation

getSampleCount()

virtual Optional< UInt32 > CeresEngine::UIBackingStore::getSampleCount ( ) const

pure virtualnoexcept

Implemented in CeresEngine::UIFramebufferBackingStore.

getSize()

virtual Extent2UI CeresEngine::UIBackingStore::getSize ( ) const

pure virtual

Implemented in CeresEngine::UIFramebufferBackingStore.

isAntiAliasing()

virtual bool CeresEngine::UIBackingStore::isAntiAliasing ( ) const

pure virtualnoexcept

Implemented in CeresEngine::UIFramebufferBackingStore.

setAntiAliasing()

virtual void CeresEngine::UIBackingStore::setAntiAliasing ( bool  antiAliasing )

pure virtual

Implemented in CeresEngine::UIFramebufferBackingStore.

setSampleCount()

virtual void CeresEngine::UIBackingStore::setSampleCount ( const Optional< UInt32 > &  sampleCount )

pure virtual

Implemented in CeresEngine::UIFramebufferBackingStore.

setSize()

virtual void CeresEngine::UIBackingStore::setSize ( const Extent2UI &  size )

pure virtual

Implemented in CeresEngine::UIFramebufferBackingStore.

Friends And Related Symbol Documentation

UIWindow

friend class UIWindow

friend

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/UI/UIBackingStore.hpp