F_VN_TransformIntoDisplayableImageExp2

F_VN_TransformIntoDisplayableImageExp2 1:

Transform an image into a displayable image and set a custom timestamp that can afterwards be read via ITcVnImageTimestamps. 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_TransformIntoDisplayableImageExp2 : HRESULT
VAR_INPUT
    ipSrcImage     : Reference To ITcVnImage;
    ipDestImage    : Reference To ITcVnDisplayableImage;
    bAllowDeepCopy : BOOL;
    nTimestamp     : LINT;
    hrPrev         : HRESULT;
END_VAR

 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

nTimestamp

LINT

Custom timestamp that is added to the image info

hrPrev

HRESULT

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

 Return value

HRESULT

Required License

TC3 Vision Base

System Requirements

Development environment

Target platform

PLC libraries to include

TwinCAT V3.1.4026 or later

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

Tc3_Vision