F_VN_GetPixelFormat

F_VN_GetPixelFormat 1:

Gets the pixel format of an image. (Alternatively use interface method .GetPixelFormat.)

Syntax

Definition:

FUNCTION F_VN_GetPixelFormat : HRESULT
VAR_INPUT
    ipImage       : ITcVnImage;
END_VAR
VAR_IN_OUT
    stPixelFormat : TcVnPixelFormat;
END_VAR
VAR_INPUT
    hrPrev        : HRESULT;
END_VAR

F_VN_GetPixelFormat 2: Inputs

Name

Type

Description

ipImage

ITcVnImage

Image

hrPrev

HRESULT

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

F_VN_GetPixelFormat 3: In/Outputs

Name

Type

Description

stPixelFormat

TcVnPixelFormat

Returns a struct describing the pixel format

F_VN_GetPixelFormat 4: 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