castor::ImageWriter Class Reference

#include <ImageWriter.hpp>

Public Member Functions
CU_API void	registerWriter (String const &extension, ImageWriterPtr writer)
	Registers an image writer.
CU_API void	registerWriter (StringArray const &extensions, ImageWriterPtr writer)
	Registers an image writer.
CU_API void	unregisterWriter (String const &extension)
	Unregisters the writer for given image file extension.
CU_API void	unregisterWriter (StringArray const &extensions)
	Unregisters the writer for given image file extension.
CU_API bool	write (Path const &path, PxBufferBase const &buffer) const
	Saves an image data to a file.

Member Function Documentation

registerWriter() [1/2]

CU_API void castor::ImageWriter::registerWriter	(	String const &	extension,
		ImageWriterPtr	writer )

Registers an image writer.

Parameters

[in]	extension	The image file extension.
[in]	writer	The image writer.

registerWriter() [2/2]

CU_API void castor::ImageWriter::registerWriter	(	StringArray const &	extensions,
		ImageWriterPtr	writer )

Registers an image writer.

Parameters

[in]	extensions	The image file extensions list.
[in]	writer	The image writer.

unregisterWriter() [1/2]

CU_API void castor::ImageWriter::unregisterWriter

(

String const &

extension

)

Unregisters the writer for given image file extension.

Parameters

[in]

extension

The image file extension.

unregisterWriter() [2/2]

CU_API void castor::ImageWriter::unregisterWriter

(

StringArray const &

extensions

)

Unregisters the writer for given image file extension.

Parameters

[in]

extensions

The image file extensions list.

write()

CU_API bool castor::ImageWriter::write	(	Path const &	path,
		PxBufferBase const &	buffer ) const

Saves an image data to a file.

Parameters

[in]	path	The image file path.
[in]	buffer	The image data.

Returns

false if any problem occured.

---

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

• CastorUtils/Graphics/ImageWriter.hpp