iDRS™ SDK 16
Loading...
Searching...
No Matches
ILineReader_interface.h File Reference

Interface for ILineReader wrapper. More...

Go to the source code of this file.

Functions

ILineReader ILineReader_Create (PtrGetLineFn ptrGetLineFn, idrs_exception *pargException)
 Creates a new ILineReader object.
 
void ILineReader_Destroy (ILineReader argILineReader, idrs_exception *pargException)
 Destroys a ILineReader handle.
 
void ILineReader_GetLine (ILineReader argILineReader, IDRS_PVOID pvLine, IDRS_UINT32 const ui32Line, IDRS_UINT32 const ui32Bytes, idrs_exception *pargException)
 GetLine retrieves the data for the requested line.
 

Detailed Description

Interface for ILineReader wrapper.

Function Documentation

◆ ILineReader_Create()

ILineReader ILineReader_Create ( PtrGetLineFn  ptrGetLineFn,
idrs_exception *  pargException 
)

Creates a new ILineReader object.

Parameters
ptrGetLineFnGetLine function pointer
pargExceptionPointer to exception structure that will be filled if an exception occurs
Returns
The newly created ILineReader

◆ ILineReader_Destroy()

void ILineReader_Destroy ( ILineReader  argILineReader,
idrs_exception *  pargException 
)

Destroys a ILineReader handle.

Parameters
argILineReaderILineReader handle to destroy
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ ILineReader_GetLine()

void ILineReader_GetLine ( ILineReader  argILineReader,
IDRS_PVOID  pvLine,
IDRS_UINT32 const  ui32Line,
IDRS_UINT32 const  ui32Bytes,
idrs_exception *  pargException 
)

GetLine retrieves the data for the requested line.

The integrator has to override this method to provide the data for the requested line.

Parameters
argILineReaderILineReader handle
pvLineThe buffer where to write the pixels of the line.
ui32LineThe 0 based index of the line to retrieve.
ui32BytesThe byte width for the line.
pargExceptionPointer to exception structure that will be filled if an exception occurs