Custom handler interface for intercepting and redirecting Ptex input stream calls. More...
#include <Ptexture.h>
Public Types | |
| typedef void * | Handle |
Public Member Functions | |
| virtual Handle | open (const char *path)=0 |
| Open a file in read mode. More... | |
| virtual void | seek (Handle handle, int64_t pos)=0 |
| Seek to an absolute byte position in the input stream. More... | |
| virtual size_t | read (void *buffer, size_t size, Handle handle)=0 |
| Read a number of bytes from the file. More... | |
| virtual bool | close (Handle handle)=0 |
| Close a file. More... | |
| virtual const char * | lastError ()=0 |
| Return the last error message encountered. More... | |
Protected Member Functions | |
| virtual | ~PtexInputHandler () |
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.
Definition at line 632 of file Ptexture.h.
Member Typedef Documentation
◆ Handle
| typedef void* PtexInputHandler::Handle |
Definition at line 637 of file Ptexture.h.
Constructor & Destructor Documentation
◆ ~PtexInputHandler()
|
inlineprotectedvirtual |
Definition at line 634 of file Ptexture.h.
Member Function Documentation
◆ close()
|
pure virtual |
Close a file.
Returns false if an error occurs, and the error string is available via lastError().
Implemented in PtexReader::DefaultInputHandler.
Referenced by PtexReader::closeFP().
◆ lastError()
|
pure virtual |
Return the last error message encountered.
Implemented in PtexReader::DefaultInputHandler.
Referenced by PtexReader::open().
◆ open()
|
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().
Implemented in PtexReader::DefaultInputHandler.
Referenced by PtexReader::open(), and PtexReader::reopenFP().
◆ read()
|
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().
Implemented in PtexReader::DefaultInputHandler.
Referenced by PtexReader::readBlock().
◆ seek()
|
pure virtual |
Seek to an absolute byte position in the input stream.
Implemented in PtexReader::DefaultInputHandler.
Referenced by PtexReader::seek().
The documentation for this class was generated from the following file:
