Background Functions

Functions

• void hel_BgSetMode (u32 Mode)

  Set background mode.
  

• void hel_BgSetMosaic (u32 BgNo, u32 Value)

  Set BG Mosaic.
  

• void hel_BgSetMosaicSize (u32 HSize, u32 VSize)

  Set BG Mosaic Size.
  

• void hel_BgSetPrio (u32 BgNo, u32 Prio)

  Set BG Priority.
  

---

Function Documentation

void hel_BgSetMode

(

u32

Mode

)

Set background mode.

The hel_BgSetMode function sets the background mode.

Parameters:

[in]

Mode

This value can be between 0..5. See notes for details.

Note:

Depending on the background mode, the hardware uses different background layers which support different features. Here is an overview:

Mode | Layer 0  | Layer 1 | Layer 2 | Layer 3
-----+----------+---------+---------+-----------
  0  |     yes  |     yes |     yes |     yes
  1  |     yes  |     yes | yes/rot |      no
  2  |      no  |      no | yes/rot | yes/rot
  3  |      no  |      no | yes/bmp |      no
  4  |      no  |      no | yes/bmp |      no
  5  |      no  |      no | yes/bmp |      no
-----+----------+---------+---------+-----------

void hel_BgSetMosaic	(	u32	BgNo,
		u32	Value
	)

Set BG Mosaic.

The hel_BgSetMosaic function enables or disables mosaic processing for the background specified by BgNo.

Parameters:

[in]	BgNo	Background number you want to set mosaic for
[in]	Value	TRUE to enable or FALSE to disable mosaic processing

See also:

hel_BgSetMosaicSize

void hel_BgSetMosaicSize	(	u32	HSize,
		u32	VSize
	)

Set BG Mosaic Size.

The hel_BgSetMosaicSize function sets the horizontal and vertical mosaic size for the BG system. The background mosaic size applies to all backgrounds with mosaic enabled (hel_BgSetMosaic).

Parameters:

[in]	HSize	Horizontal Size of Mosaic (0..15)
[in]	VSize	Vertical Size of Mosaic (0..15)

See also:

hel_BgSetMosaic

void hel_BgSetPrio	(	u32	BgNo,
		u32	Prio
	)

Set BG Priority.

The hel_BgSetPrio function sets the priority of the background specified by BgNo to the new priority value specified by Prio.

Parameters:

[in]	BgNo	Background number
[in]	Prio	The new priority. Must be between 0..3

---