source/graphics/inc/mg_api.h File Reference

#include "mh5visible.h"
#include "stb_osd.h"

Go to the source code of this file.

Defines
#define	MG_OSDUpdate   STB_OSDMhegUpdate
Functions
void	MG_DrawPng (void *data, int len, MHEG5Visible *visible)
void	MG_DrawJpg (void *data, int len, MHEG5Visible *visible)
void	MG_FreeData (void *data)
	free surface buffer
void	MG_OSDdisplayBitmap (MHEG5Visible *visible, S_REGION *overlap)
void	MG_OSDdisplayImage (void *data, S_REGION *overlap, int x, int y)
void	MG_OSDdisplayDynamicLineart (void *data, S_REGION *overlap, int x, int y)
	Display dynamic lineart.
void	MG_OSDdisplayRectangle (S_REGION *overlap, int x, int y, int width, int height, int lineWidth, OSDColor lineColour, OSDColor fillColour)
	Draw rectangle.
void	MG_OSDdisplayVideo (S_REGION rgn)
	Display video window.
void	MG_OSDerase (S_REGION rgn, OSDColor colour)
	Erase an area of the OSD to the desktop colour.
void	MG_OSDclear (void)
	Clear the screen, making it the specified colour.
void	MG_OSDstartTextOutput (S_REGION *overlap, int boxX1, int boxY1, int boxWidth, int boxHeight, OSDColor backColour, int psize)
	Start text output.
void	OSDsetTextColour (OSDColor foreColour)
	Set the foreground colour of text.
void	OSDdisplayChar (unsigned short c, int x, int y)
	Display the character.
void	OSDendTextOutput (void)
	End text output externals platform dependent.
int	OSDgetCharWidth (unsigned short c)
	Return the width of a character in font metrics units See UK MHEG5 profile 1.05 Section 5.5.3 for details of theory.

---

Detailed Description

Date:

20/12/2012

Author:

Adam Sturtridge

---

Function Documentation

void MG_FreeData

(

void *

data

)

free surface buffer

Parameters:

void*

data pointer to S_SURFACE object

Warning:

Bug:

void MG_OSDclear

(

void

)

Clear the screen, making it the specified colour.

Returns:

void

Clear the screen, making it the specified colour.

Warning:

Bug:

void MG_OSDdisplayDynamicLineart	(	void *	data,
		S_REGION *	overlap,
		int	x,
		int	y
	)

Display dynamic lineart.

Parameters:

void	* data DLA action list

Warning:

Bug:

void MG_OSDdisplayRectangle	(	S_REGION *	overlap,
		int	x,
		int	y,
		int	width,
		int	height,
		int	line_width,
		OSDColor	lineColour,
		OSDColor	fillColour
	)

Draw rectangle.

Parameters:

int

x Box X position on screen (unused by dvp) int y Box Y position on screen (unused by dvp) int width Box width on screen (unused by dvp) int height Box width on screen (unused by dvp) int lineWidth Line width int lineStyle Line style OSDColor lineColour Line colour OSDColor fillColour Rectangle fill colour

Warning:

Bug:

void MG_OSDdisplayVideo

(

S_REGION

rgn

)

Display video window.

Parameters:

int	boxX1 X position on screen int boxY1 Y position on screen int boxWidth Window width int boxHeight Window height

Bug:

void MG_OSDerase	(	S_REGION	rgn,
		OSDColor	colour
	)

Erase an area of the OSD to the desktop colour.

Parameters:

rgn	area to be erased
colour	colour to be set

Returns:

void

Erase an area of the OSD to the desktop colour.

Parameters:

rgn	Region to erase
colour	Desktop colour

Warning:

Bug:

void MG_OSDstartTextOutput	(	S_REGION *	overlap,
		int	boxX1,
		int	boxY1,
		int	boxWidth,
		int	boxHeight,
		OSDColor	backColour,
		int	psize
	)

Start text output.

Parameters:

boxX1	Top left x-co-ord of text box
boxY1	Top left y-co-ord of text box
boxWidth	Width of the text box
boxHeight	Height of the text box
backColour	Colour of the background of the text box
psize	Point size of the font

Returns:

void

void OSDdisplayChar	(	unsigned short	c,
		int	x,
		int	y
	)

Display the character.

Parameters:

c	2nd unicode character
x	x origin
y	y origin

Returns:

void

void OSDendTextOutput

(

void

)

End text output externals platform dependent.

Returns:

void

int OSDgetCharWidth

(

unsigned short

c

)

Return the width of a character in font metrics units See UK MHEG5 profile 1.05 Section 5.5.3 for details of theory.

Parameters:

c	unicode character for which metrics are to be found

Returns:

width of character

void OSDsetTextColour

(

OSDColor

foreColour

)

Set the foreground colour of text.

Parameters:

foreColour

Colour of the text

Returns:

void