→ home

→ index of namespace default

→ index of project core

→ index of module core

Class `core.Buffer`

Synopsis: An array of bytes.

Base classes:

core.Stream

Methods:

fillZero() - Fill the entire buffer with 0.
free() - Free buffer bytes
getChecksum() : int - Return checksum for this Buffer.
getString(int off, max) : String - Extract 0 terminated string from buffer.
gunzip(Buffer src, int off, len, uncompressedSize) - Uncompress the given source buffer.
gzip(Buffer src, int off, len, level) : boolean - Compress the given source buffer.
peekF32(int off) : float - Read 32bit single precision floating point value from the given buffer offset.
peekI16(int off) : short - Read short integer from the given buffer offset.
peekI32(int off) : int - Read 32bit integer from the given buffer offset.
peekI8(int off) : byte - Read byte from the given buffer offset
pokeF32(int off, float value) - Store 32bit single precision floating point value at the given buffer offset.
pokeI16(int off, short value) - Store short integer at the given buffer offset.
pokeI32(int off, value) - Store 32bit integer at the given buffer offset.
pokeI8(int off, byte value) - Store byte at the given buffer offset
resize(int num) : boolean - Change the size of the buffer.
setSize(int num) : boolean - Allocate the given number of bytes.
setString(int off, String s) : boolean - Store 0 terminated string at the given buffer offset.
substring(String r, int off, max) - Extract 0 terminated string from buffer.

Method fillZero

Fill the entire buffer with 0.

Signature

fillZero

(

)

→ top of page

Method free

Free buffer bytes

Signature

free

(

)

→ top of page

Method getChecksum

Return checksum for this Buffer.

Signature

getChecksum

(

)

int

Returns

int

–

32bit buffer checksum

→ top of page

Method getString

Extract 0 terminated string from buffer.

Signature

getString	(	int	off	,
		int	max
		)
	:	String

Arguments

int	off	–	Buffer offset
int	max	–	Maximum number of characters to extract

Returns

String

–

new String instance holding the extracted string

Description

At most "max" characters will be extracted.

→ top of page

Method gunzip

Uncompress the given source buffer.

Signature

gunzip	(	Buffer	src	,
		int	off	,
		int	len	,
		int	uncompressedSize
		)

Arguments

Buffer	src	–	Which buffer to uncompress
int	off	–	Source buffer offset
int	len	–	Compressed size
int	uncompressedSize	–	(maximum) Uncompressed size

Description

This buffer will be resized to the uncompressed size.

→ top of page

Method gzip

Compress the given source buffer.

Signature

gzip	(	Buffer	src	,
		int	off	,
		int	len	,
		int	level
		)
	:	boolean

Arguments

Buffer	src	–	Which buffer to compress
int	off	–	Source offset
int	len	–	Number of bytes to compress
int	level	–	Compression level (0..9)

Returns

boolean

–

true if the given buffer has been compressed successfully, false otherwise.

Description

This buffer will be resized to the compressed size.

→ top of page

Method peekF32

Read 32bit single precision floating point value from the given buffer offset.

Signature

peekF32	(	int	off	)
	:	float

Arguments

int

off

–

Where to read the 32bit floating point value from

Returns

float

–

32bit single precision floating point value

→ top of page

Method peekI16

Read short integer from the given buffer offset.

Signature

peekI16	(	int	off	)
	:	short

Arguments

int

off

–

Where to read the short integer from

Returns

short

–

Short integer

Description

The return value byteorder will be swapped according to the current buffer byteorder.

→ top of page

Method peekI32

Read 32bit integer from the given buffer offset.

Signature

peekI32	(	int	off	)
	:	int

Arguments

int

off

–

Where to read the 32bit integer from

Returns

int

–

32bit integer

Description

The return value byteorder will be swapped according to the current buffer byteorder.

→ top of page

Method peekI8

Read byte from the given buffer offset

Signature

peekI8	(	int	off	)
	:	byte

Arguments

int

off

–

Where to read the byte from

Returns

byte

–

Byte

→ top of page

Method pokeF32

Store 32bit single precision floating point value at the given buffer offset.

Signature

pokeF32	(	int	off	,
		float	value
		)

Arguments

int	off	–	Where to store the floating point value
float	value	–	Which floating point value to store

→ top of page

Method pokeI16

Store short integer at the given buffer offset.

Signature

pokeI16	(	int	off	,
		short	value
		)

Arguments

int	off	–	Where to store the short
short	value	–	Which short to store

Description

The value byteorder will be swapped according to the current buffer byteorder.

→ top of page

Method pokeI32

Store 32bit integer at the given buffer offset.

Signature

pokeI32	(	int	off	,
		int	value
		)

Arguments

int	off	–	Where to store the 32bit integer
int	value	–	Which 32bit integer to store

Description

The value byteorder will be swapped according to the current buffer byteorder.

→ top of page

Method pokeI8

Store byte at the given buffer offset

Signature

pokeI8	(	int	off	,
		byte	value
		)

Arguments

int	off	–	Where to storethe byte
byte	value	–	Which byte to store

→ top of page

Method resize

Change the size of the buffer.

Signature

resize	(	int	num	)
	:	boolean

Arguments

int

num

–

New buffer size

Returns

boolean

–

true if the reallocation succeeded, false otherwise

→ top of page

Method setSize

Allocate the given number of bytes.

Signature

setSize	(	int	num	)
	:	boolean

Arguments

int

num

–

New buffer size

Returns

boolean

–

true if the allocation succeeded, false otherwise

→ top of page

Method setString

Store 0 terminated string at the given buffer offset.

Signature

setString	(	int	off	,
		String	s
		)
	:	boolean

Arguments

int	off	–	Where to store the string
String	s	–	Which string to store

Returns

boolean

–

true if the string has been stored successfully, false otherwise

→ top of page

Method substring

Extract 0 terminated string from buffer.

Signature

substring	(	String	r	,
		int	off	,
		int	max
		)

Arguments

String	r	–	Receives the extracted string
int	off	–	Buffer offset
int	max	–	Maximum number of characters to extract

Description

The result will be written to String "r". At most "max" characters will be written.

→ 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` , `List` , `ListNode` , `Long` , `Mailbox` , `Mutex` , `Object` , `ObjectArray` , `PakFile` , `PointerArray` , `Pool` , `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` , `mathClampf` , `mathClampi` , `mathDistancePointPlane2d` , `mathLerpf` , `mathMaxf` , `mathMaxi` , `mathMinf` , `mathMini` , `mathPowerf` , `mathPoweri` , `mathSmoothStepf` , `mathWrapf` , `mathWrapi` , `milliSeconds` , `psystem` , `putenv` , `srand` , `system` , `ucchar`
All Namespaces:	`default` , `ui`
All Projects:	`core` , `debugtext` , `tkfreetype2` , `tkmath` , `tkmidi` , `tkopengl` , `tkportaudio` , `tksdl` , `tkui` , `tkunit`

auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54

Class core.Buffer

Class `core.Buffer`