Inheritance diagram for tgui::BackendSFML:

Classes
struct	GuiResources

Public Member Functions
void	setGuiWindow (BackendGui gui, sf::Window window)
	Informs the backend which window belongs to the gui. More...

void	detatchGui (BackendGui *gui) override
	Informs the backend that a gui object is being destroyed. More...

void	setMouseCursorStyle (Cursor::Type type, const std::uint8_t *pixels, Vector2u size, Vector2u hotspot) override
	Changes the look of a certain mouse cursor by using a bitmap. More...

void	resetMouseCursorStyle (Cursor::Type type) override
	Changes the look of a certain mouse cursor back to the system theme. More...

void	setMouseCursor (BackendGui *gui, Cursor::Type type) override
	Changes the mouse cursor when the mouse is on top of the window to which the gui is attached. More...

void	openVirtualKeyboard (const FloatRect &inputRect) override
	Opens the virtual keyboard on Android and iOS. More...

void	closeVirtualKeyboard () override
	Closes the virtual keyboard on Android and iOS. More...

bool	isKeyboardModifierPressed (Event::KeyModifier modifierKey) override
	Checks the state for one of the modifier keys. More...

void	setClipboard (const String &contents) override
	Changes the contents of the clipboard. More...

String	getClipboard () const override
	Returns the contents of the clipboard. More...

Public Member Functions inherited from tgui::Backend
	Backend ()=default
	Default constructor.

	Backend (const Backend &)=delete

Backend &	operator= (const Backend &)=delete

virtual	~Backend ()=default
	Virtual destructor.

void	setDestroyOnLastGuiDetatch (bool destroyOnDetatch)
	Informs the backend whether it should destroy itself when the last Gui is detached from it. More...

virtual void	attachGui (BackendGui *gui)
	Informs the backend that a new gui object has been created. More...

virtual void	detatchGui (BackendGui *gui)
	Informs the backend that a gui object is being destroyed. More...

virtual Font	createDefaultFont ()
	Creates and returns the default font for all widgets. More...

std::shared_ptr< BackendFont >	createFont ()
	Creates a new font object. More...

std::shared_ptr< BackendText >	createText ()
	Creates a new text object. More...

std::shared_ptr< BackendTexture >	createTexture ()
	Creates a new texture object. More...

void	setFontScale (float scale)
	Sets the scale factor to render text at a higher quality, e.g. to scale for DPI awareness. More...

virtual void	setMouseCursorStyle (Cursor::Type type, const std::uint8_t *pixels, Vector2u size, Vector2u hotspot)=0
	Changes the look of a certain mouse cursor by using a bitmap. More...

virtual void	resetMouseCursorStyle (Cursor::Type type)=0
	Changes the look of a certain mouse cursor back to the system theme. More...

virtual void	setMouseCursor (BackendGui *gui, Cursor::Type type)=0
	Changes the mouse cursor when the mouse is on top of the window to which the gui is attached. More...

virtual void	openVirtualKeyboard (const FloatRect &inputRect)
	Opens the virtual keyboard on Android and iOS. More...

virtual void	closeVirtualKeyboard ()
	Closes the virtual keyboard on Android and iOS. More...

virtual bool	isKeyboardModifierPressed (Event::KeyModifier modifierKey)=0
	Checks the state for one of the modifier keys. More...

virtual void	setClipboard (const String &contents)
	Changes the contents of the clipboard. More...

virtual String	getClipboard () const
	Returns the contents of the clipboard. More...

virtual std::unique_ptr< std::uint8_t[]>	readFileFromAndroidAssets (const String &filename, std::size_t &fileSize) const
	Uses the AssetManager on Android to read a file and return its contents. More...

bool	hasRenderer () const
	Checks whether a renderer has been attached to the backend. More...

std::shared_ptr< BackendRenderer >	getRenderer () const
	Returns the renderer. More...

virtual void	setRenderer (std::shared_ptr< BackendRenderer > renderer)
	Sets the renderer that the backend should use. More...

bool	hasFontBackend () const
	Checks whether a font factory has been attached to the backend. More...

std::shared_ptr< BackendFontFactory >	getFontBackend () const
	Returns the font factory. More...

virtual void	setFontBackend (std::shared_ptr< BackendFontFactory > fontBackend)
	Sets the font factory that the backend should use. More...

void	registerFont (BackendFont *font)

void	unregisterFont (BackendFont *font)

Static Public Member Functions
static void	cleanupLeakedCursors ()
	Destroys any leaked cursors. More...

Protected Member Functions
std::unique_ptr< sf::Cursor >	createSystemCursor (Cursor::Type type)

void	updateMouseCursor (Cursor::Type type, std::unique_ptr< sf::Cursor > cursor)

void	updateMouseCursor (sf::Window *window, Cursor::Type type)

Protected Attributes
std::unordered_map< BackendGui *, GuiResources >	m_guiResources

