cqsp::asset::IVirtualFile Class Reference

#include <vfs.h>

Inheritance diagram for cqsp::asset::IVirtualFile:

Public Member Functions
	IVirtualFile ()
virtual	~IVirtualFile ()
virtual uint64_t	Size ()=0
	Size of file in bytes More...
virtual void	Read (uint8_t *buffer, int num_bytes)=0
	Reads num_bytes of bytes into buffer. Frees memory for the number More...
virtual bool	Seek (long offset, Offset origin=Offset::Cur)=0
	Goto position of file, offset away from origin More...
virtual uint64_t	Tell ()=0
	Get current file position More...
virtual const std::string &	Path ()=0
	Get file path relative to the filesystem. More...
virtual IVirtualFileSystem *	GetFileSystem ()=0

Constructor & Destructor Documentation

IVirtualFile()

cqsp::asset::IVirtualFile::IVirtualFile ( )

inline

~IVirtualFile()

virtual cqsp::asset::IVirtualFile::~IVirtualFile ( )

inlinevirtual

Member Function Documentation

GetFileSystem()

virtual IVirtualFileSystem * cqsp::asset::IVirtualFile::GetFileSystem ( )

pure virtual

Implemented in cqsp::asset::NativeFile.

Path()

virtual const std::string & cqsp::asset::IVirtualFile::Path ( )

pure virtual

Get file path relative to the filesystem.

Implemented in cqsp::asset::NativeFile.

Read()

virtual void cqsp::asset::IVirtualFile::Read ( uint8_t *  buffer, int  num_bytes  )

pure virtual

Reads num_bytes of bytes into buffer. Frees memory for the number

Parameters

buffer
num_bytes

Implemented in cqsp::asset::NativeFile.

Seek()

virtual bool cqsp::asset::IVirtualFile::Seek ( long  offset, Offset  origin = Offset::Cur  )

pure virtual

Goto position of file, offset away from origin

Implemented in cqsp::asset::NativeFile.

Size()

virtual uint64_t cqsp::asset::IVirtualFile::Size ( )

pure virtual

Size of file in bytes

Implemented in cqsp::asset::NativeFile.

Tell()

virtual uint64_t cqsp::asset::IVirtualFile::Tell ( )

pure virtual

Get current file position

Implemented in cqsp::asset::NativeFile.

---

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

• /github/workspace/src/engine/asset/vfs/vfs.h