NTrace
GPU ray tracing framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Classes | Public Types | Public Member Functions | List of all members
FW::File Class Reference

#include <File.hpp>

Inherits FW::InputStream, and FW::OutputStream.

Classes

class  AsyncOp
 

Public Types

enum  { MaxBytesPerSysCall = 16 << 20, MinimumExpandNum = 5, MinimumExpandDenom = 4 }
 
enum  Mode { Read, Create, Modify }
 

Public Member Functions

 File (const String &name, Mode mode, bool disableCache=false)
 
virtual ~File (void)
 
const String & getName (void) const
 
Mode getMode (void) const
 
int getAlign (void) const
 
bool checkWritable (void) const
 
S64 getSize (void) const
 
S64 getOffset (void) const
 
void seek (S64 ofs)
 
void setSize (S64 size)
 
void allocateSpace (S64 size)
 
virtual int read (void *ptr, int size)
 
virtual void write (const void *ptr, int size)
 
virtual void flush (void)
 
AsyncOp * readAsync (void *ptr, int size)
 
AsyncOp * writeAsync (const void *ptr, int size)
 
- Public Member Functions inherited from FW::InputStream
 InputStream (void)
 
virtual ~InputStream (void)
 
void readFully (void *ptr, int size)
 
U8 readU8 (void)
 
U16 readU16BE (void)
 
U16 readU16LE (void)
 
U32 readU32BE (void)
 
U32 readU32LE (void)
 
U64 readU64BE (void)
 
U64 readU64LE (void)
 
- Public Member Functions inherited from FW::OutputStream
 OutputStream (void)
 
virtual ~OutputStream (void)
 
void writeU8 (U32 v)
 
void writeU16BE (U32 v)
 
void writeU16LE (U32 v)
 
void writeU32BE (U32 v)
 
void writeU32LE (U32 v)
 
void writeU64BE (U64 v)
 
void writeU64LE (U64 v)
 

Detailed Description

Definition at line 37 of file File.hpp.

Member Enumeration Documentation

anonymous enum
Enumerator
MaxBytesPerSysCall 
MinimumExpandNum 
MinimumExpandDenom 

Definition at line 40 of file File.hpp.

enum FW::File::Mode
Enumerator
Read 
Create 
Modify 

Definition at line 47 of file File.hpp.

Constructor & Destructor Documentation

File::File ( const String &  name,
Mode  mode,
bool  disableCache = false 
)

Definition at line 123 of file File.cpp.

File::~File ( void  )
virtual

Definition at line 207 of file File.cpp.

Member Function Documentation

void File::allocateSpace ( S64  size)

Definition at line 251 of file File.cpp.

bool File::checkWritable ( void  ) const

Definition at line 219 of file File.cpp.

void File::flush ( void  )
virtual

Implements FW::OutputStream.

Definition at line 285 of file File.cpp.

int FW::File::getAlign ( void  ) const
inline

Definition at line 101 of file File.hpp.

Mode FW::File::getMode ( void  ) const
inline

Definition at line 100 of file File.hpp.

const String& FW::File::getName ( void  ) const
inline

Definition at line 99 of file File.hpp.

S64 FW::File::getOffset ( void  ) const
inline

Definition at line 105 of file File.hpp.

S64 FW::File::getSize ( void  ) const
inline

Definition at line 104 of file File.hpp.

int File::read ( void *  ptr,
int  size 
)
virtual

Implements FW::InputStream.

Definition at line 267 of file File.cpp.

File::AsyncOp * File::readAsync ( void *  ptr,
int  size 
)

Definition at line 299 of file File.cpp.

void File::seek ( S64  ofs)

Definition at line 229 of file File.cpp.

void File::setSize ( S64  size)

Definition at line 239 of file File.cpp.

void File::write ( const void *  ptr,
int  size 
)
virtual

Implements FW::OutputStream.

Definition at line 278 of file File.cpp.

File::AsyncOp * File::writeAsync ( const void *  ptr,
int  size 
)

Definition at line 347 of file File.cpp.

The documentation for this class was generated from the following files: