CANVAS_PROTO_REFRESH_FUNC(3)

PROTO_FUNC
canvas_PROTO_refresh_func - Refresh event callback.

SYNOPSIS
#include <karma_canvas.h>

void canvas_PROTO_refresh_func

(KWorldCanvas canvas, int width, int height, CONST struct win_scale_type *win_scale, Kcolourmap cmap, flag cmap_resize, void **info, PostScriptPage pspage, unsigned int num_areas, KPixCanvasRefreshArea *areas, flag *honoured_areas)

DESCRIPTION
This routine is a refresh event consumer for a world canvas.

canvas
    The world canvas being refreshed.

width
    The width of the canvas in pixels.

height
    The height of the canvas in pixels.

win_scale
    A pointer to the window scaling information. The data are only valid during this callback.

cmap
    The colourmap associated with the canvas.

cmap_resize
    TRUE if the refresh function was called as a result of a colourmap resize, else FALSE.

info
    A pointer to the arbitrary canvas information pointer.

pspage
    If not NULL, the PostScriptPage object the refresh is redirected to.

num_areas
    The number of areas that need to be refreshed. If this is 0 then the entire pixel canvas needs to be refreshed.

areas
    The list of areas that need to be refreshed. Note that these areas are given in pixel co-ordinates.

honoured_areas
    If the value TRUE is written here it is assumed the routine honoured the list of refresh areas and did not write outside these areas and hence the list of areas will be passed to subsequent registered refresh routines. If FALSE is written here (or nothing is written here), implying the routine refreshed the entire canvas, subsequent refresh routines will be told to refresh the entire canvas.

RETURN VALUE
Nothing.

Multi-threading Level
Unsafe.

AUTHOR
Richard Gooch (rgooch@atnf.csiro.au)

AVAILABLITY
The Karma Distribution is available for anonymous ftp from: ftp://ftp.atnf.csiro.au/pub/software/karma/ ftp://wuarchive.wustl.edu/graphics/graphics/packages/karma/ ftp://ftp.pwr.wroc.pl/pub/karma/ The Karma Home Page is: http://www.atnf.csiro.au/karma/