Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)

Enlighten API 3.10 Documentation
Results will update as you type.
  • class Geo GeoParametrisedPlane3
  • class Geo GeoPriorityQueue
  • class Geo GeoProgress
  • class Geo GeoQueue
  • class Geo GeoQueueEnumInterface
  • class Geo GeoRefArrayPtr
  • class Geo GeoRefCount
  • class Geo GeoRefPtr
  • class Geo GeoRefReleasePtr
  • class Geo GeoReleaseDestructor
  • class Geo GeoRGBXTexture
  • class Geo GeoScopedCSection
  • class Geo GeoSingleton
  • class Geo GeoSpatialHash
  • class Geo GeoString
  • class Geo GeoTimer
  • class Geo GeoTokenList
  • class Geo GeoTokenStream
  • class Geo GeoTriangle
  • class Geo GeoTriple
  • class Geo GeoUniqueDelegatePtr
  • class Geo GeoUniquePtr
  • class Geo GeoUniqueReleasePtr
  • class Geo GeoV128Texture
  • class Geo GeoVariant
  • class Geo GeoVirtualPageAllocator
  • class Geo GeoZLibFileStream
  • class Geo GoodRNG
  • class Geo IdentDataCompare
  • class Geo IdentVertLinkBuilder
  • class Geo IdxLink
  • class Geo IffReader
  • class Geo IffTextWriter
  • class Geo IffWriter
  • class Geo IGeoEvent
  • class Geo IGeoInputStream
  • class Geo IGeoProgressProxy
  • class Geo IGeoRayTracingContext
  • class Geo IGeoReleasable
  • class Geo IGeoSerialisable
  • class Geo IGeoStream
  • class Geo IRtMesh
  • class Geo ITerminalCmdHandler
  • class Geo ITerminalDelegate
  • class Geo ITerminalInputHandler
  • class Geo ITerminalOutputHandler
  • class Geo Matrix
  • class Geo MemoryAllocator
  • class Geo NonCopyable
  • class Geo Optional
  • class Geo PackedInteger4
  • class Geo PointLeaf
  • class Geo PointSplit
  • class Geo PointSplitBounds
  • class Geo PointSplitState
  • class Geo QuickTaskTimer
  • class Geo RayResult
  • class Geo Releasable
  • class Geo RingBuffer
  • class Geo RtMesh
  • class Geo RtMeshGroup
  • class Geo ScopedTickCounter
  • class Geo ScopedTimer
  • class Geo SHCoeff
  • class Geo SimpleRNG
  • class Geo TerminalProvider
  • class Geo TextureWriter
  • class Geo TreeNode
  • class Geo TriGroupSelection
  • class Geo TxtProgressBar
  • namespace Geo Iff
  • namespace Geo PathUtils
  • namespace Geo Version
  • struct Geo ArrayRange
  • struct Geo AtlasMeshChartingFlags
  • struct Geo AtlasMeshTriangle
  • struct Geo AtlasMeshTriangleCorner
  • struct Geo AtlasMeshVertex
  • struct Geo AtlasMeshVertexSplitResult
  • struct Geo BboxEdge
  • struct Geo BboxFace
    Calendars

