Back to FabImage Library website

You are here: Start » Function Reference » Region » Region Basics » CreateBoxRegion

CreateBoxRegion


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a rectangular region corresponding to a given box.

Syntax

C++
C#
 
void fil::CreateBoxRegion
(
	const fil::Box& inBox,
	int inFrameWidth,
	int inFrameHeight,
	fil::Region& outRegion
)

Parameters

Name Type Range Default Description
Input value
 inBox const Box& A box defining pixels that will be converted to white elements
Input value
 inFrameWidth int 0 - 65535 Width of the created region's frame (not to be confused with the width of the box!)
Input value
 inFrameHeight int 0 - 65535 Height of the created region's frame (not to be confused with the height of the box!)
Output value
 outRegion Region& Output region

Description

The operation creates a region containing pixels lying inside the inBox.

The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with. If the input box exceeds these dimensions, the output region will be cropped.

Hints

  • Remember to set inFrameWidth and inFrameHeight inputs to specify the region frame.

Examples

CreateBoxRegion run with inBox = Box(50,100,200,100).

See Also