diff options
| author | Colin Snover | 2016-06-30 13:24:46 -0500 |
|---|---|---|
| committer | Colin Snover | 2016-06-30 14:04:57 -0500 |
| commit | a785147d6c4bf9a9468a60643dd0f8e9f4847400 (patch) | |
| tree | 621fa688c0091eef462bea581d3ff3d51655243c /engines/sci/graphics/frameout.h | |
| parent | 29f7a66af40acdc348e28d5c681f43e1f33bf4de (diff) | |
| download | scummvm-rg350-a785147d6c4bf9a9468a60643dd0f8e9f4847400.tar.gz scummvm-rg350-a785147d6c4bf9a9468a60643dd0f8e9f4847400.tar.bz2 scummvm-rg350-a785147d6c4bf9a9468a60643dd0f8e9f4847400.zip | |
SCI32: Document & clean up extra rect argument for frameOut
This extra rect seems to probably only ever be used by VMD
playback in some SCI2.1 games.
Diffstat (limited to 'engines/sci/graphics/frameout.h')
| -rw-r--r-- | engines/sci/graphics/frameout.h | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/engines/sci/graphics/frameout.h b/engines/sci/graphics/frameout.h index 0be5aece1e..e736872773 100644 --- a/engines/sci/graphics/frameout.h +++ b/engines/sci/graphics/frameout.h @@ -376,8 +376,10 @@ private: * over the entire screen for rendering the next frame. * The draw and erase lists in `drawLists` and * `eraseLists` each represent one plane on the screen. + * The optional `eraseRect` argument allows a specific + * area of the screen to be erased. */ - void calcLists(ScreenItemListList &drawLists, EraseListList &eraseLists, const Common::Rect &calcRect); + void calcLists(ScreenItemListList &drawLists, EraseListList &eraseLists, const Common::Rect &eraseRect = Common::Rect()); /** * Erases the areas in the given erase list from the @@ -430,9 +432,10 @@ public: /** * Updates the internal screen buffer for the next * frame. If `shouldShowBits` is true, also sends the - * buffer to hardware. + * buffer to hardware. If `eraseRect` is non-empty, + * it is added to the erase list for this frame. */ - void frameOut(const bool shouldShowBits, const Common::Rect &rect = Common::Rect()); + void frameOut(const bool shouldShowBits, const Common::Rect &eraseRect = Common::Rect()); /** * Modifies the raw pixel data for the next frame with |