| MIL 10 Reference
| Customize Help
| Save Settings

MbufGetLine


See also
Reference:
MbufInquire
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
None.
MbufGetHookInfo
MbufHookFunction
Synopsis
Read the pixels along a specified theoretical line, count the pixels, and store their values in a user-defined array.
Syntax
void MbufGetLine(
MIL_ID ImageBufId, //in
MIL_INT StartX, //in
MIL_INT StartY, //in
MIL_INT EndX, //in
MIL_INT EndY, //in
MIL_INT64 Mode, //in
MIL_INT *NbPixelsPtr, //out
void *UserArrayPtr //out
)
Description

This function reads the series of pixels along a theoretical line (defined by coordinates) from an image and stores their values in a user-defined array. The Bresenham algorithm is used to determine the theoretical line.

If the source buffer is compressed, MIL decompresses the data before copying it to the user-supplied array.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
ImageBufId

Specifies the identifier of the source image buffer. This must be a single-band (monochrome) buffer.

This image buffer must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error.

StartX

Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer.

StartY

Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer.

EndX

Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer.

EndY

Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer.

Mode

Specifies the operation mode. Reserved for future expansion. This parameter must be set to M_DEFAULT.

NbPixelsPtr

Specifies the address of the variable in which to write the number of pixels found along the theoretical line. You can set this parameter to M_NULL if you don't want this value to be evaluated.

UserArrayPtr
Accepts the address of one of the following:
  • array of same type as the buffer

Specifies the address of the user array in which to store the pixels from the image buffer. Ensure that the user array is large enough to receive the data to be stored. To determine the required size of the array, you can set this parameter to M_NULL and pass a non-null address to NbPixelsPtr, which will store the required size of the array. In this case, nothing is read from the image buffer.

Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
NONE RASTER