SILLY_FileDataSource

FileDataSource(3)        Simple Image Loading LibrarY        FileDataSource(3)



NAME
       FileDataSource - This class allow the loading of an image directly from
       a file.


SYNOPSIS
       #include <SILLYFileDataSource.h>

       Inherits DataSource.

   Public Member Functions
       FileDataSource (const char *filename)
           Create a data source from an existing file.
       const byte * getDataPtr () const
           Get raw access to the image data.
       size_t getSize () const
           Return the size of the data.
       bool isValid () const
           Check wether the loading is successfull or not.
       byte operator[] (size_t offset) const
           Retieve the byte at offset.
       ~FileDataSource ()
           destructor

Detailed Description
       This class allow the loading of an image directly from a file.

       This class provides the services required to load an from a file. The
       loading is done once at initialization. We wanted to avoid exception.
       This is why user must check whether the object is valid or not after
       creation.

       Definition at line 48 of file SILLYFileDataSource.h.

Constructor & Destructor Documentation
   FileDataSource (const char * filename)
       Create a data source from an existing file. The FileDataSource manage
       the loading and the caching of the raw image source. The object manage
       the life time of the data.

       Parameters:
           filename the name of the file containing the data

       Definition at line 46 of file SILLYFileDataSource.cpp.

Member Function Documentation
   bool isValid () const
       Check wether the loading is successfull or not. One must call this
       function after creating this object in order to be sure the loading was
       successfull.

       Returns:
           true if the loading is successfull.

   byte operator[] (size_t offset) const [inherited]
       Retieve the byte at offset.


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



Version 0.1.0                   Thu Jan 31 2019              FileDataSource(3)