Pictel 2d 0.1
Game Engine Documentation
Public Member Functions | List of all members
engine::FileMemoryBufferStreamFromFile Class Reference
Inheritance diagram for engine::FileMemoryBufferStreamFromFile:
engine::FileStreamI

Public Member Functions

 FileMemoryBufferStreamFromFile (std::string filename)
 
int64_t Seek (int64_t offset, int whence)
 
size_t Read (void *ptr, size_t size, size_t maxnum)
 
std::string ReadBufferString ()
 
FILE * GetFP ()
 
- Public Member Functions inherited from engine::FileStreamI
 FileStreamI (std::string filename)
 
std::string & GetFilename ()
 
int64_t & GetSize ()
 

Additional Inherited Members

- Protected Attributes inherited from engine::FileStreamI
std::string m_filename
 
int64_t m_size
 

Detailed Description

Mapped file system onto the FileMemoryBufferStreamI when no packed data exists.

Member Function Documentation

◆ GetFP()

FILE * engine::FileMemoryBufferStreamFromFile::GetFP ( )
inlinevirtual

Direct access to the file. Do not close by yourself.

Implements engine::FileStreamI.

◆ Read()

size_t engine::FileMemoryBufferStreamFromFile::Read ( void *  ptr,
size_t  size,
size_t  maxnum 
)
virtual

Read up to maxnum objects each of size size from the data stream to the area pointed at by ptr.

Returns
the number of objects read, or 0 at error or end of file.

Implements engine::FileStreamI.

◆ ReadBufferString()

std::string engine::FileMemoryBufferStreamFromFile::ReadBufferString ( )
virtual

Helper to read the whole file as string

Implements engine::FileStreamI.

◆ Seek()

int64_t engine::FileMemoryBufferStreamFromFile::Seek ( int64_t  offset,
int  whence 
)
virtual

Seek to offset relative to whence, one of stdio's whence values: RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END

Returns
the final offset in the data stream, or -1 on error.

Implements engine::FileStreamI.