aboutsummaryrefslogtreecommitdiff
path: root/engines
diff options
context:
space:
mode:
authorJody Northup2009-07-06 07:40:28 +0000
committerJody Northup2009-07-06 07:40:28 +0000
commit22e09bedaaf125365c6905187db80e939a86df53 (patch)
tree641adbed4e6034a2e7bee4f0290090633b0be58d /engines
parentf63b02b9200606069a605e27d828f4c8c59119fc (diff)
downloadscummvm-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 'engines')
-rw-r--r--engines/engine.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/engines/engine.h b/engines/engine.h
index c643d5895f..d570f18073 100644
--- a/engines/engine.h
+++ b/engines/engine.h
@@ -59,6 +59,8 @@ void initCommonGFX(bool defaultTo1XScaler);
*
* Errors out when backend is not able to switch to the specified
* mode.
+ *
+ * Defaults to 256 color paletted mode if no graphics format is provided.
*/
void initGraphics(int width, int height, bool defaultTo1xScaler, const Graphics::PixelFormat *format = NULL);