codec/region.h File Reference

#include <freerdp/api.h>
#include <freerdp/types.h>

This graph shows which files directly or indirectly include this file:

Data Structures
struct	REGION16

Functions
FREERDP_API BOOL	rectangles_equal (const RECTANGLE_16 *r1, const RECTANGLE_16 *r2)
FREERDP_API BOOL	rectangles_intersects (const RECTANGLE_16 *r1, const RECTANGLE_16 *r2)
FREERDP_API BOOL	rectangles_intersection (const RECTANGLE_16 *r1, const RECTANGLE_16 *r2, RECTANGLE_16 *dst)
FREERDP_API void	region16_init (REGION16 *region)
FREERDP_API int	region16_n_rects (const REGION16 *region)
FREERDP_API const RECTANGLE_16 *	region16_rects (const REGION16 *region, UINT32 *nbRects)
FREERDP_API const RECTANGLE_16 *	region16_extents (const REGION16 *region)
FREERDP_API BOOL	rectangle_is_empty (const RECTANGLE_16 *rect)
FREERDP_API BOOL	region16_is_empty (const REGION16 *region)
FREERDP_API void	region16_clear (REGION16 *region)
FREERDP_API void	region16_print (const REGION16 *region)
FREERDP_API BOOL	region16_copy (REGION16 *dst, const REGION16 *src)
FREERDP_API BOOL	region16_union_rect (REGION16 *dst, const REGION16 *src, const RECTANGLE_16 *rect)
FREERDP_API BOOL	region16_intersects_rect (const REGION16 *src, const RECTANGLE_16 *arg2)
FREERDP_API BOOL	region16_intersect_rect (REGION16 *dst, const REGION16 *src, const RECTANGLE_16 *arg2)
FREERDP_API void	region16_uninit (REGION16 *region)

Function Documentation

rectangle_is_empty()

FREERDP_API BOOL rectangle_is_empty

(

const RECTANGLE_16 *

rect

)

returns if the rectangle is empty

Parameters

rect	the rectangle to check

Returns

if the rectangle is empty

Here is the caller graph for this function:

rectangles_equal()

FREERDP_API BOOL rectangles_equal	(	const RECTANGLE_16 *	r1,
		const RECTANGLE_16 *	r2
	)

computes if two rectangles are equal

Parameters

r1	first rectangle
r2	second rectangle

Returns

if the two rectangles are equal

rectangles_intersection()

FREERDP_API BOOL rectangles_intersection	(	const RECTANGLE_16 *	r1,
		const RECTANGLE_16 *	r2,
		RECTANGLE_16 *	dst
	)

computes the intersection of two rectangles

Parameters

r1	first rectangle
r2	second rectangle
dst	resulting intersection

Returns

if the two rectangles intersect

Here is the caller graph for this function:

rectangles_intersects()

FREERDP_API BOOL rectangles_intersects	(	const RECTANGLE_16 *	r1,
		const RECTANGLE_16 *	r2
	)

computes if two rectangles intersect

Parameters

r1	first rectangle
r2	second rectangle

Returns

if the two rectangles intersect

Here is the call graph for this function:

Here is the caller graph for this function:

region16_clear()

FREERDP_API void region16_clear

(

REGION16 *

region

)

clears the region, the region is reset to a (0,0,0,0) region

Parameters

region

the region to clear

Here is the caller graph for this function:

region16_copy()

FREERDP_API BOOL region16_copy	(	REGION16 *	dst,
		const REGION16 *	src
	)

copies the region to another region

Parameters

dst	destination region
src	source region

Returns

if the operation was successful (false meaning out-of-memory)

Here is the call graph for this function:

Here is the caller graph for this function:

region16_extents()

FREERDP_API const RECTANGLE_16* region16_extents

(

const REGION16 *

region

)

Returns

the extents rectangle of this region

Here is the caller graph for this function:

region16_init()

FREERDP_API void region16_init

(

REGION16 *

region

)

initialize a region16

Parameters

region

the region to initialise

Here is the caller graph for this function:

region16_intersect_rect()

FREERDP_API BOOL region16_intersect_rect	(	REGION16 *	dst,
		const REGION16 *	src,
		const RECTANGLE_16 *	arg2
	)

computes the intersection between a region and a rectangle

Parameters

dst	destination region
src	the source region
arg2	the rectangle that intersects

Returns

if the operation was successful (false meaning out-of-memory)

Here is the call graph for this function:

Here is the caller graph for this function:

region16_intersects_rect()

FREERDP_API BOOL region16_intersects_rect	(	const REGION16 *	src,
		const RECTANGLE_16 *	arg2
	)

returns if a rectangle intersects the region

Parameters

src	the region
arg2	the rectangle

Returns

if region and rectangle intersect

Here is the call graph for this function:

Here is the caller graph for this function:

region16_is_empty()

FREERDP_API BOOL region16_is_empty

(

const REGION16 *

region

)

returns if the region is empty

Parameters

region

the region to check

Returns

if the region is empty

Here is the caller graph for this function:

region16_n_rects()

FREERDP_API int region16_n_rects

(

const REGION16 *

region

)

Returns

the number of rectangles of this region16

Here is the caller graph for this function:

region16_print()

FREERDP_API void region16_print

(

const REGION16 *

region

)

dumps the region on stderr

Parameters

region

the region to dump

Here is the call graph for this function:

Here is the caller graph for this function:

region16_rects()

FREERDP_API const RECTANGLE_16* region16_rects	(	const REGION16 *	region,
		UINT32 *	nbRects
	)

returns a pointer to rectangles and the number of rectangles in this region. nbRects can be set to NULL if not interested in the number of rectangles.

Parameters

region	the input region
nbRects	if non-NULL returns the number of rectangles

Returns

a pointer on the rectangles

Here is the caller graph for this function:

region16_uninit()

FREERDP_API void region16_uninit

(

REGION16 *

region

)

release internal data associated with this region

Parameters

region

the region to release

Here is the caller graph for this function:

region16_union_rect()

FREERDP_API BOOL region16_union_rect	(	REGION16 *	dst,
		const REGION16 *	src,
		const RECTANGLE_16 *	rect
	)

adds a rectangle in src and stores the resulting region in dst

Parameters

dst	destination region
src	source region
rect	the rectangle to add

Returns

if the operation was successful (false meaning out-of-memory)

Here is the call graph for this function:

Here is the caller graph for this function: