8.12. tsImageScanline

Syntax

Pascal

function tsImageGetScanline(ImageID: tsImageID; Scanline: tsInt): Pointer;

C/C++

void * tsImageGetScanline(tsImageID ImageID, tsInt Scanline);

Description

This function returns the data pointer of the given scanline. For an description of the format from the data please take an look in the Image section.

Params

ImageID

The ImageID from which the scanline will be quered.

Scanline

The index of the scanline. The range of this parameter is from zero to height -1.

Return Value

Return value is the data pointer of the given scanline. If there was an error or the image is empty the return value is nil / NULL.

Error Codes

TS_NO_ACTIVE_CONTEXT

If there was no context bound.

TS_INVALID_OPERATION

If you try to get a scanline from an empty image.

TS_INVALID_VALUE

This will happen if you pass an invalid ImageID to this function.