SILLY_Image man page

Image — Image is the main user class of the library.

Synopsis

#include <SILLYImage.h>

Public Member Functions

size_t getHeight () const
Retrieve the height of the image.
const char * getLoaderIdentifierString () const
Get Image loader identifier string.
PixelFormat getPixelFormat () const
Retrieve the pixel format of the resulting image.
const byte * getPixelsDataPtr () const
Get a pointer to the pixels data.
size_t getPixelsDataSize () const
Get the size of the pixel buffer.
PixelFormat getSourcePixelFormat () const
Retrieve the pixel format used for the image storage.
size_t getWidth () const
Retrieve the width of the image.
Image (DataSource &data)
Constructor.
bool isValid () const
Return true if the image is valid after its loading.
bool loadImageData (PixelFormat resultFormat=PF_RGBA, PixelOrigin origin=PO_TOP_LEFT)
Load the image pixels in memory and store them in resultFormat.
bool loadImageHeader ()
Retrieve the information concerning the image object.
~Image ()
Destructor.

Detailed Description

Image is the main user class of the library.

Definition at line 46 of file SILLYImage.h.

Constructor & Destructor Documentation

Image (DataSource & data)

Constructor.

Parameters:

data the raw input containing the image

Definition at line 48 of file SILLYImage.cpp.

Member Function Documentation

bool loadImageData (PixelFormat resultFormat = PF_RGBA, PixelOrigin origin = PO_TOP_LEFT)

Load the image pixels in memory and store them in resultFormat.

Parameters:

resultFormat the pixel format to be used for storing the result
origin expected origin position for the pixels

Returns:

true on success false if an error occured

Note:

this function can be called several time if the pixel format are different the format is reloaded

Definition at line 68 of file SILLYImage.cpp.

bool loadImageHeader ()

Retrieve the information concerning the image object.

Returns:

true on success

Definition at line 54 of file SILLYImage.cpp.

Author

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

Info

Wed Feb 3 2016 Version 0.1.0 Simple Image Loading LibrarY