Torque3D Documentation / _generateds / IOffsetInputStream

IOffsetInputStream

Engine/source/core/stream/tStream.h

An input stream over elements of type "T" that reads from user-specified explicit offsets.

More...

Public Types

T
ElementType 
OffsetType 
Parent 

Public Functions

readAt(OffsetType offset, T * buffer, U32 num)

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

Detailed Description

An input stream over elements of type "T" that reads from user-specified explicit offsets.

Public Types

typedef T ElementType 
typedef Offset OffsetType 
typedef void Parent 

Public Functions

readAt(OffsetType offset, T * buffer, U32 num)

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

Parameters:

offset

The offset in the stream from which to read.

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.