prj/cam/src/render/scrnman.h

   1 /*
   2 @Copyright Looking Glass Studios, Inc.
   3 1996,1997,1998,1999,2000 Unpublished Work.
   4 */
   5
   6 #pragma once
   7 /*
   8  * $Source: r:/t2repos/thief2/src/render/scrnman.h,v $
   9  * $Revision: 1.16 $
  10  * $Author: adurant $
  11  * $Date: 2000/01/31 09:53:18 $
  12  *
  13  * Screen Manager
  14  *
  15 */
  16
  17 #ifndef __SCRNMAN_H
  18 #define __SCRNMAN_H
  19
  20 #include <dev2d.h>
  21 #include <rect.h>
  22
  23 // The big purpose of this module is to hide whether you
  24 // are page flipping or offscreen buffered, and to hide
  25 // much 8 vs 16 bit stuff like blackening screens
  26
  27
  28 typedef enum {
  29    SCR_320x200x8        = GRM_320x200x8,
  30    SCR_320x400x8        = GRM_320x400x8,
  31    SCR_512x384x8        = GRM_512x384x8,
  32    SCR_640x400x8        = GRM_640x400x8,
  33    SCR_640x400x16       = GRM_640x400x16,
  34    SCR_640x480x8        = GRM_640x480x8,
  35    SCR_800x600x8        = GRM_800x600x8,
  36    SCR_1024x768x8       = GRM_1024x768x8,
  37    SCR_1280x1024x8      = GRM_1280x1024x8,
  38
  39
  40    SCR_320x200          = SCR_320x200x8,
  41    SCR_320x400          = SCR_320x400x8,
  42    SCR_512x384          = SCR_512x384x8,
  43    SCR_640x400          = SCR_640x400x8,
  44    SCR_640x480          = SCR_640x480x8,
  45    SCR_800x600          = SCR_800x600x8,
  46    SCR_1024x768         = SCR_1024x768x8,
  47    SCR_1280x1024        = SCR_1280x1024x8,
  48
  49    SCR_NOMODE           = -1,
  50 } ScrnMode;
  51
  52 #define ScrnModeToGrMode(x) (x)
  53
  54 // find a screen mode given parameters, returns SCR_NOMODE if none found
  55 EXTERN ScrnMode ScrnFindModeFlags(short w, short h, ubyte bitdepth, ulong flags);
  56 #define ScrnFindMode(w,h,d) ScrnFindModeFlags(w,h,d,0)
  57
  58 enum eScrnFlags
  59 {
  60    kScrnPreservePal = (1 << 9), // preserve the palette
  61 };
  62
  63 // set a new display mode.
  64 EXTERN int ScrnSetDisplay(int kind, int flags, GUID *pDDrawGuid);
  65
  66 // set a new screen mode.  Flags are gr_set_mode flags plus eScrnFlags
  67 // palette or not
  68 // returns TRUE for success
  69 EXTERN BOOL ScrnSetRes(ScrnMode mode,ulong flags);
  70
  71 EXTERN void ScrnUnsetRes(void);
  72
  73 // returns SCR_NOMODE if not yet set
  74 EXTERN ScrnMode ScrnGetRes(void);
  75
  76 // Startup/Term 3d accel, happens within a mode change
  77 EXTERN BOOL ScrnInit3d(void); // return TRUE for success.
  78 EXTERN void ScrnTerm3d(void);
  79
  80
  81
  82 // background drawer callback function, takes data,
  83 // takes effect next start frame.  Should call it outside
  84 // of a frame.  Only one can be installed at a time
  85 // no chaining.  Maybe later if you ever need it
  86 //
  87 typedef void (*ScrnCallBack)(int data);
  88
  89 EXTERN void ScrnInstallBackground(ScrnCallBack cb,int data);
  90
  91 // clear the screen to black and blacken the palette
  92 // note that this works great, 8 or 16 bit as a prelude
  93 // to loading a new screen
  94 EXTERN void ScrnBlacken(void);
  95
  96 // don't change the palette, just clear
  97 EXTERN void ScrnClear(void);
  98
  99 // call the background callback if present
 100 EXTERN void ScrnStartFrame(void);
 101
 102 // blit or page flip, transparently, woo woo.
 103 EXTERN void ScrnEndFrame(void);
 104
 105 // force a blit or page flip right now dammit
 106 EXTERN void ScrnForceUpdate(void);
 107 EXTERN void ScrnForceUpdateRect(Rect *r);
 108
 109 // set the current canvas to be the visible screen
 110 // the idea is you're not page flipping or blitting
 111 // in fact, if you do an end_frame in this mode, you get
 112 // an error
 113 EXTERN void ScrnSetVisible(void);
 114
 115 // set the current canvas to be the offscreen canvas(default)
 116 EXTERN void ScrnSetOffscreen(void);
 117
 118 // get a pointer to the draw (i.e., "offscreen") canvas
 119 EXTERN grs_canvas *ScrnGetDrawCanvas(void);
 120
 121 // load and use this palette
 122 EXTERN void ScrnNewPalette(uchar *,int start,int size);
 123
 124 // make the current palette black and use it
 125 EXTERN void ScrnNewBlackPalette(void);
 126
 127 // load but do not set this palette
 128 EXTERN void ScrnLoadPalette(uchar *pal,int start,int size);
 129
 130 // set the currently loaded palette
 131 EXTERN void ScrnUsePalette(void);
 132
 133 // return pointer to loaded palette.  Beware, don't mess with it.
 134 EXTERN const uchar *ScrnGetPalette(void);
 135
 136 // return a pointer to the loaded inverse palette.
 137 EXTERN const uchar *ScrnGetInvPalette(void);
 138
 139 // return its size
 140 EXTERN int ScrnInvPaletteSize(void);
 141
 142 // Lock the draw canvas
 143 EXTERN void ScrnLockDrawCanvas(void);
 144
 145 // Unlock the draw canvas
 146 EXTERN void ScrnUnlockDrawCanvas(void);
 147
 148 #endif // __SCRNMAN_H
 149