Home > C: Programming > Function descriptions > History back  Previous chapter  Next chapter  Print  

is_GetImageMemPitch

uEye Camera Manual Version 4.00

is_GetImageMemPitch

Windows_Logo

Linux_Logo

USB 2.0

USB 3.0

GigE

USB 2.0

USB 3.0

GigE

Syntax

INT is_GetImageMemPitch (HIDS hCam, INT* pPitch)

Description

is_GetImageMemPitch() returns the line increment (in bytes). The line increment is defined as the number of bytes from the beginning of a line to the beginning of the next line. It may be greater than suggested by the parameters passed when calling is_AllocImageMem(). The line increment is always a number that can be divided by 4.

The line increment is calculated as:

line = width * [(bitspixel + 1) / 8]

lineinc = line + adjust

adjust = 0 – if line can be divided by 4 without remainder

adjust = 4 - rest(line / 4) if line cannot be divided by 4 without remainder

Input parameters

hCam

Camera handle

pPitch

Pointer to the variable containing the line increment

Return values

IS_CANT_COMMUNICATE_WITH_DRIVER

Communication with the driver failed because no driver has been loaded.

IS_CANT_OPEN_DEVICE

An attempt to initialize or select the camera failed (no camera connected or initialization error).

IS_INVALID_CAMERA_HANDLE

Invalid camera handle

IS_INVALID_MEMORY_POINTER

Invalid pointer or invalid memory ID

IS_INVALID_PARAMETER

One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode.

IS_IO_REQUEST_FAILED

An IO request from the uEye driver failed. Possibly the versions of the ueye_api.dll (API) and the driver file (ueye_usb.sys or ueye_eth.sys) do not match.

IS_NO_SUCCESS

General error message

IS_SUCCESS

Function executed successfully

Related functions

is_GetImageMem()

is_AllocImageMem()

is_AddToSequence()

is_SetImageMem()

is_SetAllocatedImageMem()


Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!

For technical questions please contact you local distributor or use the support form on our website.


© 2012 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com