diff options
author | Jody Northup | 2009-07-06 07:40:28 +0000 |
---|---|---|
committer | Jody Northup | 2009-07-06 07:40:28 +0000 |
commit | 22e09bedaaf125365c6905187db80e939a86df53 (patch) | |
tree | 641adbed4e6034a2e7bee4f0290090633b0be58d /graphics/cursorman.h | |
parent | f63b02b9200606069a605e27d828f4c8c59119fc (diff) | |
download | scummvm-rg350-22e09bedaaf125365c6905187db80e939a86df53.tar.gz scummvm-rg350-22e09bedaaf125365c6905187db80e939a86df53.tar.bz2 scummvm-rg350-22e09bedaaf125365c6905187db80e939a86df53.zip |
Updated doxygen comments on API functions
svn-id: r42166
Diffstat (limited to 'graphics/cursorman.h')
-rw-r--r-- | graphics/cursorman.h | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/graphics/cursorman.h b/graphics/cursorman.h index ba11c9ef96..ae7008f54c 100644 --- a/graphics/cursorman.h +++ b/graphics/cursorman.h @@ -63,14 +63,14 @@ public: * safely freed afterwards. * * @param buf the new cursor data - * @param w the width - * @param h the height + * @param w the width + * @param h the height * @param hotspotX the hotspot X coordinate * @param hotspotY the hotspot Y coordinate * @param keycolor the index for the transparent color * @param targetScale the scale for which the cursor is designed - * @param format the pixel format which the cursor graphic uses - * + * @param format a pointer to the pixel format which the cursor graphic uses, + * CLUT8 will be used if this is NULL or not specified. * @note It is ok for the buffer to be a NULL pointer. It is sometimes * useful to push a "dummy" cursor and modify it later. The * cursor will be added to the stack, but not to the backend. @@ -95,7 +95,8 @@ public: * @param hotspotY the hotspot Y coordinate * @param keycolor the index for the transparent color * @param targetScale the scale for which the cursor is designed - * @param format the pixel format which the cursor graphic uses + * @param format a pointer to the pixel format which the cursor graphic uses, + * CLUT8 will be used if this is NULL or not specified. */ void replaceCursor(const byte *buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor = 0xFFFFFFFF, int targetScale = 1, const Graphics::PixelFormat *format = NULL); |