F_VN_TransformIntoDisplayableImageExp

F_VN_TransformIntoDisplayableImageExp 1:

Transform an image into a displayable image. The source image will be released and zeroed while existing destination images will be released and overwritten with the function result. If bAllowDeepCopy equals false, the source image must not be used anywhere else and the transformation is always very fast. Otherwise, if bAllowDeepCopy equals true, a deep copy of the source image might be created if required, which will result in a longer execution time. If you want to use ipSrcImage after this function call, use F_VN_CopyIntoDisplayableImage instead. (expert function)

Syntax

Definition:

FUNCTION F_VN_TransformIntoDisplayableImageExp : HRESULT
VAR_INPUT
    ipSrcImage     : Reference To ITcVnImage;
    ipDestImage    : Reference To ITcVnDisplayableImage;
    bAllowDeepCopy : BOOL;
    hrPrev         : HRESULT;
END_VAR

F_VN_TransformIntoDisplayableImageExp 2: Inputs

Name

Type

Description

ipSrcImage

Reference To ITcVnImage

Source image

ipDestImage

Reference To ITcVnDisplayableImage

Returns the displayable image

bAllowDeepCopy

BOOL

Allow deep image copies, if required

hrPrev

HRESULT

HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

F_VN_TransformIntoDisplayableImageExp 3: Return value

HRESULT

Further information

For further details, see Displayable images.

Parameter

Permission for deep copy

The permission (TRUE) for a deep copy can be given with the parameter bAllowDeepCopy. This is relevant if the image to be transformed originates from a camera object whose Ads Communicator object is activated and the image therefore can be internally referenced.

The standard version F_VN_TransformIntoDisplayableImage can also be used if no permission is to be given (FALSE).

Related functions

Required License

TC3 Vision Base

System Requirements

Development environment

Target platform

PLC libraries to include

TwinCAT V3.1.4024.54 or later

PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU

Tc3_Vision