|
| enum | AccessMode { ReadAccess
, WriteAccess
, AppendAccess
, ReadWriteAccess
} |
| | access modes More...
|
| enum | AccessPattern { Random
, Sequential
} |
| | access prefered pattern More...
|
| enum | SeekOrigin { Begin
, Current
, End
} |
| | seek origins More...
|
| typedef int64_t | Position |
| | typedefs
|
| typedef int64_t | Offset |
| typedef int64_t | Size |
| | CachedStream () |
| | constructor
|
| virtual | ~CachedStream () |
| | destructor
|
| virtual bool | CanRead () const |
| | memory streams support reading
|
| virtual bool | CanSeek () const |
| | memory streams support seeking
|
| virtual bool | CanBeMapped () const |
| | memory streams are mappable
|
| virtual Size | GetSize () const |
| | get the size of the stream in bytes
|
| virtual Position | GetPosition () const |
| | get the current position of the read/write cursor
|
| virtual bool | Open () |
| | open the stream
|
| virtual void | Close () |
| | close the stream
|
| virtual Size | Read (void *ptr, Size numBytes) |
| | directly read from the stream
|
| virtual void | Seek (Offset offset, SeekOrigin origin) |
| | seek in stream
|
| virtual bool | Eof () const |
| | return true if end-of-stream reached
|
| virtual void * | Map () |
| | map for direct memory-access
|
| virtual void * | MemoryMap () |
| | map for direct memory-access
|
| virtual void | Unmap () |
| | unmap a mapped stream
|
| void * | GetRawPointer () const |
| | get a direct "raw" pointer to the data
|
| | Stream () |
| | constructor
|
| virtual | ~Stream () |
| | destructor
|
| void | SetURI (const URI &u) |
| | set stream location as URI
|
| const URI & | GetURI () const |
| | get stream URI
|
| virtual bool | CanWrite () const |
| | return true if the stream supports writing
|
| virtual void | SetSize (Size s) |
| | set a new size for the stream
|
| void | SetAccessMode (AccessMode m) |
| | set the access mode of the stream (default is ReadAccess)
|
| AccessMode | GetAccessMode () const |
| | get the access mode of the stream
|
| void | SetAccessPattern (AccessPattern p) |
| | set the prefered access pattern (default is Sequential)
|
| AccessPattern | GetAccessPattern () const |
| | get the prefered access pattern
|
| void | SetMediaType (const MediaType &t) |
| | set optional media type of stream content
|
| const MediaType & | GetMediaType () const |
| | get optional media type
|
| bool | IsOpen () const |
| | return true if currently open
|
| virtual void | Write (const void *ptr, Size numBytes) |
| | directly write to the stream
|
| virtual void | Flush () |
| | flush unsaved data
|
| virtual void | MemoryUnmap () |
| | unmap memory stream
|
| bool | IsMapped () const |
| | return true if stream is currently mapped to memory
|
| | RefCounted () |
| | constructor
|
| int | GetRefCount () const |
| | get the current refcount
|
| void | AddRef () |
| | increment refcount by one
|
| void | Release () |
| | decrement refcount and destroy object if refcount is zero
|
| bool | IsInstanceOf (const Rtti &rtti) const |
| | return true if this object is instance of given class
|
| bool | IsInstanceOf (const Util::String &className) const |
| | return true if this object is instance of given class by string
|
| bool | IsInstanceOf (const Util::FourCC &classFourCC) const |
| | return true if this object is instance of given class by fourcc
|
| bool | IsA (const Rtti &rtti) const |
| | return true if this object is instance of given class, or a derived class
|
| bool | IsA (const Util::String &rttiName) const |
| | return true if this object is instance of given class, or a derived class, by string
|
| bool | IsA (const Util::FourCC &rttiFourCC) const |
| | return true if this object is instance of given class, or a derived class, by fourcc
|
| const Util::String & | GetClassName () const |
| | get the class name
|
| Util::FourCC | GetClassFourCC () const |
| | get the class FourCC code
|
| static void | DumpRefCountingLeaks () |
| | dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
|
| Ptr< IO::Stream > | parentStream |
| Size | size |
| Position | position |
| unsigned char * | buffer |
| URI | uri |
| AccessMode | accessMode |
| AccessPattern | accessPattern |
| bool | isOpen |
| bool | isMapped |
| MediaType | mediaType |