Castor3D 0.16.0
Multiplatform 3D engine
Public Member Functions | Static Public Member Functions | List of all members
castor::FreeImageLoader Class Reference

Image loader based on stb_image. More...

#include <FreeImageLoader.hpp>

Inheritance diagram for castor::FreeImageLoader:
Inheritance graph
[legend]
Collaboration diagram for castor::FreeImageLoader:
Collaboration graph
[legend]

Public Member Functions

CU_API ImageLayout load (String const &imageFormat, uint8_t const *data, uint32_t size, PxBufferBaseUPtr &buffer) const override
 Loads an image file data.
 
- Public Member Functions inherited from castor::ImageLoaderImpl
virtual ~ImageLoaderImpl () noexcept=default
 
CU_API Image load (String const &name, Path const &imagePath, String const &imageFormat, uint8_t const *data, uint32_t size) const
 Loads an image file data.
 
CU_API Image load (String const &name, String const &imageFormat, uint8_t const *data, uint32_t size) const
 Loads an image file data.
 
CU_API Image load (String const &name, Path const &imagePath, uint8_t const *data, uint32_t size) const
 Loads an image file data.
 

Static Public Member Functions

static CU_API void registerLoader (ImageLoader &reg)
 
static CU_API void unregisterLoader (ImageLoader &reg)
 

Additional Inherited Members

- Protected Member Functions inherited from castor::NonMovable
 NonMovable ()=default
 Constructor.
 
 ~NonMovable () noexcept=default
 Destructor.
 

Detailed Description

Image loader based on stb_image.

Member Function Documentation

◆ load()

CU_API ImageLayout castor::FreeImageLoader::load ( String const & imageFormat,
uint8_t const * data,
uint32_t size,
PxBufferBaseUPtr & buffer ) const
overridevirtual

Loads an image file data.

Parameters
[in]imageFormatThe image format, loader wise.
[in]dataThe image data.
[in]sizeThe image data size.
[out]bufferReceives the buffer data.
Returns
The image layout.

Implements castor::ImageLoaderImpl.

◆ registerLoader()

static CU_API void castor::FreeImageLoader::registerLoader ( ImageLoader & reg)
static

◆ unregisterLoader()

static CU_API void castor::FreeImageLoader::unregisterLoader ( ImageLoader & reg)
static

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