This page has been translated automatically.
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Content Creation
Materials
Unigine Material Library
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine::StreamBase Class

Unigine Base Stream class.

To use this class, include the UnigineStream.h file.

Unigine::StreamBase Class

Members


StreamBase ()

Constructor.

virtual ~StreamBase ()

Virtual destructor.

Ptr< Stream > getStream () const

Return a stream pointer.

Return value

The stream pointer.

virtual int isOpened () =0

Return the status of the stream.

Return value

Returns 1 if stream is opened; otherwise, 0 is returned.

virtual int isAvailable () =0

Return the status of the stream.

Return value

Returns 1 if stream data is available; otherwise, 0 is returned.

virtual size_t read (void * ptr, size_t size, size_t nmemb) =0

Read the number of bytes from the stream.

Arguments

  • void * ptr - Destination buffer pointer.
  • size_t size - Size of the buffer in bytes.
  • size_t nmemb - Number of memory blocks to read.

Return value

Returns the number of read bytes.

virtual size_t write (const void * ptr, size_t size, size_t nmemb) =0

Write the number of bytes to the stream.

Arguments

  • const void * ptr - Source buffer pointer.
  • size_t size - Size of the buffer in bytes.
  • size_t nmemb - Number of memory blocks to write.

Return value

Returns the number of written bytes.
Last update: 2017-07-03
Build: ()