Back to Aurora Vision Library Lite website

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

CreateBoxBorderRegion


Header: AVL.h
Namespace: avl

Creates a frame-shaped region with given parameters.

Syntax

void avl::CreateBoxBorderRegion
(
	const avl::Box& inBox,
	int inBorderWidth,
	avl::BorderPosition::Type inBorderPosition,
	int inFrameWidth,
	int inFrameHeight,
	avl::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.