clip.h File Reference

Clipping of a rectangular region. More...

Go to the source code of this file.

Functions
void	clip (struct box *const io_area, struct box const *const i_clip)
	clip a rectangular region More...
void	clip_cleanup ()
	release resources held by the global clip object More...
void	clip_get (struct box *const o_box)
	get the current clipping boundary More...
void	clip_push (struct box const *const i_box)
	pushes a clip region onto the top of the stack More...
void	clip_pop ()
	removes a clip region from the top of the stack More...

Detailed Description

Clipping of a rectangular region.

Function Documentation

clip()

void clip	(	struct box *const	io_area,
		struct box const *const	i_clip
	)

clip a rectangular region

Parameters

[in,out]	io_area	region to clip
[in]	i_clip	clipping boundaries

Returns

none

clip_cleanup()

void clip_cleanup

(

)

release resources held by the global clip object

This routine should be called when the application exits to release resources created by the clip routines.

clip_get()

void clip_get

(

struct box *const

o_box

)

get the current clipping boundary

Parameters

[out]

o_box

clipping region to fill in

Returns

none The default clipping region is the screen area.

clip_pop()

void clip_pop

(

)

removes a clip region from the top of the stack

Returns

none

clip_push()

void clip_push

(

struct box const *const

i_box

)

pushes a clip region onto the top of the stack

Parameters

[in]

i_box

clipping region to push on the stack

Returns

none