Documentation from template.h

Introduction	[top]

ROV - Easy applications from C

Copyright - © Jason Tribbeck / 7th ARM 1994-2001

Contributing authors - Jason Tribbeck

File - template.h

Type - helper

Description

This is an experimental interface to the WIMP's template calls.

template_open	[top]

Open a template file.

Parameters:

 - char *file_name - the name of the file.

Returns:

 -  non-zero for success, zero for failure.

int template_open(char *file_name);

template_close	[top]

Close a template file.

Returns:

 -  non-zero for success, zero for failure.

int template_close(void);

template_canvas	[top]

Create a canvas from a template.

Parameters:

 - char *name - the template name.
 - char *ind_buffer - the pointer to the start of the indirected data buffer.
 - char *ind_end - the pointer to the end of the indirected data buffer.

Returns:

 -  the created canvas, or NULL if unable to create.

Note - template_data is updated to point to the end of indirected data after creating a canvas. This allows subsequent calls to fill up a global buffer.

canvas template_canvas(char *name,
		       char *ind_buffer,
		       char *ind_end);

See also: template_data

template_setworkspace	[top]

Sets the address of temporary workspace.

Parameters:

 - char *addr - the address.

void template_setworkspace(char *addr);

template_setspritearea	[top]

Sets the sprite area pointer for subsequent template canvas creation.

Parameters:

 - void *area - the pointer to the sprite area.

Returns:

 -  the old pointer.

void *template_setspritearea(void *area);

template_data (external variable)	[top]

Points to the end of the indirected data after creating a canvas.

extern char *template_data;

See also: template_canvas()

Generated Thu Feb 7 23:22:52 2002