Back to FabImage Library website

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

CreateBoxBorderRegion


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a frame-shaped region with given parameters.

Syntax

C++
C#
 
void fil::CreateBoxBorderRegion
(
	const fil::Box& inBox,
	int inBorderWidth,
	fil::BorderPosition::Type inBorderPosition,
	int inFrameWidth,
	int inFrameHeight,
	fil::Region& outRegion
)

Parameters

Name Type Range Default Description
Input value
 inBox const Box&
Input value
 inBorderWidth int 0 - 1
Input value
 inBorderPosition BorderPosition::Type Centered
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

Errors

List of possible exceptions:

Error type Description
DomainError Incorrect BorderPosition in CreateBoxBorderRegion.