/*
	vid.h

	video driver defs

	Copyright (C) 1996-1997  Id Software, Inc.

	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU General Public License
	as published by the Free Software Foundation; either version 2
	of the License, or (at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

	See the GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program; if not, write to:

		Free Software Foundation, Inc.
		59 Temple Place - Suite 330
		Boston, MA  02111-1307, USA

	$Id$
*/

#ifndef __vid_h_
#define __vid_h_

#include "QF/qtypes.h"

#define VID_CBITS	6
#define VID_GRADES	(1 << VID_CBITS)

struct cvar_s;
extern byte   *vid_basepal;
extern byte   *vid_colormap;

typedef struct vrect_s {
	int				x,y,width,height;
	struct vrect_s	*pnext;
} vrect_t;

typedef struct {
	qboolean		initialized;
	pixel_t			*buffer;		// invisible buffer
	short			*zbuffer;
	void			*surfcache;
	pixel_t			*colormap;		// 256 * VID_GRADES size
	unsigned short	*colormap16;	// 256 * VID_GRADES size
	int				fullbright;		// index of first fullbright color
	unsigned int	rowbytes;		// may be > width if displayed in a window
	unsigned int	width;		
	unsigned int	height;
	float			aspect;			// width / height -- < 0 is taller than wide
	int				numpages;
	int				recalc_refdef;	// if true, recalc vid-based stuff
	pixel_t			*conbuffer;
	int				conrowbytes;
	unsigned int	conwidth;
	unsigned int	conheight;
	int				maxwarpwidth;
	int				maxwarpheight;
	pixel_t			*direct;		// direct drawing to framebuffer, if not
									//  NULL
	int				(*surf_cache_size)(int width, int height);
	void			(*flush_caches)(void);
	void			(*init_caches)(void *cache, int size);
	void			(*do_screen_buffer)(void);
} viddef_t;

extern viddef_t 		vid;				// global video state
extern unsigned short	d_8to16table[256];
extern unsigned int 	d_8to24table[256];

extern int				scr_width, scr_height;
extern qboolean 		DDActive;
extern byte 			gammatable[256];
extern qboolean			vid_gamma_avail;

// called at startup and after any gamma correction
void VID_SetPalette (unsigned char *palette);

// called for bonus and pain flashes, and for underwater color changes
void VID_ShiftPalette (unsigned char *palette);

void VID_Init_Cvars (void);

// Called at startup to set up translation tables, takes 256 8 bit RGB values
// the palette data will go away after the call, so it must be copied off if
// the video driver will need it again
void VID_Init (unsigned char *);

// Called at shutdown
void VID_Shutdown (void);

// flushes the given rectangles from the view buffer to the screen
void VID_Update (vrect_t *rects);

// sets the mode; only used by the Quake engine for resetting to mode 0 (the
// base mode) on memory allocation failures
// or not
// int VID_SetMode (int modenum, unsigned char *palette);

// called only on Win32, when pause happens, so the mouse can be released
void VID_HandlePause (qboolean pause);

void VID_InitBuffers (void);
void VID_LockBuffer (void);
void VID_UnlockBuffer (void);

qboolean VID_Is8bit (void);

void VID_RaiseWindow (void);
void VID_MinimiseWindow (void);
void VID_SetCaption (const char *text);
// used to set window caption

void VID_GetWindowSize (int def_w, int def_h);

int VID_ForceUnlockedAndReturnState (void);
void VID_ForceLockState (int lk);

void VID_InitGamma (unsigned char *);
double VID_GetGamma (void);
qboolean VID_SetGamma (double);
void VID_UpdateGamma (struct cvar_s *);

#endif	// __vid_h_