API Reference > Extension Classes > ExRender Classes > ExRender Windows Classes > GsDIBSection Class > GsDIBSection Methods > scanLines Method > GsDIBSection::scanLines Method (OdUInt8*, OdUInt32, OdUInt32)
GsDIBSection::scanLines Method (OdUInt8*, OdUInt32, OdUInt32)
Collapse All
Syntax
C++
void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;
Parameters
Parameters 
Description 
OdUInt8* scnLines 
[out] Receives the scan line data.  
OdUInt32 firstScanline 
[in] Index of first scanline to retrieve.  
OdUInt32 numLines = 1 
[in] Number of scanlines to retrieve. 
Description

Returns the specified set of scanlines in BMP format from this RasterImage object, or the pixel data in BMP format for this RasterImage object. 

 

Remarks

  • The number of accessible scanlines is equal to value returned by pixelHeight().
  • The number of accessible bytes in a scanline is equal to the value returned by scanLineSize().
  • The scanline returned by firstScanline == 0 is the first scanline in the image.
  • The scanline returned by firstScanline == (pixelHeight() - 1) is the last scanline in the image.

Notes

It us up to the caller to allocate sufficient memory for the scan line data. 

Implementation of this function with no arguments is optional; NULL can be returned if it is inconvenient to implement. The caller must take into account that the return value can be NULL.

Group
Copyright © 2002–2020. Open Design Alliance. All rights reserved.
Send feedback about this topic