index of namespace default
 
 index of project core
 
 index of module core

Class core.Stream


SynopsisBase class for input/output stream objects.

  Base classes:
  Derived classes:
  Methods:

Method add2f
Write two 32bit floats to the stream.
Signature
add2f(floatf1,
  floatf2 
  )  
Arguments
floatf1
floatf2

 
 top of page
Method add3f
Write three 32bit floats to the stream.
Signature
add3f(floatf1,
  floatf2,
  floatf3 
  )  
Arguments
floatf1
floatf2
floatf3

 
 top of page
Method add4f
Write four 32bit floats to the stream.
Signature
add4f(floatf1,
  floatf2,
  floatf3,
  floatf4 
  )  
Arguments
floatf1
floatf2
floatf3
floatf4

 
 top of page
Method close
Signature
close()

 
 top of page
Method deserialize
Signature
deserialize(Objecto,
  booleanbTypeInfo 
  )  
 :boolean
Arguments
Objecto
booleanbTypeInfo
Returns
boolean

 
 top of page
Method eof
Signature
eof():boolean
Returns
boolean

 
 top of page
Method getB8
Read 8bit boolean from stream (either 1 or 0).
Signature
getB8():boolean
Returns
boolean

 
 top of page
Method getByteOrder
Signature
getByteOrder():int
Returns
int

 
 top of page
Method getErrorCode
Signature
getErrorCode():int
Returns
int

 
 top of page
Method getErrorStringByCode
Signature
getErrorStringByCode(interrorCode)
 :String
Arguments
interrorCode
Returns
String

 
 top of page
Method getF32
Signature
getF32():float
Returns
float

 
 top of page
Method getF32a
Read 32bit floats and store in array object (will be reallocated).
Signature
getF32a(Objecta,
  intnum 
  )  
Arguments
Objecta
intnum

 
 top of page
Method getF64
@todo Make it return a Double object
Signature
getF64():float
Returns
float

 
 top of page
Method getF64a
Read 64bit doubles and store in array object (will be reallocated).
Signature
getF64a(Objecta,
  intnum 
  )  
Arguments
Objecta
intnum

 
 top of page
Method getI16
Read unsigned short from stream.
Signature
getI16():short
Returns
short

 
 top of page
Method getI16a
Read signed shorts and store in array object (will be reallocated).
Signature
getI16a(Objecta,
  intnum 
  )  
Arguments
Objecta
intnum

 
 top of page
Method getI32
Signature
getI32():int
Returns
int

 
 top of page
Method getI32a
Read signed dwords and store in array object (will be reallocated).
Signature
getI32a(Objecta,
  intnum 
  )  
Arguments
Objecta
intnum

 
 top of page
Method getI8
Read unsigned byte from stream.
Signature
getI8():byte
Returns
byte

 
 top of page
Method getI8a
Read signed bytes and store in array object (will be reallocated).
Signature
getI8a(Objecta,
  intnum 
  )  
Arguments
Objecta
intnum

 
 top of page
Method getObject
Signature
getObject(Objectdest)
Arguments
Objectdest

 
 top of page
Method getOffset
Signature
getOffset():int
Returns
int

 
 top of page
Method getS16
Read signed short from stream (extend to int).
Signature
getS16():short
Returns
short

 
 top of page
Method getS8
Read signed byte from stream (extend to int).
Signature
getS8():byte
Returns
byte

 
 top of page
Method getSize
Signature
getSize():int
Returns
int

 
 top of page
Method getU16
Read unsigned short from stream.
Signature
getU16():short
Returns
short

 
 top of page
Method getU16a
Read unsigned shorts and store in array object (will be reallocated).
Signature
getU16a(Objecta,
  intnum 
  )  
Arguments
Objecta
intnum

 
 top of page
Method getU8
Read unsigned byte from stream.
Signature
getU8():byte
Returns
byte

 
 top of page
Method getU8a
Read unsigned bytes and store in array object (will be reallocated).
Signature
getU8a(Objecta,
  intnum 
  )  
Arguments
Objecta
intnum

 
 top of page
Method readBuffer
Signature
readBuffer(Bufferbuf,
  intoff,
  intnum,
  booleanbResize 
  )  
 :int
Arguments
Bufferbuf
intoff
intnum
booleanbResize
Returns
int

 
 top of page
Method readLine
Signature
readLine(Strings,
  intmax 
  )  
 :boolean
Arguments
Strings
intmax
Returns
boolean

 
 top of page
Method readString
Signature
readString(Strings,
  intnum 
  )  
 :boolean
Arguments
Strings
intnum
Returns
boolean

 
 top of page
Method seek
Signature
seek(intoff,
  intmode 
  )  