You‘re viewing this with anonymous access, so some content might be blocked.
/
class Geo IGeoStream

    This is the documentation for Enlighten.

    class Geo IGeoStream

    Nov 21, 2019

    class Geo::IGeoStream

        └>Geo::IGeoInputStream

    An IGeoStream allows you to read/write memory/files in a consistent manner, and is an extension point for users wishing to control where data is stored.

    The simplest implementation is

    See Also

    GeoFileStream which stores/loads content from a file.

    Functions

    Name Description
    ~IGeoInputStream()

    Deleting a stream should behave like a close operation.

    ~IGeoStream()

    Deleting a stream should behave like a close operation.

    BeginType(TypeId, u32)

    Provide information about the typed data written to the stream.

    EndType(u32)

    Provide information about the typed data written to the stream.

    GetPosition()

    Return the position of the read/write pointer within the stream (prototype matches ftell)

    GetPosition()

    Return the position of the read/write pointer within the stream (prototype matches ftell)

    IsEof()

    Is the read pointer at the end of the file (as with feof, only returns true if you have read past end)

    IsEof()

    Is the read/write pointer at the end of the file (as with feof, only returns true if you have read past end)

    IsOk()

    Tests if the stream is valid.

    IsOk()

    Tests if the stream is valid.

    Read(TIter, TIter)

    Read a collection of objects, returning true on success.

    Read(T(&))

    Read a fixed size array.

    Read(void *, size_t, size_t)

    Read data (prototype matches fread). Prefer to use the templated Read methods.

    Read(T &)

    Read a single object, returning true on success.

    ReadImpl(T &, GeoStd::TrueType)

    Read a single object, returning true on success.

    ReadImpl(T &, GeoStd::FalseType)

    Read a single object, returning true on success.

    ReadToEnd()

    Reads the stream to its end and returns the data as a char array.

    SetPosition(Geo::u64)

    Set the position of the read/write pointer within the stream (prototype matches fseek)

    SetPosition(u64)

    Set the position of the read/write pointer within the stream (prototype matches fseek)

    Write(TIter, TIter)

    Write a collection of objects, in range [begin, end) as STL-style classes support.

    Write(const void *, size_t, size_t)

    Write data (prototype matches fwrite). Prefer to use the templated Write methods.

    Write(const T(&))

    Write a fixed size array.

    Write(const T &)

    Write a single object, returning true on success.

    Enums

    Name Description
    EStreamMode

    An IGeoStream is open in either esmRead or esmWrite mode.


    virtual Geo::IGeoInputStream::~IGeoInputStream


    public: virtual ~IGeoInputStream()


    Deleting a stream should behave like a close operation.


    virtual Geo::IGeoStream::~IGeoStream


    public: virtual ~IGeoStream()


    Deleting a stream should behave like a close operation.


    virtual u32 Geo::IGeoStream::BeginType


    public: virtual u32 BeginType
    (
        TypeId type,
        u32 count
    )


    Provide information about the typed data written to the stream.


    virtual void Geo::IGeoStream::EndType


    public: virtual void EndType
    (
        u32 index
    )


    Provide information about the typed data written to the stream.


    virtual u64 Geo::IGeoStream::GetPosition


    public: u64 GetPosition() const


    Return the position of the read/write pointer within the stream (prototype matches ftell)


    virtual Geo::u64 Geo::IGeoInputStream::GetPosition


    public: Geo::u64 GetPosition() const


    Return the position of the read/write pointer within the stream (prototype matches ftell)


    virtual bool Geo::IGeoInputStream::IsEof


    public: bool IsEof() const


    Is the read pointer at the end of the file (as with feof, only returns true if you have read past end)


    virtual bool Geo::IGeoStream::IsEof


    public: bool IsEof() const


    Is the read/write pointer at the end of the file (as with feof, only returns true if you have read past end)


    virtual bool Geo::IGeoStream::IsOk


    public: bool IsOk() const


    Tests if the stream is valid.


    virtual bool Geo::IGeoInputStream::IsOk


    public: bool IsOk() const


    Tests if the stream is valid.


    bool Geo::IGeoInputStream::Read


    public: bool Read
    (
        TIter begin,
        TIter end
    )


    Read a collection of objects, returning true on success.

    Object must be considered blittable (see IsBlittable<T>). Note that the storage must have been pre-allocated as it will write directly to the iterators provided. Given that we do not have the STL-style 'back-inserter' classes, for GeoArrays you should use the ReadArray helper function.


    bool Geo::IGeoInputStream::Read


    public: bool Read
    (
        T(&) a
    )


    Read a fixed size array.


    virtual size_t Geo::IGeoInputStream::Read


    public: size_t Read
    (
        void * pData,
        size_t size,
        size_t count
    )


    Read data (prototype matches fread). Prefer to use the templated Read methods.


    GEO_FORCE_INLINE bool Geo::IGeoInputStream::Read


    public: GEO_FORCE_INLINE bool Read
    (
        T & object
    )


    Read a single object, returning true on success.

    There must either be a ReadObject overload for T, or T be considered blittable (see IsBlittable<T>).


    bool Geo::IGeoInputStream::ReadImpl


    public: bool ReadImpl
    (
        T & object,
        GeoStd::TrueType
    )


    Read a single object, returning true on success.

    There must either be a ReadObject overload for T, or T be considered blittable (see IsBlittable<T>).


    bool Geo::IGeoInputStream::ReadImpl


    public: bool ReadImpl
    (
        T & object,
        GeoStd::FalseType
    )


    Read a single object, returning true on success.

    There must either be a ReadObject overload for T, or T be considered blittable (see IsBlittable<T>).


    virtual Geo::GeoArray<char> Geo::IGeoInputStream::ReadToEnd


    public: virtual Geo::GeoArray< char > ReadToEnd()


    Reads the stream to its end and returns the data as a char array.


    virtual bool Geo::IGeoInputStream::SetPosition


    public: bool SetPosition
    (
        Geo::u64 pos
    )


    Set the position of the read/write pointer within the stream (prototype matches fseek)


    virtual bool Geo::IGeoStream::SetPosition


    public: bool SetPosition
    (
        u64 pos
    )


    Set the position of the read/write pointer within the stream (prototype matches fseek)


    bool Geo::IGeoStream::Write


    public: bool Write
    (
        TIter begin,
        TIter end
    )


    Write a collection of objects, in range [begin, end) as STL-style classes support.

    Objects have same requirements single object Write (see IsBlittable<T>).


    virtual size_t Geo::IGeoStream::Write


    public: size_t Write
    (
        const void * pData,
        size_t size,
        size_t count
    )


    Write data (prototype matches fwrite). Prefer to use the templated Write methods.


    bool Geo::IGeoStream::Write


    public: bool Write
    (
        const T(&) a
    )


    Write a fixed size array.


    GEO_FORCE_INLINE bool Geo::IGeoStream::Write


    public: GEO_FORCE_INLINE bool Write
    (
        const T & object
    )


    Write a single object, returning true on success.

    There must either be a WriteObject overload for T, or T must be blittable (see IsBlittable<T>).


    EStreamMode


    public: enum EStreamMode
    {
        esmWrite,
        esmRead
    }


    An IGeoStream is open in either esmRead or esmWrite mode.

    enumerators
    esmWrite
    esmRead
    , multiple selections available,
    {"serverDuration": 18, "requestCorrelationId": "9952d7d1187848d6bafbd6909919b698"}