Référence de la classe castor::ImageLoader

#include <ImageLoader.hpp>

Graphe d'héritage de castor::ImageLoader:

Graphe de collaboration de castor::ImageLoader:

Fonctions membres publiques
CU_API	ImageLoader (PxCompressionSupport support={})
CU_API void	registerLoader (String const &extension, ImageLoaderPtr loader)
	Enregistre un loader d'image.
CU_API void	registerLoader (StringArray const &extensions, ImageLoaderPtr loader)
	Enregistre un loader d'image.
CU_API void	unregisterLoader (String const &extension)
	Désenregistre le loader pour l'extension de fichier d'image donnée.
CU_API void	unregisterLoader (StringArray const &extensions)
	Désenregistre le loader pour l'extension de fichier d'image donnée.
CU_API Image	load (String const &name, Path const &path, ImageLoaderConfig const &config) const
	Charge les données d'un fichier image.
CU_API Image	load (String const &name, Path const &imagePath, uint8_t const *data, uint32_t size, ImageLoaderConfig const &config) const
	Charge les données d'un fichier image.
CU_API Image	load (String const &name, String const &imageFormat, uint8_t const *data, uint32_t size, ImageLoaderConfig const &config) const
	Charge les données d'un fichier image.
void	setCompressionSupport (PxCompressionSupport support)
PxBufferConvertOptions const &	getOptions () const

Membres hérités additionnels
Fonctions membres protégées hérités de castor::NonMovable
	NonMovable ()=default
	Constructeur.
	~NonMovable () noexcept=default
	Destructeur.

Documentation des constructeurs et destructeur

ImageLoader()

CU_API castor::ImageLoader::ImageLoader ( PxCompressionSupport support = {} )

explicit

Documentation des fonctions membres

getOptions()

PxBufferConvertOptions const & castor::ImageLoader::getOptions ( ) const

inline

load() [1/3]

CU_API Image castor::ImageLoader::load	(	String const &	name,
		Path const &	imagePath,
		uint8_t const *	data,
		uint32_t	size,
		ImageLoaderConfig const &	config ) const

Charge les données d'un fichier image.

Paramètres

[in]	name	Le nom de l'image.
[in]	imagePath	Chemin d'accès au fichier.
[in]	data	Les données de l'image.
[in]	size	La taille des données de l'image.
[in]	config	La configuration du loader.

Renvoie

L'image.

load() [2/3]

CU_API Image castor::ImageLoader::load	(	String const &	name,
		Path const &	path,
		ImageLoaderConfig const &	config ) const

Charge les données d'un fichier image.

Paramètres

[in]	name	Le nom de l'image.
[in]	path	Le chemin d'accès au fichier image.
[in]	config	La configuration du loader.

Renvoie

L'image.

load() [3/3]

CU_API Image castor::ImageLoader::load	(	String const &	name,
		String const &	imageFormat,
		uint8_t const *	data,
		uint32_t	size,
		ImageLoaderConfig const &	config ) const

Charge les données d'un fichier image.

Paramètres

[in]	name	Le nom de l'image.
[in]	imageFormat	Le format de l'image, niveau loader.
[in]	data	Les données de l'image.
[in]	size	La taille des données de l'image.
[in]	config	La configuration du loader.

Renvoie

L'image.

registerLoader() [1/2]

CU_API void castor::ImageLoader::registerLoader	(	String const &	extension,
		ImageLoaderPtr	loader )

Enregistre un loader d'image.

Paramètres

[in]	extension	L'extension de fichier image.
[in]	loader	Le loader.

registerLoader() [2/2]

CU_API void castor::ImageLoader::registerLoader	(	StringArray const &	extensions,
		ImageLoaderPtr	loader )

Enregistre un loader d'image.

Paramètres

[in]	extensions	La liste d'extensions de fichier image.
[in]	loader	Le loader.

setCompressionSupport()

void castor::ImageLoader::setCompressionSupport ( PxCompressionSupport support )

inline

unregisterLoader() [1/2]

CU_API void castor::ImageLoader::unregisterLoader

(

String const &

extension

)

Désenregistre le loader pour l'extension de fichier d'image donnée.

Paramètres

[in]

extension

L'extension de fichier image.

unregisterLoader() [2/2]

CU_API void castor::ImageLoader::unregisterLoader

(

StringArray const &

extensions

)

Désenregistre le loader pour l'extension de fichier d'image donnée.

Paramètres

[in]

extensions

La liste d'extensions de fichier image.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• CastorUtils/Graphics/ImageLoader.hpp