Bitmap Mode Functions

Functions


Function Documentation

void hel_BmpClear ( u16  Color  ) 

Clear screen/backbuffer in mode 3, 4 or 5.

Parameters:
[in] Color The PaletteIndex in mode4 and the bgr555 color value in mode 3 and 5
The hel_BmpClear function clears the screen with the specified color in mode 3, and clears the backbuffer in mode 4 and 5.

Note:
In mode 3 and 5 use RGB_SET to generate a color in bgr555 format.

void hel_BmpFlipBackBuffer ( void   ) 

Flip back buffer.

The hel_BmpFlipBackBuffer function flips the front- with the back-buffer, so the content of the back-buffer becomes visible.

u16* hel_BmpGetBackBuffer ( void   ) 

Get a pointer to the backbuffer in mode 4 or 5.

Returns:
The hel_BmpGetBackBuffer function returns a pointer to the current backbuffer
Note:
Only mode 4 and 5 have a backbuffer.

u32 hel_BmpHasBackBuffer ( void   ) 

Check if current bitmap mode has a backbuffer.

Returns:
The hel_BmpHasBackBuffer function returns TRUE if the bitmap mode has a BackBuffer, otherwise FALSE.

u32 hel_BmpIsHighColor ( void   ) 

Check if current bitmap mode is high color.

Returns:
The hel_BmpIsHighColor function returns TRUE if the current bitmap mode is in high color format, otherwise FALSE.

void hel_BmpLoad ( const void *  pSrc  ) 

Load a graphic into Vram.

Parameters:
[in] pSrc Pointer to source graphic data.
Note:
The graphic data has to be in the following format:
  • Mode 3 : 240*160 pixels, 15bit BGR
  • Mode 4 : 240*160 pixels, 8 bit
  • Mode 5 : 160*120 pixels, 15bit BGR
See also:
hel_BmpLoadUnComp

void hel_BmpLoadUnComp ( const void *  pSrc,
u32  CompressionType 
)

Load a compressed graphic into Vram.

Parameters:
[in] pSrc Pointer to compressed source graphic data.
[in] CompressionType Type of Compression the graphic data uses. This can be one of the COMPRESSION_TYPE_* predefined values.
Note:
The graphic data has to be in the following format:
  • Mode 3 : 240*160 pixels, 15bit BGR
  • Mode 4 : 240*160 pixels, 8 bit
  • Mode 5 : 160*120 pixels, 15bit BGR
See also:
hel_BmpLoad, hel_SwiUnComp


Generated on Fri Aug 17 12:12:38 2007 for HEL Library by  doxygen 1.5.3