diff options
author | Bjørn Lindeijer <bjorn@lindeijer.nl> | 2005-02-21 00:03:11 +0000 |
---|---|---|
committer | Bjørn Lindeijer <bjorn@lindeijer.nl> | 2005-02-21 00:03:11 +0000 |
commit | f741c14337dd0850a7201f5aa2185e40a625353a (patch) | |
tree | dd1dd0cf95b6117e4a8aea96317f6301eaa078ed /src/resources/image.h | |
parent | f7214b33bf5cbb85df57e8d0035af7a25826e985 (diff) | |
download | mana-f741c14337dd0850a7201f5aa2185e40a625353a.tar.gz mana-f741c14337dd0850a7201f5aa2185e40a625353a.tar.bz2 mana-f741c14337dd0850a7201f5aa2185e40a625353a.tar.xz mana-f741c14337dd0850a7201f5aa2185e40a625353a.zip |
Updates to change log, file lists, lots of doxygen comments and small changes.
Diffstat (limited to 'src/resources/image.h')
-rw-r--r-- | src/resources/image.h | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/src/resources/image.h b/src/resources/image.h index ed1e0905..9102f62c 100644 --- a/src/resources/image.h +++ b/src/resources/image.h @@ -64,7 +64,12 @@ class Image : public Resource /** * Loads an image. + * * @param filePath The path to the image file to load. + * @param flags These flags allow controlling the way the image is + * loaded. Currently only IMG_ALPHA is supported, which + * causes alpha layer to be preserved. + * * @return <code>NULL</code> if the an error occurred, a * valid pointer otherwise. */ @@ -72,10 +77,12 @@ class Image : public Resource /** * Loads an image from a buffer in memory. - * @param buffer The memory buffer containing the image - * data. - * @return <code>NULL</code> if the an error occurred, a - * valid pointer otherwise. + * + * @param buffer The memory buffer containing the image data. + * @param bufferSize The size of the memory buffer in bytes. + * + * @return <code>NULL</code> if the an error occurred, a valid pointer + * otherwise. */ static Image *load(const char* buffer, unsigned int bufferSize); |