Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.

Image loader job class. More...

#include <GUILargeTextureManager.h>

Inheritance diagram for CImageLoader:
CJob

Public Member Functions

 CImageLoader (const std::string &path, const bool useCache)
 
 ~CImageLoader () override
 
bool DoWork () override
 Work function that loads in a particular image. More...
 
- Public Member Functions inherited from CJob
 CJob ()
 
virtual ~CJob ()=default
 Destructor for job objects. More...
 
virtual const char * GetType () const
 Function that returns the type of job. More...
 
virtual bool operator== (const CJob *job) const
 
virtual bool ShouldCancel (unsigned int progress, unsigned int total) const
 Function for longer jobs to report progress and check whether they have been cancelled. More...
 

Public Attributes

bool m_use_cache
 Whether or not to use any caching with this image. More...
 
std::string m_path
 path of image to load More...
 
CBaseTexturem_texture
 Texture object to load the image into. More...
 

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,
const bool  useCache 
)

◆ ~CImageLoader()

CImageLoader::~CImageLoader ( )
override

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

CBaseTexture* CImageLoader::m_texture

Texture object to load the image into.

See also
CBaseTexture.

◆ 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: