Cv.ClipLine Method

CvClipLine Method

OpenCvSharp Class Library

Clips the line against the image rectangle

Namespace: OpenCvSharp
Assembly: OpenCvSharp (in OpenCvSharp.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public static int ClipLine(
	CvSize imgSize,
	ref CvPoint pt1,
	ref CvPoint pt2
)

Public Shared Function ClipLine ( 
	imgSize As CvSize,
	ByRef pt1 As CvPoint,
	ByRef pt2 As CvPoint
) As Integer

public:
static int ClipLine(
	CvSize imgSize, 
	CvPoint% pt1, 
	CvPoint% pt2
)

static member ClipLine : 
        imgSize : CvSize * 
        pt1 : CvPoint byref * 
        pt2 : CvPoint byref -> int

Parameters

imgSize: Type: OpenCvSharpCvSize
Size of the image.
pt1: Type: OpenCvSharpCvPoint
First ending point of the line segment. It is modified by the function.
pt2: Type: OpenCvSharpCvPoint
Second ending point of the line segment. It is modified by the function.

Return Value

Type: Int32
The function cvClipLine calculates a part of the line segment which is entirely in the image. It returns 0 if the line segment is completely outside the image and 1 otherwise.

Reference

Cv Class

OpenCvSharp Namespace