buffer_seek

This function moves the seek position of a buffer, setting it relative to the start, end or current seek position (that which was last used when reading or writing data).

The seek position is the offset (in bytes) from the start of the buffer where new values are written, and from where values are read. It also moves automatically when you read from or write to a buffer.

Usage Notes

• The "offset" value is the offset (in bytes) to add to the given seek position, for example, if the base is relative and the offset is 4, then the buffer position will move along 4 bytes from its current position. Please note the following:
  • You can use negative values for the offset to seek back through the buffer as well as positive values.
  • If the buffer is of the "wrap" type and you offset past the end of the buffer, the seek position will also wrap.
  • If the buffer is not of the "wrap" type, the seek will clamp to the beginning or end of the buffer, even when the offset would take the seek outside of the buffer limits.

The following constants are accepted as the "base" argument for seeking to:

Syntax:

buffer_seek(buffer, base, offset);

Returns:

Real (the new seek position)

Example:

buffer_seek(buff, buffer_seek_start, 0);
buffer_write(buff, buffer_s16, 0);
buffer_write(buff, buffer_s16, x);
buffer_write(buff, buffer_s16, y);

The above code finds the start of the buffer stored in the variable buff then writes a series of signed 16bit integer values to it.