kge::io::Stream Class Reference

Stream class is for working with streams. More...

#include <Stream.h>

Inheritance diagram for kge::io::Stream:

Public Member Functions
	Stream (void *pData, uint DataSize, std::string name)
	Constructor.
virtual	~Stream ()
	Destructor.
virtual uint	Read (void *buffer, s32 sizeToRead)
	Reads an amount of bytes from the Stream buffer.
virtual uint	GetSize ()
	Returns the stream size.
virtual std::string	GetName ()
	Returns the stream name.
Public Member Functions inherited from kge::KgeUnknown
	KgeUnknown ()
	Constructor.
virtual	~KgeUnknown ()
	Destructor.
virtual void	AddRef ()
	Add a reference to the object.
virtual void	DecRef ()
	Decrease a reference from the object. if its reference count get 0 then the object will destroy.
u32	GetRefCount ()
	Return resource reference count.
const char *	GetDebugText ()
	returns the instance debug text.

Protected Attributes
void *	m_pStart
	The start point of data.
u8 *	m_pCurrent
	The current positoin of data.
uint	m_iSize
	The data size.
uint	m_iCursur
	The cursur position.
std::string	m_sName
	The stream name.

Additional Inherited Members
Protected Member Functions inherited from kge::KgeUnknown
void	SetDebugText (char *text)

Detailed Description

Stream class is for working with streams.

Definition at line 13 of file Stream.h.

Constructor & Destructor Documentation

kge::io::Stream::Stream	(	void *	pData,
		uint	DataSize,
		std::string	name
	)

Constructor.

virtual kge::io::Stream::~Stream ( )

virtual

Destructor.

Member Function Documentation

virtual std::string kge::io::Stream::GetName ( )

inlinevirtual

Returns the stream name.

Definition at line 35 of file Stream.h.

virtual uint kge::io::Stream::GetSize ( )

inlinevirtual

Returns the stream size.

Definition at line 32 of file Stream.h.

virtual uint kge::io::Stream::Read ( void *  buffer, s32  sizeToRead  )

virtual

Reads an amount of bytes from the Stream buffer.

Parameters

buffer	Pointer to buffer where read bytes are written to.
sizeToRead	Amount of bytes to read from the Stream.

Returns

How many bytes were read.

Member Data Documentation

uint kge::io::Stream::m_iCursur

protected

The cursur position.

Definition at line 41 of file Stream.h.

uint kge::io::Stream::m_iSize

protected

The data size.

Definition at line 41 of file Stream.h.

u8* kge::io::Stream::m_pCurrent

protected

The current positoin of data.

Definition at line 40 of file Stream.h.

void* kge::io::Stream::m_pStart

protected

The start point of data.

Definition at line 39 of file Stream.h.

std::string kge::io::Stream::m_sName

protected

The stream name.

Definition at line 43 of file Stream.h.

---

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

• E:/mycodes/git/kge/Include/io/Stream.h