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

CreateBoxBorderRegion

Header:	FIL.h
Namespace:	fil

Creates a frame-shaped region with given parameters.

Syntax

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
inBox	const Box&
inBorderWidth	int	0 -	1
inBorderPosition	BorderPosition::Type		Centered
inFrameWidth	int	0 - 65535		Width of the created region's frame
inFrameHeight	int	0 - 65535		Height of the created region's frame
outRegion	Region&			Output region

Errors

List of possible exceptions:

Error type	Description
DomainError	Incorrect BorderPosition in CreateBoxBorderRegion.