CStdLineReader_interface.h File Reference

Interface for CStdLineReader wrapper. More...

Go to the source code of this file.

Functions
CStdLineReader	CStdLineReader_Create (IDRS_PVOID pvPixels, IDRS_UINT32 const ui32LineCount, IDRS_UINT32 const ui32ByteWidth, idrs_exception *pargException)
CStdLineReader	CStdLineReader_Create2 (const CStdLineReader arg0, idrs_exception *pargException)
	The CStdLineReader class provides a standard implementation for a line reader class that reads the lines in a memory buffer.
void	CStdLineReader_GetLine (CStdLineReader argCStdLineReader, IDRS_PVOID pvLine, IDRS_UINT32 const ui32Line, IDRS_UINT32 const ui32Bytes, idrs_exception *pargException)
void	CStdLineReader_Destroy (CStdLineReader argCStdLineReader, idrs_exception *pargException)
	Destroys a CStdLineReader handle.

Detailed Description

Interface for CStdLineReader wrapper.

Function Documentation

CStdLineReader_Create()

CStdLineReader CStdLineReader_Create	(	IDRS_PVOID	pvPixels,
		IDRS_UINT32 const	ui32LineCount,
		IDRS_UINT32 const	ui32ByteWidth,
		idrs_exception *	pargException
	)

Constructs a CStdLineReader object.

Initializes members with the provided values

Parameters

pvPixels	- buffer containing the image pixels
ui32LineCount	- number of lines of pixels available in the pixels buffer (image height)
ui32ByteWidth	- number of bytes for representing the width in bytes of each line
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

Instances created by this method can also be provided to ILineReader methods

CStdLineReader_Destroy()

void CStdLineReader_Destroy	(	CStdLineReader	argCStdLineReader,
		idrs_exception *	pargException
	)

Destroys a CStdLineReader handle.

Parameters

argCStdLineReader	CStdLineReader handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CStdLineReader_GetLine()

void CStdLineReader_GetLine	(	CStdLineReader	argCStdLineReader,
		IDRS_PVOID	pvLine,
		IDRS_UINT32 const	ui32Line,
		IDRS_UINT32 const	ui32Bytes,
		idrs_exception *	pargException
	)

Retrieve a line of pixels from the memory buffer.

Parameters

argCStdLineReader	CStdLineReader handle
pvLine	The buffer where to write the line data.
ui32Line	The 0 based index of the line to retrieve.
ui32Bytes	The number of bytes to retrieve.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

If the number of bytes to be retrieved is greater than the line width in bytes, the number of bytes surpassing the line byte width will be set to 0