SILLY_ImageLoader

ImageLoader(3)           Simple Image Loading LibrarY           ImageLoader(3)



NAME
       ImageLoader - This is an abstract class that define the interface of
       all image loader.


SYNOPSIS
       #include <SILLYImageLoader.h>

       Inherited by JPGImageLoader, PNGImageLoader, and TGAImageLoader.

   Public Member Functions
       void destroyContext (ImageContext *context)
           Destroy the image context.
       const char * getIdentifierString () const
           Return the name of the loader.
       virtual ImageContext * loadHeader (PixelFormat &formatSource,
           DataSource *data)=0
           Parse the header of the image and fill the header struct.
       virtual bool loadImageData (PixelOrigin origin, DataSource *data,
           ImageContext *context)=0
           Parse the pixels data of the image and fill the header struct.
       virtual ~ImageLoader ()
           Destructor.

   Protected Member Functions
       ImageLoader (const char *name)
           Constructor.

Detailed Description
       This is an abstract class that define the interface of all image
       loader.

       In order to add support for new image format one have to inherits this
       class and implement all required function.

       Definition at line 46 of file SILLYImageLoader.h.

Member Function Documentation
   void destroyContext (ImageContext * context)
       Destroy the image context.

       Parameters:
           context a pointer to the context

       Definition at line 47 of file SILLYImageLoader.cpp.

   virtual ImageContext* loadHeader (PixelFormat & formatSource, DataSource *
       data) [pure virtual]
       Parse the header of the image and fill the header struct.

       Parameters:
           formatSource this var should contains the pixel format used to
           store the image initialy
           data the input of the image data

       Returns:
           Context for the rest of the parsing or 0 if an error occured

       Implemented in PNGImageLoader, TGAImageLoader, and JPGImageLoader.

   virtual bool loadImageData (PixelOrigin origin, DataSource * data,
       ImageContext * context) [pure virtual]
       Parse the pixels data of the image and fill the header struct.

       Parameters:
           origin the layout of the pixel in the resulting pixel array
           data the input of the image data
           context the data associated to the image parsing

       Returns:
           true on success false on error

       Implemented in PNGImageLoader, TGAImageLoader, and JPGImageLoader.


Author
       Generated automatically by Doxygen for Simple Image Loading LibrarY
       from the source code.



Version 0.1.0                   Thu Jan 31 2019                 ImageLoader(3)