PtexInputHandler Class Reference

Custom handler interface for intercepting and redirecting Ptex input stream calls. More...

#include <Ptexture.h>

List of all members.

Public Types
typedef void *	Handle
Public Member Functions
virtual Handle	open (const char *path)=0
	Open a file in read mode.
virtual void	seek (Handle handle, int64_t pos)=0
	Seek to an absolute byte position in the input stream.
virtual size_t	read (void *buffer, size_t size, Handle handle)=0
	Read a number of bytes from the file.
virtual bool	close (Handle handle)=0
	Close a file.
virtual const char *	lastError ()=0
	Return the last error message encountered.

---

Detailed Description

Custom handler interface for intercepting and redirecting Ptex input stream calls.

A custom instance of this class can be defined and supplied to the PtexCache class. Files accessed through the cache will have their input streams redirected through this interface.

---

Member Function Documentation

virtual bool PtexInputHandler::close

(

Handle

handle

)

[pure virtual]

Close a file.

Returns false if an error occurs, and the error string is available via lastError().

virtual const char* PtexInputHandler::lastError

(

)

[pure virtual]

Return the last error message encountered.

virtual Handle PtexInputHandler::open

(

const char *

path

)

[pure virtual]

Open a file in read mode.

Returns null if there was an error. If an error occurs, the error string is available via lastError().

virtual size_t PtexInputHandler::read	(	void *	buffer,
		size_t	size,
		Handle	handle
	)		[pure virtual]

Read a number of bytes from the file.

Returns the number of bytes successfully read. If less than the requested number of bytes is read, the error string is available via lastError().

virtual void PtexInputHandler::seek	(	Handle	handle,
		int64_t	pos
	)		[pure virtual]

Seek to an absolute byte position in the input stream.