Arguments
intoff
intmode

 
 top of page
Method serialize
Signature
serialize(Objectsrc,
  booleanbTypeInfo 
  )  
Arguments
Objectsrc
booleanbTypeInfo

 
 top of page
Method setBgra
Write b,g,r,a bytes from packed ARGB32 integer
Signature
setBgra(intargb32)
Arguments
intargb32

 
 top of page
Method setByteOrder
Signature
setByteOrder(intbyteOrder)
Arguments
intbyteOrder

 
 top of page
Method setF32
Signature
setF32(floatv)
Arguments
floatv

 
 top of page
Method setF32a
Write floats from generic array object
Signature
setF32a(Objecta)
Arguments
Objecta

 
 top of page
Method setF64
@todo make this method take a Double object argument
Signature
setF64(floatv)
Arguments
floatv

 
 top of page
Method setF64a
Write doubles from generic array object
Signature
setF64a(Objecta)
Arguments
Objecta

 
 top of page
Method setI16
Signature
setI16(shortv)
Arguments
shortv

 
 top of page
Method setI16a
Write shorts from generic array object
Signature
setI16a(Objecta)
Arguments
Objecta

 
 top of page
Method setI32
Signature
setI32(intv)
Arguments
intv

 
 top of page
Method setI32a
Write double words from generic array object
Signature
setI32a(Objecta)
Arguments
Objecta

 
 top of page
Method setI8
Signature
setI8(bytev)
Arguments
bytev

 
 top of page
Method setI8a
Write bytes from generic array object
Signature
setI8a(Objecta)
Arguments
Objecta

 
 top of page
Method setObject
Signature
setObject(Objectsrc)
Arguments
Objectsrc

 
 top of page
Method setOffset
Signature
setOffset(intoffset)
Arguments
intoffset

 
 top of page
Method setRgba
Write r,g,b,a bytes from packed ARGB32 integer
Signature
setRgba(intargb32)
Arguments
intargb32

 
 top of page
Method writeBuffer
Signature
writeBuffer(Bufferbuf,
  intoff,
  intnum 
  )  
 :boolean
Arguments
Bufferbuf
intoff
intnum
Returns
boolean

 
 top of page
Method writeString
Signature
writeString(Strings,
  intoff,
  intnum 
  )  
 :boolean
Arguments
Strings
intoff
intnum
Returns
boolean

 
 top of page
 

Project Modules:core 
Project Classes:Boolean , Buffer , Byte , Class , ClassArray , Condition , Configuration , Double , DummyStream , Envelope , Event , Exception , File , Float , FloatArray , FloatArray128 , FloatArray16 , FloatArray32 , FloatArray64 , FloatArray8 , Function , HashTable , IntArray , IntArray128 , IntArray16 , IntArray32 , IntArray64 , IntArray8 , Integer , LFSR , LFSR_NR , List , ListNode , Long , Mailbox , Mutex , Object , ObjectArray , PakFile , PointerArray , Pool , Process , Script , SharedBuffer , Short , Stack , StdErrStream , StdInStream , StdOutStream , Stream , String , String128 , String16 , String32 , String64 , String8 , StringArray , StringIterator , Thread , Time , TKS , TreeNode , UnsignedByte , UnsignedInteger , UnsignedLong , UnsignedShort , Value , ValueArray , Variable 
Project Functions:ceil , exit , floor , GetCurrentThread , getenv , lcchar , mathAbsMaxf , mathAbsMinf , mathAbsMini , mathAbsMini , mathCerpf , mathClampf , mathClampi , mathDistancePointPlane2d , mathFoldf , mathFoldi , mathGCD , mathLerpCyclicf , mathLerpf , mathMaxf , mathMaxi , mathMinf , mathMini , mathNextCyclicf , mathPowerf , mathPowerfC , mathPoweri , mathSerpf , mathSmoothStepf , mathSmoothStepNf , mathWrapf , mathWrapi , milliSeconds , milliSecondsDouble , psystem , putenv , srand , system , ucchar 
All Namespaces:default , graph , ui 
All Projects:core , eqxmms , ShaderVG , ShaderVG_Text , tkanalogrytm , tkchipmunk , tkclap , tkfileutils , tkfreeglut , tkfreetype2 , tkfreeverb , tkmath , tkmidi , tkmidipipe , tkminnie , tkoldmath , tkopengl , tkportaudio , tkradiastools , tksamplechain , tksampleedit , tksampler , tksdl , tksdl_net , tksidplay2 , tkspeexdsp , tksqlite , tktriangulate , tkui , tkvst2 , tkzip , ui , yingtest 


auto-generated by "DOG", the TkScript document generator. Thu, 11/Dec/2025 13:41:59