FormatCorePlugin_ReadImageScanlines

Definition

Read one or more rows of pixel data.

int32_t FormatCorePlugin_ReadImageScanlines(

  FC_ImageHandle handle,

  byte_t **buffer,

  uint32_t startRow,

  uint32_t rows,

  size_t scanlineSize,

  uint32_t plane

);

Arguments

[IN]handle

Handle to a reader instance that previously opened an image.

[OUT]buffer

Array of rows to be filled in.

[IN]startRow

Starting row.

[IN]rows

Number of rows to fill ( actually the size of buffer ). Should check for ( startRow + rows ) > image height and handle accordingly.

[IN]scanlineSize

Size of a single row in bytes.

[IN]plane

Image plane to use. For BSQ images this is the band index.

Return Value

FORMATCORE_SUCCESS or FORMATCORE_FAILURE.

Remarks

Function to fill in pixel data starting at startRow to startRow + rows. Columns are to be clipped to ROI specified in FormatCorePlugin_SelectImageROI.