Nebula
Loading...
Searching...
No Matches
Base::TextRendererBase Class Reference

#include <textrendererbase.h>

Detailed Description

Base class for text rendering (don't use this for high-quality text rendering).

Inherits Core::RefCounted.

Inherited by Vulkan::VkTextRenderer.

Public Member Functions

 TextRendererBase ()
 constructor
virtual ~TextRendererBase ()
 destructor
void Open ()
 open the the text renderer
void Close ()
 close the text renderer
bool IsOpen () const
 check if text renderer open
void DrawTextElements ()
 draw the accumulated text
void DeleteTextElementsByThreadId (Threading::ThreadId threadId)
 delete added text by thread id
void AddTextElement (const CoreGraphics::TextElement &textElement)
 add text element for rendering
void AddTextElements (const Util::Array< CoreGraphics::TextElement > &textElement)
 add multiple text elements for rendering
Public Member Functions inherited from Core::RefCounted
 RefCounted ()
 constructor
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Protected Attributes

Util::Array< CoreGraphics::TextElementtextElements
bool isOpen

Private Member Functions

 __DeclareClass (TextRendererBase)
 __DeclareSingleton (TextRendererBase)

Additional Inherited Members

Static Public Member Functions inherited from Core::RefCounted
static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual ~RefCounted ()
 destructor (called when refcount reaches zero)

Constructor & Destructor Documentation

◆ TextRendererBase()

Base::TextRendererBase::TextRendererBase ( )

constructor

◆ ~TextRendererBase()

Base::TextRendererBase::~TextRendererBase ( )
virtual

destructor

Member Function Documentation

◆ __DeclareClass()

Base::TextRendererBase::__DeclareClass ( TextRendererBase )
private

◆ __DeclareSingleton()

Base::TextRendererBase::__DeclareSingleton ( TextRendererBase )
private

◆ AddTextElement()

void Base::TextRendererBase::AddTextElement ( const CoreGraphics::TextElement & textElement)

add text element for rendering

◆ AddTextElements()

void Base::TextRendererBase::AddTextElements ( const Util::Array< CoreGraphics::TextElement > & textElement)

add multiple text elements for rendering

◆ Close()

void Base::TextRendererBase::Close ( )

close the text renderer

◆ DeleteTextElementsByThreadId()

void Base::TextRendererBase::DeleteTextElementsByThreadId ( Threading::ThreadId threadId)

delete added text by thread id

◆ DrawTextElements()

void Base::TextRendererBase::DrawTextElements ( )

draw the accumulated text

◆ IsOpen()

bool Base::TextRendererBase::IsOpen ( ) const
inline

check if text renderer open

◆ Open()

void Base::TextRendererBase::Open ( )

open the the text renderer

Member Data Documentation

◆ isOpen

bool Base::TextRendererBase::isOpen
protected

◆ textElements

Util::Array<CoreGraphics::TextElement> Base::TextRendererBase::textElements
protected

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