CogOCVMaxFont.RenderImage Method (String, CogTransform2DLinear, CogOCVMaxFontRenderParams)

CogOCVMaxFont RenderImage Method (String, CogTransform2DLinear, CogOCVMaxFontRenderParams)

Cognex VisionPro 9.7

Create an image in which the supplied text is drawn using this font and the supplied parameters.

Namespace: Cognex.VisionPro.OCVMax
Assembly: Cognex.VisionPro.OCVMax (in Cognex.VisionPro.OCVMax.dll) Version: 73.0.0.0

Syntax

C++

Copy to Clipboard Print

public CogImage8Grey RenderImage(
	string srcText,
	CogTransform2DLinear selectedFromFont,
	CogOCVMaxFontRenderParams renderParams
)

public CogImage8Grey RenderImage(
	string srcText,
	CogTransform2DLinear selectedFromFont,
	CogOCVMaxFontRenderParams renderParams
)

Public Function RenderImage ( 
	srcText As String,
	selectedFromFont As CogTransform2DLinear,
	renderParams As CogOCVMaxFontRenderParams
) As CogImage8Grey

Public Function RenderImage ( 
	srcText As String,
	selectedFromFont As CogTransform2DLinear,
	renderParams As CogOCVMaxFontRenderParams
) As CogImage8Grey

public:
CogImage8Grey^ RenderImage(
	String^ srcText, 
	CogTransform2DLinear^ selectedFromFont, 
	CogOCVMaxFontRenderParams^ renderParams
)

public:
CogImage8Grey^ RenderImage(
	String^ srcText, 
	CogTransform2DLinear^ selectedFromFont, 
	CogOCVMaxFontRenderParams^ renderParams
)

Parameters

srcText: Type: System String
The text to be drawn. This string is interpreted as a single line within a single paragraph.

selectedFromFont: Type: Cognex.VisionPro CogTransform2DLinear
A linear mapping from the imported font description to the selected space. Typically used to specify scaling.

renderParams: Type: Cognex.VisionPro.OCVMax CogOCVMaxFontRenderParams
The CogOCVMaxFontRenderParams to use in rendering this text.

Return Value

Type: CogImage8Grey
A CogImage8Grey that contains the rendered text.

Exceptions

Exception	Condition
ObjectDisposedException	If this CogOCVMaxFont object has already been disposed.
InvalidOperationException	If a font has not yet been imported, or if an internal error occurs.
ArgumentNullException	If any of the arguments are NULL.
ArgumentOutOfRangeException	If the srcText argument does not describe at least one character.