renoir::IStreamReader
Object capable streaming file contents.
#include <CoherentRenderingLibrary.h>
Inherited by cohtml::ISyncStreamReader
Public Functions
| Name | |
|---|---|
| virtual | ~IStreamReader() |
| IStreamReader() | |
| virtual unsigned | GetSize() =0 Returns the file size. |
| virtual unsigned | Read(unsigned offset, unsigned char * buffer, unsigned count) =0 Reads count bytes into buffer starting from offset. |
| virtual void | Close() =0 Marks this object as closed - it will no longer be used and its memory should be freed. |
Public Functions Documentation
function ~IStreamReader
virtual ~IStreamReader()
function IStreamReader
IStreamReader()
function GetSize
virtual unsigned GetSize() =0
Returns the file size.
Return: file size
function Read
virtual unsigned Read(
unsigned offset,
unsigned char * buffer,
unsigned count
) =0
Reads count bytes into buffer starting from offset.
Parameters:
- offset the position at which to begin reading
- buffer pointer to the buffer where to copy the file contents
- count number of bytes to read
Return: number of bytes successfully read
function Close
virtual void Close() =0
Marks this object as closed - it will no longer be used and its memory should be freed.