source/graphics/inc/dla_inl.h File Reference

MHEG-5 Graphics: Dynamic Line-Art utility functions. More...

#include "osdtypes.h"

Go to the source code of this file.

Data Structures
struct	_point
struct	point_list
struct	polygon
struct	DLA_struct
Typedefs
typedef struct _point	S_POINT
typedef struct point_list	S_POINT_LIST
typedef struct polygon	S_POLYGON
typedef struct DLA_struct	DLA_Surface
Functions
void DLA_FUNCTION()	Line (DLA_Surface *canvas, S16BIT x1, S16BIT y1, S16BIT x2, S16BIT y2, U16BIT width, DLAColor colour)
	Draw a line on the canvas.
void DLA_FUNCTION()	Polygon (DLA_Surface *canvas, S_POLYGON poly, U16BIT width, DLAColor fill_colour, DLAColor line_colour)
	Draw a polygon on the canvas.
void DLA_FUNCTION()	Polyline (DLA_Surface *canvas, S_POLYGON poly, U16BIT width, DLAColor colour)
	Draw a polyline (sequence of connected lines) on the canvas.
void DLA_FUNCTION()	Rectangle (DLA_Surface *canvas, S16BIT x1, S16BIT y1, S16BIT x2, S16BIT y2, U16BIT x_lw, U16BIT y_lw, DLAColor fill_colour, DLAColor line_colour)
	Draw a rectangle on the canvas.
void DLA_FUNCTION()	Ellipse (DLA_Surface *canvas, S16BIT x, S16BIT y, U16BIT w, U16BIT h, U16BIT width, DLAColor fill_colour, DLAColor line_colour)
	Draw an ellipse ("oval") on the canvas.
void DLA_FUNCTION()	Arc (DLA_Surface *canvas, S16BIT x, S16BIT y, U16BIT w, U16BIT h, U16BIT start, U16BIT arc, U16BIT width, DLAColor colour)
	Draw an arc on the canvas.
void DLA_FUNCTION()	Sector (DLA_Surface *canvas, S16BIT x, S16BIT y, U16BIT w, U16BIT h, U16BIT start, U16BIT arc, U16BIT width, DLAColor fill_colour, DLAColor line_colour)
	Draw a sector ("pie slice") on the canvas.
void DLA_FUNCTION()	Border (DLA_Surface *canvas, U16BIT x1_bw, U16BIT y1_bw, U16BIT x2_bw, U16BIT y2_bw, DLAColor line_colour)
	Draw a border around the canvas.

---

Detailed Description

MHEG-5 Graphics: Dynamic Line-Art utility functions.

Date:

10th July 2008

Author:

Adam Sturtridge

---

Function Documentation

void DLA_FUNCTION() Arc	(	DLA_Surface *	canvas,
		S16BIT	x,
		S16BIT	y,
		U16BIT	w,
		U16BIT	h,
		U16BIT	start,
		U16BIT	arc,
		U16BIT	width,
		DLAColor	colour
	)

Draw an arc on the canvas.

Parameters:

S16BIT	x Left position of bounding rect
S16BIT	y Top position of bounding rect
U16BIT	w Width of bounding rect
U16BIT	h Height of bounding rect
U16BIT	start Start angle in 64ths of a degree
U16BIT	arc Arc angle in 64ths of a degree
U16BIT	width Width of ellipse outline
DLAColor	colour Colour to use for arc

Returns:

BOOLEAN Success status of operation

void DLA_FUNCTION() Border	(	DLA_Surface *	canvas,
		U16BIT	x1_bw,
		U16BIT	y1_bw,
		U16BIT	x2_bw,
		U16BIT	y2_bw,
		DLAColor	line_colour
	)

Draw a border around the canvas.

Parameters:

U16BIT	x1_bw left horizontal border width
U16BIT	y1_bw top vertical border width
U16BIT	x2_bw right horizontal border width
U16BIT	y2_bw bottom vertical border width
DLAColor	line_colour Colour to use for border

Returns:

BOOLEAN Success status of operation

