Back to FabImage Library website

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

CreateCrossRegion


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a cross-shaped region with given parameters.

Syntax

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

Parameters

Name Type Range Default Description
Input value
 inCrossBoundingBox const Box&
Input value
 inFrameWidth int 0 - 65535 Width of the created region's frame
Input value
 inFrameHeight int 0 - 65535 Height of the created region's frame
Output value
 outRegion Region& Output region

Description

The operation creates a region in a shape of a one-pixel-wide cross. Cross is described by its width, height and coordinates of upper-left corner of its bounding box.

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 cross exceeds these dimensions, the output region will be cropped.

Hints

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

Examples

CreateCrossRegion run with inCrossBoundingBox parameters: X = 50, Y = 100, Width = 200, inCrossHeight = 100.

See Also

  • CreateBoxRegion – Creates a rectangular region corresponding to a given box.