source/graphics/inc/mg_osd.h File Reference

Interface to OSD. More...

#include "mg_ctxt.h"
#include "osdtypes.h"

Go to the source code of this file.

Data Structures
struct	s_surface
Defines
#define	SRF_TYPE_TXT   0
#define	SRF_TYPE_PNG   1
#define	SRF_TYPE_JPG   2
#define	SRF_TYPE_DLA   3
#define	MG_OSDMhegInit(x, y, s)   MG_OSDMhegInit(x, y)
#define	OSD_DbgAddSurf(s)
#define	OSD_DbgRemSurf(s)
#define	OSD_DbgListSurf()
Typedefs
typedef struct s_surface	S_SURFACE
Functions
void	MG_OSDMhegInit (U16BIT inWidth, U16BIT inHeight, E_SCENE_ASPECT sar)
	Initialise the on screen display Initialise the font and fill in font info.
void	MG_OSDInit (U16BIT inWidth, U16BIT inHeight, U16BIT outWidth, U16BIT outHeight)
void	MG_DisplayImage (S_SURFACE *data, S_REGION *overlap, S32BIT x, S32BIT y)
	Copy the image to the screen buffer.
E_MhegErr	MG_Initialise (U16BIT screenWidth, U16BIT screenHeight, U8BIT colourDepth)
	Initialise OSD, font, and font fill information. Should only be called at start up.
void	MG_Terminate (void)
	Free all OSD resources.
BOOLEAN	MG_IsHdSupported (void)

---

Detailed Description

Interface to OSD.

Date:

28/05/2008

Author:

Adam Sturtridge

---

Function Documentation

void MG_DisplayImage	(	S_SURFACE *	surf,
		S_REGION *	overlap,
		S32BIT	x,
		S32BIT	y
	)

Copy the image to the screen buffer.

Parameters:

S_SURFACE*	surf pointer to S_SURFACE object
S_REGION*	overlap region to display
int	x left coord (in screen resolution)
int	y top coord (in screen resolution)

Warning:

Bug:

Parameters:

S_SURFACE*	surf pointer to S_SURFACE object
S_REGION*	overlap region to display
int	x left coord (in screen resolution)
int	y top coord (in screen resolution)

Warning:

Bug:

void MG_OSDMhegInit	(	U16BIT	inWidth,
		U16BIT	inHeight,
		E_SCENE_ASPECT	sar
	)

Initialise the on screen display Initialise the font and fill in font info.

Parameters:

sizeX	width in pixels of the screen
sizeY	height in pixels of the screen
sar	scene aspect ratio

Returns:

void

void MG_Terminate

(

void

)

Free all OSD resources.

Parameters:

None