head 1.1; branch 1.1.1; access ; symbols start:1.1.1.1 PAlibDoc:1.1.1; locks ; strict; comment @# @; 1.1 date 2005.11.02.08.30.25; author jandujar; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2005.11.02.08.30.25; author jandujar; state Exp; branches ; next ; desc @@ 1.1 log @Initial revision @ text @ PA_lib: Palette system
Main Page | Modules | File List | Globals | Search for 

Palette system


Defines

#define PA_LoadPal(palette, source)   DMA_Copy((void*)source, (void*)palette, 256, DMA_16NOW);
 Load a 256 color palette in the Bg or Sprite palette of screen 0 or 1. Ex : PA_LoadPal(PALETTE_BG1, bg_pal);
#define PA_LoadPal16(palette, n_palette, source)   DMA_Copy((void*)source, (void*)(palette + (n_palette << 5)), 16, DMA_16NOW);
 Load a 16 color palette in the Bg or Sprite palette of screen 0 or 1. Ex : PA_LoadPal16(PALETTE_BG1, 4, bg_pal);
#define PA_RGB(r, g, b)   ((1 << 15) + (r) + ((g)<<5) + ((b)<<10))
 Convert Red, Green, and Blue color indexes into a number used in the palette system. Careful : the R, G, B values range from 0 to 31 on gba !
#define PA_SetBgPalCol(screen, color_number, colorRGB)   BG_PALETTE[color_number + (screen << 9)] = colorRGB
 Change de color of one of the background palette colors
#define PA_SetSpritePalCol(screen, color_number, colorRGB)   BG_PALETTE[256 + color_number + (screen << 9)] = colorRGB
 Change de color of one of the sprite palette colors

Functions

void PA_SetBrightness (bool screen, s8 bright)
 Set the screen's brightness
void PA_SetPalNeg (u32 palette)
 Set all the palette's color to negative. To undo this, simply negative again...
void PA_SetPal16Neg (u32 palette, u8 n_palette)
 Set 16 color palette to negative. To undo this, simply negative again...
void PA_InitSpriteExtPal (void)
 Initialise 16 palette mode for 256 color sprites
void PA_InitBgExtPal (void)
 Initialise 16 palette mode for 256 color backgrounds
void PA_LoadSpriteExtPal (bool screen, u16 palette_number, void *palette)
 Load a 256 color palette in the Sprite extended palettes
void PA_LoadBgExtPal (bool screen, u16 palette_number, void *palette)
 Load a 256 color palette in the Background extended palettes

Detailed Description

Load palettes, change palette colors, set the gamma, etc...

Define Documentation

#define PA_LoadPal (  palette,
source   )     DMA_Copy((void*)source, (void*)palette, 256, DMA_16NOW);
 

Load a 256 color palette in the Bg or Sprite palette of screen 0 or 1. Ex : PA_LoadPal(PALETTE_BG1, bg_pal);

Parameters:
palette Set the Bg palette or Obj palette, screen 0 or 1 : PAL_BG0, PAL_SPRITE0, PAL_BG1, or PAL_SPRITE1
source Palette name (ex : master_Palette)

#define PA_LoadPal16 (  palette,
n_palette,
source   )     DMA_Copy((void*)source, (void*)(palette + (n_palette << 5)), 16, DMA_16NOW);
 

Load a 16 color palette in the Bg or Sprite palette of screen 0 or 1. Ex : PA_LoadPal16(PALETTE_BG1, 4, bg_pal);

Parameters:
palette Set the Bg palette or Obj palette, screen 0 or 1 : PAL_BG0, PAL_SPRITE0, PAL_BG1, or PAL_SPRITE1
n_palette Number of the 16 color palette to load (0-15)
source Palette name (ex : master_Palette)

#define PA_RGB (  r,
g,
b   )     ((1 << 15) + (r) + ((g)<<5) + ((b)<<10))
 

Convert Red, Green, and Blue color indexes into a number used in the palette system. Careful : the R, G, B values range from 0 to 31 on gba !

Parameters:
r Red (0-31)
g Green (0-31)
b Blue (0-31)

#define PA_SetBgPalCol (  screen,
color_number,
colorRGB   )     BG_PALETTE[color_number + (screen << 9)] = colorRGB
 

Change de color of one of the background palette colors

Parameters:
screen Screen...
color_number Color number in palette (0-255)
colorRGB RGB value, like PA_RGB(31, 31, 31) for white

#define PA_SetSpritePalCol (  screen,
color_number,
colorRGB   )     BG_PALETTE[256 + color_number + (screen << 9)] = colorRGB
 

Change de color of one of the sprite palette colors

Parameters:
screen Screen...
color_number Color number in palette (0-255)
colorRGB RGB value, like PA_RGB(31, 31, 31) for white

Function Documentation

void PA_LoadBgExtPal (  bool  screen,
u16  palette_number,
void *  palette
) 
 

Load a 256 color palette in the Background extended palettes

Parameters:
screen Screen...
palette_number Palette number (0-15)
palette Palette to load ((void*)palette_name)

void PA_LoadSpriteExtPal (  bool  screen,
u16  palette_number,
void *  palette
) 
 

Load a 256 color palette in the Sprite extended palettes

Parameters:
screen Screen...
palette_number Palette number (0-15)
palette Palette to load ((void*)palette_name)

void PA_SetBrightness (  bool  screen,
s8  bright
) 
 

Set the screen's brightness

Parameters:
screen Chose de screen (0 or 1)
bright Brightness level, from -32 to 32, 0 being neutral

inline void PA_SetPal16Neg (  u32  palette,
u8  n_palette
)  [inline]
 

Set 16 color palette to negative. To undo this, simply negative again...

Parameters:
palette Set the Bg palette or Obj palette, screen 0 or 1 : PAL_BG0, PAL_SPRITE0, PAL_BG1, or PAL_SPRITE1
n_palette Number of the 16 color palette (0-15)

inline void PA_SetPalNeg (  u32  palette  )  [inline]
 

Set all the palette's color to negative. To undo this, simply negative again...

Parameters:
palette Set the Bg palette or Obj palette, screen 0 or 1 : PAL_BG0, PAL_SPRITE0, PAL_BG1, or PAL_SPRITE1

Generated on Fri Oct 28 23:16:51 2005 for PA_lib by  doxygen 1.3.9.1
@ 1.1.1.1 log @Initial import of PalibDoc, begin on PAlib0.64b @ text @@