[Scummvm-cvs-logs] SF.net SVN: scummvm:[47904] scummvm/trunk/engines/sci/graphics
m_kiewitz at users.sourceforge.net
m_kiewitz at users.sourceforge.net
Fri Feb 5 16:48:46 CET 2010
Revision: 47904
http://scummvm.svn.sourceforge.net/scummvm/?rev=47904&view=rev
Author: m_kiewitz
Date: 2010-02-05 15:48:45 +0000 (Fri, 05 Feb 2010)
Log Message:
-----------
SCI: adding some minor documentation for the various graphic classes
Modified Paths:
--------------
scummvm/trunk/engines/sci/graphics/animate.h
scummvm/trunk/engines/sci/graphics/cache.h
scummvm/trunk/engines/sci/graphics/compare.h
scummvm/trunk/engines/sci/graphics/controls.h
scummvm/trunk/engines/sci/graphics/font.h
scummvm/trunk/engines/sci/graphics/frameout.h
scummvm/trunk/engines/sci/graphics/menu.h
scummvm/trunk/engines/sci/graphics/paint16.h
scummvm/trunk/engines/sci/graphics/paint32.h
scummvm/trunk/engines/sci/graphics/palette.h
scummvm/trunk/engines/sci/graphics/picture.h
scummvm/trunk/engines/sci/graphics/ports.h
scummvm/trunk/engines/sci/graphics/screen.h
scummvm/trunk/engines/sci/graphics/text16.h
scummvm/trunk/engines/sci/graphics/transitions.h
scummvm/trunk/engines/sci/graphics/view.h
Modified: scummvm/trunk/engines/sci/graphics/animate.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/animate.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/animate.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -81,6 +81,9 @@
class GfxScreen;
class GfxPalette;
class GfxTransitions;
+/**
+ * Animate class, kAnimate and relevant functions for SCI16 (SCI0-SCI1.1) games
+ */
class GfxAnimate {
public:
GfxAnimate(EngineState *state, GfxCache *cache, GfxPorts *ports, GfxPaint16 *paint16, GfxScreen *screen, GfxPalette *palette, GfxCursor *cursor, GfxTransitions *transitions);
Modified: scummvm/trunk/engines/sci/graphics/cache.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/cache.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/cache.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -38,6 +38,9 @@
typedef Common::HashMap<int, GfxFont *> FontCache;
typedef Common::HashMap<int, GfxView *> ViewCache;
+/**
+ * Cache class, handles caching of views/fonts
+ */
class GfxCache {
public:
GfxCache(ResourceManager *resMan, GfxScreen *screen, GfxPalette *palette);
Modified: scummvm/trunk/engines/sci/graphics/compare.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/compare.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/compare.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -34,6 +34,9 @@
class Screen;
+/**
+ * Compare class, handles compare operations graphic-wise (like when checking control screen for a pattern etc.)
+ */
class GfxCompare {
public:
GfxCompare(SegManager *segMan, Kernel *kernel, GfxCache *cache, GfxScreen *screen);
Modified: scummvm/trunk/engines/sci/graphics/controls.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/controls.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/controls.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -39,6 +39,9 @@
class Font;
class GfxText16;
class GfxScreen;
+/**
+ * Controls class, handles drawing of controls in SCI16 (SCI0-SCI1.1) games
+ */
class GfxControls {
public:
GfxControls(SegManager *segMan, GfxPorts *ports, GfxPaint16 *paint16, GfxText16 *text16, GfxScreen *screen);
Modified: scummvm/trunk/engines/sci/graphics/font.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/font.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/font.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -30,6 +30,10 @@
namespace Sci {
+/**
+ * Font class, handles loading of font resources and drawing characters to screen
+ * every font resource has its own instance of this class
+ */
class GfxFont {
public:
GfxFont(ResourceManager *resMan, GfxScreen *screen, GuiResourceId resourceId);
Modified: scummvm/trunk/engines/sci/graphics/frameout.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/frameout.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/frameout.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -45,6 +45,9 @@
class GfxCache;
class GfxPaint32;
+/**
+ * Frameout class, kFrameout and relevant functions for SCI32 games
+ */
class GfxFrameout {
public:
GfxFrameout(SegManager *segMan, ResourceManager *resMan, GfxCache *cache, GfxScreen *screen, GfxPalette *palette, GfxPaint32 *paint32);
Modified: scummvm/trunk/engines/sci/graphics/menu.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/menu.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/menu.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -76,6 +76,9 @@
};
typedef Common::List<GuiMenuItemEntry *> GuiMenuItemList;
+/**
+ * Menu class, handles game pulldown menu for SCI16 (SCI0-SCI1.1) games
+ */
class GfxMenu {
public:
GfxMenu(SciEvent *event, SegManager *segMan, SciGui *gui, GfxPorts *ports, GfxPaint16 *paint16, GfxText16 *text16, GfxScreen *screen, GfxCursor *cursor);
Modified: scummvm/trunk/engines/sci/graphics/paint16.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/paint16.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/paint16.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -40,6 +40,9 @@
class SciGuiPicture;
class GfxView;
+/**
+ * Paint16 class, handles painting/drawing for SCI16 (SCI0-SCI1.1) games
+ */
class GfxPaint16 : public GfxPaint {
public:
GfxPaint16(ResourceManager *resMan, SegManager *segMan, Kernel *kernel, GfxCache *cache, GfxPorts *ports, GfxScreen *screen, GfxPalette *palette, GfxTransitions *transitions);
Modified: scummvm/trunk/engines/sci/graphics/paint32.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/paint32.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/paint32.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -35,6 +35,9 @@
class GfxPorts;
+/**
+ * Paint32 class, handles painting/drawing for SCI32 (SCI2+) games
+ */
class GfxPaint32 : public GfxPaint {
public:
GfxPaint32(ResourceManager *resMan, SegManager *segMan, Kernel *kernel, GfxCache *cache, GfxScreen *screen, GfxPalette *palette);
Modified: scummvm/trunk/engines/sci/graphics/palette.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/palette.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/palette.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -31,6 +31,9 @@
namespace Sci {
class Screen;
+/**
+ * Palette class, handles palette operations like changing intensity, setting up the palette, merging different palettes
+ */
class GfxPalette {
public:
GfxPalette(ResourceManager *resMan, GfxScreen *screen, bool autoSetPalette = true);
Modified: scummvm/trunk/engines/sci/graphics/picture.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/picture.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/picture.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -36,6 +36,10 @@
class GfxScreen;
class GfxPalette;
+/**
+ * Picture class, handles loading and displaying of picture resources
+ * every picture resource has its own instance of this class
+ */
class GfxPicture {
public:
GfxPicture(ResourceManager *resMan, GfxPorts *ports, GfxScreen *screen, GfxPalette *palette, GuiResourceId resourceId, bool EGAdrawingVisualize = false);
Modified: scummvm/trunk/engines/sci/graphics/ports.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/ports.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/ports.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -36,6 +36,10 @@
class GfxScreen;
class GfxText16;
+/**
+ * Ports class, includes all port managment for SCI0->SCI1.1 games. Ports are some sort of windows in SCI
+ * this class also handles adjusting coordinates to a specific port
+ */
class GfxPorts {
public:
GfxPorts(SegManager *segMan, GfxScreen *screen);
Modified: scummvm/trunk/engines/sci/graphics/screen.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/screen.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/screen.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -41,6 +41,11 @@
#define SCI_SCREEN_UNDITHERMEMORIAL_SIZE 256
+/**
+ * Screen class, actually creates 3 (4) screens internally - which is visual/display (for the user),
+ * priority (contains priority information) and control (contains control information). Handles all operations to it
+ * and copies parts of visual/display screen to the actual screen, so the user can really see it.
+ */
class GfxScreen {
public:
GfxScreen(ResourceManager *resMan, int16 width = 320, int16 height = 200, bool upscaledHires = false);
Modified: scummvm/trunk/engines/sci/graphics/text16.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/text16.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/text16.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -36,6 +36,9 @@
class GfxPaint16;
class GfxScreen;
class GfxFont;
+/**
+ * Text16 class, handles text calculation and displaying of text for SCI0->SCI1.1 games
+ */
class GfxText16 {
public:
GfxText16(ResourceManager *_resMan, GfxCache *fonts, GfxPorts *ports, GfxPaint16 *paint16, GfxScreen *screen);
Modified: scummvm/trunk/engines/sci/graphics/transitions.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/transitions.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/transitions.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -60,6 +60,9 @@
};
class Screen;
+/**
+ * Transitions class, handles doing transitions for SCI0->SCI1.1 games like fade out/fade in, mosaic effect, etc.
+ */
class GfxTransitions {
public:
GfxTransitions(SciGui *gui, GfxScreen *screen, GfxPalette *palette, bool isVGA);
Modified: scummvm/trunk/engines/sci/graphics/view.h
===================================================================
--- scummvm/trunk/engines/sci/graphics/view.h 2010-02-05 14:48:51 UTC (rev 47903)
+++ scummvm/trunk/engines/sci/graphics/view.h 2010-02-05 15:48:45 UTC (rev 47904)
@@ -51,6 +51,10 @@
class GfxScreen;
class GfxPalette;
+/**
+ * View class, handles loading of view resources and drawing contained cels to screen
+ * every view resource has its own instance of this class
+ */
class GfxView {
public:
GfxView(ResourceManager *resMan, GfxScreen *screen, GfxPalette *palette, GuiResourceId resourceId);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Scummvm-git-logs
mailing list