This page has been translated automatically.
Programming
Fundamentials
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Core Library
Containers
Engine Classes
Node-Related Classes
Rendering-Related Classes
Physics-Related Classes
Bounds-Related Classes
GUI-Related Classes
Controls-Related Classes
Pathfinding-Related Classes
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.

StreamBase Class (C++)

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

Returns a stream pointer.

Return value

The stream pointer.

virtual int isOpened () =0

Returns the status of the stream.

Return value

1 if stream is opened; otherwise, 0.

virtual int isAvailable () =0

Return the status of the stream.

Return value

1 if stream is available; otherwise, 0.

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

Reads 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

The number of read bytes.

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

Writes 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

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