TransformIntoDisplayableImage

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.

Syntax

Definition:

HRESULT TransformIntoDisplayableImage(
    HRESULT                 hrPrev,
    ITcVnImage*&            ipSrcImage,
    ITcVnDisplayableImage*& ipDestImage,
    bool                    bAllowDeepCopy = false
)

Parameters

Name

Type

Default

Description

hrPrev

HRESULT

 

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

ipSrcImage

ITcVnImage*&

 

Source image

ipDestImage

ITcVnDisplayableImage*&

 

Returns the displayable image

bAllowDeepCopy

bool

false

Allow deep image copies, if required

TransformIntoDisplayableImage 1: Return value

HRESULT

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