Search Results for

    Show / Hide Table of Contents

    Class Stream

    Base class for all data streams (memory streams, file streams etc.)

    Inheritance
    Stream
    Assembly: FlaxEngine.dll
    File: Engine/Serialization/Stream.h
    Syntax
    public class Stream

    Constructors

    ~Stream()

    Virtual destructor

    Declaration
    public virtual ~Stream()

    Stream()

    Declaration
    protected Stream()

    Fields

    _hasError

    Declaration
    protected bool _hasError
    Field Value
    bool

    Methods

    CanRead()

    Returns true if can read data from that stream.

    Declaration
    public virtual bool CanRead()
    Returns
    bool

    True if can read, otherwise false.

    CanWrite()

    Returns true if can write data to that stream.

    Declaration
    public virtual bool CanWrite()
    Returns
    bool

    True if can write, otherwise false.

    Close()

    Close the stream

    Declaration
    public virtual void Close() = 0

    Flush()

    Flush the stream buffers

    Declaration
    public virtual void Flush() = 0

    GetLength()

    Gets length of the stream

    Declaration
    public virtual uint32 GetLength() = 0
    Returns
    uint32

    Length of the stream

    GetPosition()

    Gets current position in the stream

    Declaration
    public virtual uint32 GetPosition() = 0
    Returns
    uint32

    Current position in the stream

    HasError()

    Returns true if error occurred during reading/writing to the stream

    Declaration
    public virtual bool HasError() const
    Returns
    bool

    True if error occurred during reading/writing to the stream

    SetPosition(uint32 seek)

    Set new position in the stream

    Declaration
    public virtual void SetPosition(uint32 seek) = 0
    Parameters
    uint32 seek

    New position in the stream

    • Improve this Doc
    • View Source
    In This Article
    Back to top Copyright © 2012-2024 Wojciech Figat