IInputStream

Engine/source/core/stream/tStream.h

An input stream delivers a sequence of elements of type "T".

More...

Public Types

T
ElementType 

The element type of this input stream.

Parent 

Public Functions

read(ElementType * buffer, U32 num)

Read the next "num" elements into "buffer".

Detailed Description

An input stream delivers a sequence of elements of type "T".

note:

This stream has an inherent position property and is thus not safe for concurrent access.

Public Types

typedef T ElementType 

The element type of this input stream.

typedef void Parent 

Public Functions

read(ElementType * buffer, U32 num)

Read the next "num" elements into "buffer".

Parameters:

buffer

The buffer into which the elements are stored.

num

Number of elements to read.

return:

the number of elements actually read; this may be less than "num" or even zero if no elements are available or reading failed.

Reimplemented by: AsyncBufferedInputStream, AsyncBufferedInputStream, SFXWavStream, SFXMemoryStream, SFXStream