pal.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef MADS_CORE_PAL_H
#define MADS_CORE_PAL_H
 
#include "mads/core/general.h"
#include "mads/core/color.h"
 
namespace MADS {
 
/* Palette mapping options to be passed to pal_allocate */
 
#define PAL_MAP_BACKGROUND      0x8000  /* Loading initial background       */
#define PAL_MAP_RESERVED        0x4000  /* Allow mapping of reserved colors */
#define PAL_MAP_ANY_TO_CLOSEST  0x2000  /* Any color can map to closest     */
#define PAL_MAP_ALL_TO_CLOSEST  0x1000  /* Any colors that can map must map */
#define PAL_MAP_TOP_COLORS      0x0800  /* Allow mapping to top four colors */
#define PAL_MAP_DEFINE_RESERVED 0x0400  /* Define initial reserved color    */
 
#define PAL_MAP_MASK            0xfc00  /* Mask for all palette flags on,   */
                    /* so that a routine can accept PAL */
                    /* flags along with other flags of  */
                    /* its own in the same register, &  */
                    /* then forward a clean copy of the */
                    /* PAL flags to pal_allocate().     */
 
 
#define PAL_FORCE_SHADOW        240
 
/* Internal facts */
 
#define PAL_MAXFLAGS            0x20    /* Number of available flags */
 
#define PAL_RESERVED            0x0001  /* ... 0001 */
#define PAL_CYCLE               0x0002  /* ... 0010 */
 
 
/* Returned by pal_deallocate */
 
#define PAL_ERR_BADFLAG         -1      /* Flag number out of range */
#define PAL_ERR_FLAGNOTUSED     -2      /* Attempt to clear unused flag */
 
 
/* Returned by pal_allocate   */
 
#define PAL_ERR_OUTOFFLAGS      -10     /* No available usage flags */
#define PAL_ERR_OUTOFCOLORS     -11     /* Not enough available colors */
 
 
/* Data available to system: */
 
extern Palette master_palette;       /* Main global palette for program */
extern ShadowListPtr master_shadow;  /* Main global shadow color list   */
 
extern dword color_status[256];      /* Mapping status of each palette color */
extern int   flag_used[PAL_MAXFLAGS];/* Mapping status of each palette handle*/
 
extern int palette_locked;
 
extern int palette_low_search_limit; /* Artificial search boundaries */
extern int palette_high_search_limit;
 
extern void (*pal_manager_update)();
extern int pal_manager_active;
extern int pal_manager_colors;
 
 
extern void pal_init(int reserve_bottom, int reserve_top);
 
extern void pal_lock();
extern void pal_unlock();
 
extern int pal_allocate(ColorListPtr new_list, ShadowListPtr shadow_list, int pal_flags);
 
extern int  pal_deallocate(int use_flag);
 
extern void pal_compact(int16 master_handle, int num_slaves, int16 *slave);
 
extern int  pal_get_hash(RGBcolor *one, RGBcolor *two);
 
extern void pal_shadow_sort(ShadowListPtr shadow, ColorListPtr list);
 
extern void pal_init_shadow(ShadowListPtr shadow, ColorListPtr new_list);
extern void pal_activate_shadow(ShadowListPtr shadow);
 
extern int pal_get_flags();
 
extern int pal_get_colors();
extern void pal_interface(Palette &fixpal);
extern void pal_white(Palette &fixpal);
extern void pal_grey(Palette &fixpal, int base_color, int num_colors,
    int low_grey, int high_grey);
extern int pal_get_color(RGBcolor color, int color_handle,
    int override_reserved, int *color_number);
extern void pal_change_color(int color, int r, int g, int b);
 
extern void init_pal();
 
extern int pal_alloc_color(int slot, int allow_shared, int *out_index, const RGBcolor *color);
 
} // namespace MADS
 
#endif