mg_osd.h File Reference

Interface to OSD. More...

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

Go to the source code of this file.

Classes
struct	s_surface

Macros
#define	SRF_TYPE_TXT   0
#define	SRF_TYPE_PNG   1
#define	SRF_TYPE_JPG   2
#define	SRF_TYPE_DLA   3
#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_ASPECT_RATIO sar)
	Initialise the on screen display Initialise the font and fill in font info. More...
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. More...
E_MhegErr	MG_Initialise (U16BIT screenWidth, U16BIT screenHeight, U8BIT colourDepth)
	Initialise OSD, font, and font fill information. Should only be called at start up. More...
void	MG_Terminate (void)
	Free all OSD resources. More...
BOOLEAN	MG_IsHdSupported (void)

Detailed Description

Interface to OSD.

Date

28/05/2008

Author

Adam Sturtridge

Definition in file mg_osd.h.

Macro Definition Documentation

#define OSD_DbgAddSurf

(

s

)

Definition at line 90 of file mg_osd.h.

#define OSD_DbgListSurf

(

)

Definition at line 92 of file mg_osd.h.

#define OSD_DbgRemSurf

(

s

)

Definition at line 91 of file mg_osd.h.

#define SRF_TYPE_DLA   3

Definition at line 35 of file mg_osd.h.

#define SRF_TYPE_JPG   2

Definition at line 34 of file mg_osd.h.

#define SRF_TYPE_PNG   1

Definition at line 33 of file mg_osd.h.

#define SRF_TYPE_TXT   0

Definition at line 32 of file mg_osd.h.

Typedef Documentation

typedef struct s_surface S_SURFACE

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:

Definition at line 1266 of file mg_osd.c.

E_MhegErr MG_Initialise	(	U16BIT	screenWidth,
		U16BIT	screenHeight,
		U8BIT	colourDepth
	)

Initialise OSD, font, and font fill information. Should only be called at start up.

Definition at line 281 of file mg_osd.c.

BOOLEAN MG_IsHdSupported

(

void

)

Definition at line 171 of file mg_osd.c.

void MG_OSDInit	(	U16BIT	inWidth,
		U16BIT	inHeight,
		U16BIT	outWidth,
		U16BIT	outHeight
	)

Definition at line 182 of file mg_osd.c.

void MG_OSDMhegInit	(	U16BIT	inWidth,
		U16BIT	inHeight,
		E_ASPECT_RATIO	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

Definition at line 250 of file mg_osd.c.

void MG_Terminate

(

void

)

Free all OSD resources.

Parameters

None

Definition at line 367 of file mg_osd.c.