Main Page   Modules   Data Structures   File List   Globals  

msh_pal.h File Reference

Palette and color functions. More...


Defines

#define RGB(r, g, b)   ((r) | ((g) << 5) | ((b) << 10))
#define SET_COLOR_R(color, r)
#define SET_COLOR_G(color, g)
#define SET_COLOR_B(color, b)
#define GET_COLOR_R(color)   ((color) & 0x001F)
#define GET_COLOR_G(color)   (((color) & 0x03E0) >> 5)
#define GET_COLOR_B(color)   (((color) & 0x7C00) >> 10)
#define set_bgpal_color(index, color)   SET_BGPAL_COLOR(index, color)
#define set_objpal_color(index, color)   SET_OBJPAL_COLOR(index, color)
#define get_bgpal_color(index)   GET_BGPAL_COLOR(index)
#define get_objpal_color(index)   GET_OBJPAL_COLOR(index)
#define load_bgpal(data, index, length, channel)   LOAD_BGPAL(data, index, length, channel)
#define load_objpal(data, index, length, channel)   LOAD_OBJPAL(data, index, length, channel)

Detailed Description

Define Documentation

#define RGB (  r,
g,
b    )     ((r) | ((g) << 5) | ((b) << 10))
 

Parameters:
r  u8 [0..31] Red
g  u8 [0..31] Green
b  u8 [0..31] Blue
Returns:
u16 15 bit Color
Returns a 15 bit color

#define SET_COLOR_R (  color,
r    ) 
 

Value:

{(color) &= 0xFFE0; \
    (color) |= (r);}
Parameters:
color  u16 15 bit color
r  u8 [0..31] Red
Sets the red content of color

#define SET_COLOR_G (  color,
g    ) 
 

Value:

{(color) &= 0xFC1F; \
    (color) |= (g) << 5;}
Parameters:
color  u16 15 bit color
g  u8 [0..31] Green
Sets the green content of color

#define SET_COLOR_B (  color,
b    ) 
 

Value:

{(color) &= 0x83FF; \
    (color) |= (b) << 10;}
Parameters:
color  u16 15 bit color
b  u8 [0..31] Blue
Sets the blue content of color

#define GET_COLOR_R (  color    )     ((color) & 0x001F)
 

Parameters:
color  u16 15 bit color
Returns:
u8 [0..31] Red
Returns the red content of color

#define GET_COLOR_G (  color    )     (((color) & 0x03E0) >> 5)
 

Parameters:
color  u16 15 bit color
Returns:
u8 [0..31] Green
Returns the green content of color

#define GET_COLOR_B (  color    )     (((color) & 0x7C00) >> 10)
 

Parameters:
color  u16 15 bit color
Returns:
u8 [0..31] Blue
Returns the blue content of color

#define set_bgpal_color (  index,
color    )     SET_BGPAL_COLOR(index, color)
 

Parameters:
index  u8 [0..255] Bg Color
color  u16 15 bit Color

#define set_objpal_color (  index,
color    )     SET_OBJPAL_COLOR(index, color)
 

Parameters:
index  u8 [0..255] Obj Color
color  u16 15 bit Color

#define get_bgpal_color (  index    )     GET_BGPAL_COLOR(index)
 

Parameters:
index  u8 [0..255] Bg Color
Returns:
color u16 15 bit Color

#define get_objpal_color (  index    )     GET_OBJPAL_COLOR(index)
 

Parameters:
index  u8 [0..255] Obj Color
Returns:
color u16 15 bit Color

#define load_bgpal (  data,
index,
length,
channel    )     LOAD_BGPAL(data, index, length, channel)
 

Parameters:
data  void* Pointer to palette data
index  u8 [0..255] Starting color index
length  u16 [0..256] Number of colors to load
channel  u8 [CPY] Copy type
dmemcpy() type defines:
These are Mushroom specific, not GBA values. 
 */
#define CPY_DMA0
#define CPY_DMA1
#define CPY_DMA2
#define CPY_DMA3
#define CPY_MEMCPY

#define load_objpal (  data,
index,
length,
channel    )     LOAD_OBJPAL(data, index, length, channel)
 

Parameters:
data  void* Pointer to palette data
index  u8 [0..255] Starting color index
length  u16 [0..256] Number of colors to load
channel  u8 [CPY] Copy type
dmemcpy() type defines:
These are Mushroom specific, not GBA values. 
 */
#define CPY_DMA0
#define CPY_DMA1
#define CPY_DMA2
#define CPY_DMA3
#define CPY_MEMCPY

Generated on Wed May 19 21:45:08 2004 for Mushroom GBALib by doxygen 1.2.18