get_bounds_rectangle

unsigned get_bounds_rectangle(handle device,
                              irectangle* bounds,
                              unsigned flags)

This function queries the bounds rectangle and boundary accumulation flags.

Parameters

handle device

The handle of the device context.

irectangle* bounds

A pointer to a rectangle that is updated to hold the bounds rectangle.

unsigned flags

The only flag that may be specified is bounds_flag::reset; in which case, the bounds rectangle is returned but also cleared. If bounds_flag::reset is not specified, the bounds rectangle remains unaltered.

Return

unsigned

The bounds flags or zero if an error occurred.

Notes

The bounds rectangle is empty only when:

1. the bit bounds_flag::reset is set to 1 and
2. the bit bounds_flag::accumulate is set to 0.