diff options
author | Filippos Karapetis | 2009-01-05 15:10:13 +0000 |
---|---|---|
committer | Filippos Karapetis | 2009-01-05 15:10:13 +0000 |
commit | 7f9ea7e35c907d44ce84e990b1b3258e214fac91 (patch) | |
tree | a8916fd594a3eb417f188f993e40866286eeca86 /graphics/video/flic_player.h | |
parent | dc661e62a99118d8aba80f1f3533b0c78a440e75 (diff) | |
download | scummvm-rg350-7f9ea7e35c907d44ce84e990b1b3258e214fac91.tar.gz scummvm-rg350-7f9ea7e35c907d44ce84e990b1b3258e214fac91.tar.bz2 scummvm-rg350-7f9ea7e35c907d44ce84e990b1b3258e214fac91.zip |
Added Doxygen-like comments to the FLIC player, and changed it a bit to have similar method names as the DXA and Smacker players. Also, removed the convenience method hasFrames(), as it's the same as getFrameCount() > 0
svn-id: r35741
Diffstat (limited to 'graphics/video/flic_player.h')
-rw-r--r-- | graphics/video/flic_player.h | 40 |
1 files changed, 36 insertions, 4 deletions
diff --git a/graphics/video/flic_player.h b/graphics/video/flic_player.h index ef2b6d67ba..c453bf91c5 100644 --- a/graphics/video/flic_player.h +++ b/graphics/video/flic_player.h @@ -63,14 +63,46 @@ public: FlicPlayer(); ~FlicPlayer(); - bool loadFile(const char *fileName); - void closeFile(); - void decodeFrame(); + /** + * Returns the width of the video + * @return the width of the video + */ int getWidth() const { return _flicInfo.width; } + + /** + * Returns the height of the video + * @return the height of the video + */ int getHeight() const { return _flicInfo.height; } - bool hasFrames() const { return _flicInfo.numFrames > 0; } + + /** + * Returns the current frame number of the video + * @return the current frame number of the video + */ int getCurFrame() const { return _currFrame; } + + /** + * Returns the amount of frames in the video + * @return the amount of frames in the video + */ int getFrameCount() const { return _flicInfo.numFrames; } + + /** + * Load a FLIC encoded video file + * @param filename the filename to load + */ + bool loadFile(const char *fileName); + + /** + * Close a FLIC encoded video file + */ + void closeFile(); + + /** + * Decode the next frame + */ + void decodeNextFrame(); + bool isLastFrame() const { return _currFrame == _flicInfo.numFrames; } uint32 getSpeed() const { return _flicInfo.speed; } bool isPaletteDirty() const { return _paletteDirty; } |