diff options
author | rubidium <rubidium@openttd.org> | 2011-01-22 09:53:15 +0000 |
---|---|---|
committer | rubidium <rubidium@openttd.org> | 2011-01-22 09:53:15 +0000 |
commit | eb299736c1bcb277da1862afe95c11cb897effcf (patch) | |
tree | 3bb6bff78f066da770a367e078c569dbe8ce319a /src/spriteloader/spriteloader.hpp | |
parent | 0cdb1c78cdbfce4d426441c21ef7066f1cfecf6f (diff) | |
download | openttd-eb299736c1bcb277da1862afe95c11cb897effcf.tar.xz |
(svn r21886) -Codechange: move documentation towards the code to make it more likely to be updated [n].
Diffstat (limited to 'src/spriteloader/spriteloader.hpp')
-rw-r--r-- | src/spriteloader/spriteloader.hpp | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/spriteloader/spriteloader.hpp b/src/spriteloader/spriteloader.hpp index 693c85329..b159c95a4 100644 --- a/src/spriteloader/spriteloader.hpp +++ b/src/spriteloader/spriteloader.hpp @@ -50,6 +50,11 @@ public: /** * Load a sprite from the disk and return a sprite struct which is the same for all loaders. + * @param sprite The sprite to fill with data. + * @param file_slot The file "descriptor" of the file we read from. + * @param file_pos The position within the file the image begins. + * @param sprite_type The type of sprite we're trying to load. + * @return true iff loading went okay. */ virtual bool LoadSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type) = 0; |