CImageLoader Class Reference

Image loader job class. More...

#include <GUILargeTextureManager.h>

Inheritance diagram for CImageLoader:

Public Member Functions
	CImageLoader (const std::string &path, unsigned int targetWidth, unsigned int targetHeight, CAspectRatio::AspectRatio aspectRatio, const bool useCache)
	~CImageLoader () override
bool	DoWork () override
	Work function that loads in a particular image.
Public Member Functions inherited from CJob
	CJob ()=default
virtual	~CJob ()=default
	Destructor for job objects.
virtual const char *	GetType () const
	Function that returns the type of job.
virtual bool	Equals (const CJob *job) const
	Function that compares this job instance with the given job instance.
void	SetProgressCallback (CJobManager *callback)
	Function to set a callback for jobs to report progress.
virtual bool	ShouldCancel (unsigned int progress, unsigned int total) const
	Function for longer jobs to report progress and check whether they have been cancelled.

Public Attributes
bool	m_use_cache
	Whether or not to use any caching with this image.
std::string	m_path
	path of image to load
std::unique_ptr< CTexture >	m_texture
	Texture object to load the image into.

Additional Inherited Members
Public Types inherited from CJob
enum	PRIORITY {   PRIORITY_LOW_PAUSABLE = 0 , PRIORITY_LOW , PRIORITY_NORMAL , PRIORITY_HIGH ,   PRIORITY_DEDICATED }
	Priority levels for jobs, specified by clients when adding jobs to the CJobManager. More...

Detailed Description

Image loader job class.

,

Used by the CGUILargeTextureManager to perform asynchronous loading of textures.

See also

CGUILargeTextureManager and CJob

Constructor & Destructor Documentation

CImageLoader()

CImageLoader::CImageLoader	(	const std::string &	path,
		unsigned int	targetWidth,
		unsigned int	targetHeight,
		CAspectRatio::AspectRatio	aspectRatio,
		const bool	useCache )

~CImageLoader()

CImageLoader::~CImageLoader ( )

overridedefault

Member Function Documentation

DoWork()

bool CImageLoader::DoWork ( void )

overridevirtual

Work function that loads in a particular image.

Implements CJob.

Member Data Documentation

m_path

std::string CImageLoader::m_path

path of image to load

m_texture

std::unique_ptr<CTexture> CImageLoader::m_texture

Texture object to load the image into.

See also

CTexture.

m_use_cache

bool CImageLoader::m_use_cache

Whether or not to use any caching with this image.

---

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

• GUILargeTextureManager.h
• GUILargeTextureManager.cpp