void DLA_FUNCTION() Ellipse	(	DLA_Surface *	canvas,
		S16BIT	x,
		S16BIT	y,
		U16BIT	w,
		U16BIT	h,
		U16BIT	width,
		DLAColor	fill_colour,
		DLAColor	line_colour
	)

Draw an ellipse ("oval") on the canvas.

Parameters:

S16BIT	x Left position of bounding rect
S16BIT	y Top position of bounding rect
U16BIT	w Width of bounding rect
U16BIT	h Height of bounding rect
U16BIT	width Width of ellipse outline
DLAColor	fill_colour Colour to use for filling
DLAColor	line_colour Colour to use for outline

Returns:

BOOLEAN Success status of operation

void DLA_FUNCTION() Line	(	DLA_Surface *	canvas,
		S16BIT	x1,
		S16BIT	y1,
		S16BIT	x2,
		S16BIT	y2,
		U16BIT	width,
		DLAColor	colour
	)

Draw a line on the canvas.

Parameters:

S16BIT	x1 x-coordinate of first point
S16BIT	y1 y-coordinate of first point
S16BIT	x2 x-coordinate of second point
S16BIT	y2 y-coordinate of second point
U16BIT	width Width of line in pixels
DLAColor	colour Colour for line

Returns:

BOOLEAN Success status of operation

void DLA_FUNCTION() Polygon	(	DLA_Surface *	canvas,
		S_POLYGON	poly,
		U16BIT	width,
		DLAColor	fill_colour,
		DLAColor	line_colour
	)

Draw a polygon on the canvas.

Parameters:

S_POINT	* points List of points
U16BIT	num_points Number of points in list
U16BIT	width Width of polygon outline
DLAColor	fill_colour Colour to use for filling
DLAColor	line_colour Colour to use for outline

Returns:

BOOLEAN Success status of operation

void DLA_FUNCTION() Polyline	(	DLA_Surface *	canvas,
		S_POLYGON	poly,
		U16BIT	width,
		DLAColor	colour
	)

Draw a polyline (sequence of connected lines) on the canvas.

Parameters:

S_POINT	* points List of points
U16BIT	num_points Number of points in list
U16BIT	width Width of lines in polyline
DLAColor	colour Colour to use for lines

Returns:

BOOLEAN Success status of operation

void DLA_FUNCTION() Rectangle	(	DLA_Surface *	canvas,
		S16BIT	x1,
		S16BIT	y1,
		S16BIT	x2,
		S16BIT	y2,
		U16BIT	x_lw,
		U16BIT	y_lw,
		DLAColor	fill_colour,
		DLAColor	line_colour
	)

Draw a rectangle on the canvas.

Parameters:

S16BIT	x1 Left position of rectangle
S16BIT	y1 Top position of rectangle
S16BIT	x2 Right position of rectangle
S16BIT	y2 Bottom position of rectangle
U16BIT	x_lw horizontal outline width
U16BIT	y_lw vertical outline width
DLAColor	fill_colour Colour to use for filling
DLAColor	line_colour Colour to use for outline

Returns:

BOOLEAN Success status of operation 8 pixels high and 8 pixels wide rectangle.

void DLA_FUNCTION() Sector	(	DLA_Surface *	canvas,
		S16BIT	x,
		S16BIT	y,
		U16BIT	w,
		U16BIT	h,
		U16BIT	start,
		U16BIT	arc,
		U16BIT	width,
		DLAColor	fill_colour,
		DLAColor	line_colour
	)

Draw a sector ("pie slice") on the canvas.

Parameters:

S16BIT	x Left position of bounding rect
S16BIT	y Top position of bounding rect
U16BIT	w Width of bounding rect
U16BIT	h Height of bounding rect
U16BIT	start Start angle in 64ths of a degree
U16BIT	arc Arc angle in 64ths of a degree
U16BIT	width Width of ellipse outline
DLAColor	fill_colour Colour to use for filling
DLAColor	line_colour Colour to use for outline

Returns:

BOOLEAN Success status of operation the sector is not rendered properly.