std::unordered_map< Cursor::Type, std::unique_ptr< sf::Cursor > >	m_mouseCursors

Protected Attributes inherited from tgui::Backend
bool	m_destroyOnLastGuiDetatch = false

String	m_clipboardContents

float	m_fontScale = 1

std::shared_ptr< BackendRenderer >	m_renderer

std::shared_ptr< BackendFontFactory >	m_fontBackend

std::set< BackendGui * >	m_guis

std::set< BackendFont * >	m_registeredFonts

Static Protected Attributes
static std::vector< std::unique_ptr< sf::Cursor > >	m_leakedCursors

Member Function Documentation

◆ cleanupLeakedCursors()

static void tgui::BackendSFML::cleanupLeakedCursors ( )

static

Destroys any leaked cursors.

Proper cleanup of TGUI resources requires that the gui is destroyed before the SFML window. Unfortunately, SFML requires the cursor lifetime to exceed that of the window. To not end up with crashes or warnings in the terminal, TGUI may leak one cursor per window. This cursor won't be destroyed properly before the end of the program. You may call this function after both the Gui and SFML window have been destroyed to properly cleanup the leaked cursor.

Warning: This should not be called while the SFML window is still open.

◆ closeVirtualKeyboard()

void tgui::BackendSFML::closeVirtualKeyboard ( )

overridevirtual

Closes the virtual keyboard on Android and iOS.

Reimplemented from tgui::Backend.

◆ detatchGui()

void tgui::BackendSFML::detatchGui ( BackendGui * gui )

overridevirtual

Informs the backend that a gui object is being destroyed.

Parameters

gui	Gui object that is about to be deconstructed

Reimplemented from tgui::Backend.

◆ getClipboard()

String tgui::BackendSFML::getClipboard ( ) const

overridevirtual

Returns the contents of the clipboard.

Returns: Clipboard contents

Reimplemented from tgui::Backend.

◆ isKeyboardModifierPressed()

bool tgui::BackendSFML::isKeyboardModifierPressed ( Event::KeyModifier modifierKey )

overridevirtual

Checks the state for one of the modifier keys.

Parameters

modifierKey The modifier key of which the state is being queried

Returns: Whether queries modifier key is being pressed

Implements tgui::Backend.

◆ openVirtualKeyboard()

void tgui::BackendSFML::openVirtualKeyboard ( const FloatRect & inputRect )

overridevirtual

Opens the virtual keyboard on Android and iOS.

Parameters

inputRect Part of the screen where the text input is located

Reimplemented from tgui::Backend.

◆ resetMouseCursorStyle()

void tgui::BackendSFML::resetMouseCursorStyle ( Cursor::Type type )

overridevirtual

Changes the look of a certain mouse cursor back to the system theme.

Parameters

type	Cursor that should no longer use a custom bitmap

Implements tgui::Backend.

◆ setClipboard()

void tgui::BackendSFML::setClipboard ( const String & contents )

overridevirtual

Changes the contents of the clipboard.

Parameters

contents New contents of the clipboard

Reimplemented from tgui::Backend.

◆ setGuiWindow()

void tgui::BackendSFML::setGuiWindow	(	BackendGui *	gui,
		sf::Window *	window
	)

Informs the backend which window belongs to the gui.

Parameters

gui	Gui that was passed earlier via the attachGui function
window	The window to associate with this gui

This function is called by the gui itself when it is given a window.

◆ setMouseCursor()

void tgui::BackendSFML::setMouseCursor	(	BackendGui *	gui,
		Cursor::Type	type
	)

overridevirtual

Changes the mouse cursor when the mouse is on top of the window to which the gui is attached.

Parameters

gui	The gui that represents the window for which the mouse cursor should be changed
type	Which cursor to use

Implements tgui::Backend.

◆ setMouseCursorStyle()

void tgui::BackendSFML::setMouseCursorStyle	(	Cursor::Type	type,
		const std::uint8_t *	pixels,
		Vector2u	size,
		Vector2u	hotspot
	)

overridevirtual

Changes the look of a certain mouse cursor by using a bitmap.

Parameters

type	Cursor that should make use of the bitmap
pixels	Pointer to an array with 4size.xsize.y elements, representing the pixels in 32-bit RGBA format
size	Size of the cursor
hotspot	Pixel coordinate within the cursor image which will be located exactly at the mouse pointer position

Implements tgui::Backend.

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

include/TGUI/Backend/Window/SFML/BackendSFML.hpp

TGUI

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Function Documentation

◆ cleanupLeakedCursors()

◆ closeVirtualKeyboard()

◆ detatchGui()

◆ getClipboard()

◆ isKeyboardModifierPressed()

◆ openVirtualKeyboard()

◆ resetMouseCursorStyle()

◆ setClipboard()

◆ setGuiWindow()

◆ setMouseCursor()

◆ setMouseCursorStyle()