fge::texture::TextureManager Class Reference

Manage textures. More...

#include <texture_manager.hpp>

Inheritance diagram for fge::texture::TextureManager:

Public Types
using	DataType
using	DataBlockType
using	DataBlockPointer
using	Map

Public Member Functions
bool	initialize () override
	Initialize the manager.
bool	isInitialized () override
void	uninitialize () override
bool	loadFromSurface (std::string_view name, fge::Surface const &surface)
	Load a texture from a surface.
bool	loadFromFile (std::string_view name, std::filesystem::path const &path)
	Load a texture from a file.
bool	loadToGroupFromSurface (std::string_view name, fge::Surface const &surface) const
	Load a texture from a surface and add it to a group.
std::size_t	size () const
	Get the number of elements in the manager.
AccessLock< std::mutex >	acquireLock () const
	Acquire a AccessLock, with the manager mutex.
Map::const_iterator	begin (AccessLock< std::mutex > const &lock) const
	Get the "begin" iterator of the manager.
Map::const_iterator	end (AccessLock< std::mutex > const &lock) const
	Get the "end" iterator of the manager.
DataBlockPointer const &	getBadElement () const
	Get the "bad" element.
DataBlockPointer	getElement (std::string_view name) const
	Get the resource with the given name.
bool	contains (std::string_view name) const
bool	unload (std::string_view name)
void	unloadAll ()
bool	push (std::string_view name, DataBlockPointer block)
	Add a user handled resource.

Protected Attributes
DataBlockPointer	_g_badElement

Detailed Description

Manage textures.

This class is used to manage textures. It can load textures from files or surfaces. On initialization, a bad texture is created. This texture is used when a texture is not found in order to always return a "valid" texture.

Member Function Documentation

acquireLock()

AccessLock< std::mutex > fge::manager::BaseManager< TextureType, DataBlock >::acquireLock ( ) const

nodiscardinherited

Acquire a AccessLock, with the manager mutex.

In order to use iterators, you have to acquire a unique lock from this function. The lock is not differed and will lock the mutex.

Returns

A AccessLock bound to this mutex

begin()

BaseManager< TextureType, DataBlock >::Map::const_iterator fge::manager::BaseManager< TextureType, DataBlock >::begin ( AccessLock< std::mutex > const & lock ) const

nodiscardinherited

Get the "begin" iterator of the manager.

You have to provide a valid reference to a AccessLock acquired with the function AcquireLock(). This function will throw if one of this is not respected :

• The mutex pointer of the lock does not correspond to this mutex.

Parameters

lock	A AccessLock bound to this mutex

Returns

The "begin" iterator of the texture manager

end()

BaseManager< TextureType, DataBlock >::Map::const_iterator fge::manager::BaseManager< TextureType, DataBlock >::end ( AccessLock< std::mutex > const & lock ) const

nodiscardinherited

Get the "end" iterator of the manager.

See also

begin()

Parameters

lock	A AccessLock bound to this mutex

Returns

The "end" iterator of the manager

getBadElement()

BaseManager< TextureType, DataBlock >::DataBlockPointer const & fge::manager::BaseManager< TextureType, DataBlock >::getBadElement ( ) const

nodiscardinherited

Get the "bad" element.

A bad element is a "valid" default resource that is returned when the requested resource is not found. return The "bad" element

getElement()

BaseManager< TextureType, DataBlock >::DataBlockPointer fge::manager::BaseManager< TextureType, DataBlock >::getElement ( std::string_view name ) const

nodiscardinherited

Get the resource with the given name.

Parameters

name	The name of the resource to get

Returns

The resource with the given name or the bad resource if not found

initialize()

bool fge::texture::TextureManager::initialize ( )

overridevirtual

Initialize the manager.

The philosophy with this class is to always return a "valid" element even if the element is not found. When this method is called, a "bad" element is created and stored in the manager.

Warning

Note that there is no verification about the above statement, and you can always create your own manager without a "bad" element.

return true if the manager is initialized, false otherwise

Implements fge::manager::BaseManager< TextureType, DataBlock >.

isInitialized()

bool fge::texture::TextureManager::isInitialized ( )

nodiscardoverridevirtual

Implements fge::manager::BaseManager< TextureType, DataBlock >.

loadFromFile()

bool fge::texture::TextureManager::loadFromFile	(	std::string_view	name,
		std::filesystem::path const &	path )

Load a texture from a file.

Parameters

name	The name of the texture to load
path	The path of the file to load

Returns

true if the texture was loaded, false otherwise

loadFromSurface()

bool fge::texture::TextureManager::loadFromSurface	(	std::string_view	name,
		fge::Surface const &	surface )

Load a texture from a surface.

Parameters

name	The name of the texture to load
surface	The surface to load

Returns

true if the texture was loaded, false otherwise

loadToGroupFromSurface()

bool fge::texture::TextureManager::loadToGroupFromSurface	(	std::string_view	name,
		fge::Surface const &	surface ) const

Load a texture from a surface and add it to a group.

Parameters

name	The name of the texture to load
surface	The surface to load

Returns

true if the texture was loaded, false otherwise

push()

bool fge::manager::BaseManager< TextureType, DataBlock >::push ( std::string_view name, DataBlockPointer block )

inherited

Add a user handled resource.

Parameters

name	The name of the texture to add
block	The block data to add

Returns

true if the resource was added, false otherwise

size()

std::size_t fge::manager::BaseManager< TextureType, DataBlock >::size ( ) const

nodiscardinherited

Get the number of elements in the manager.

return The number of elements in the manager without the "bad" element

uninitialize()

void fge::texture::TextureManager::uninitialize ( )

overridevirtual

Implements fge::manager::BaseManager< TextureType, DataBlock >.

---

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

• texture_manager.hpp