buffer_write

Writes data to a buffer.

Syntax:

buffer_write(buffer, type, value)


ArgumentDescription
buffer The index of the buffer to write to.
type The type of data that is to be written to the buffer (see the list of constants below).
value The data to write.


Returns: N/A


Description

This function can be used to write data to a previously created buffer. The data you write must be in agreement with the "type" argument of this function, meaning that you can't try to write a string as an unsigned 16bit integer, for example. The following constants can be used to define the data type:

ConstantDescription
buffer_u8An unsigned, 8bit integer. This is a positive value from 0 to 255.
buffer_s8A signed, 8bit integer. This can be a positive or negative value from -128 to 127 (0 is classed as positive).
buffer_u16An unsigned, 16bit integer. This is a positive value from 0 - 65,535.
buffer_s16A signed, 16bit integer. This can be a positive or negative value from -32,768 to 32,767 (0 is classed as positive).
buffer_u32An unsigned, 32bit integer. This is a positive value from 0 to 4,294,967,295.
buffer_s32A signed, 32bit integer. This can be a positive or negative value from -2,147,483,648 to 2,147,483,647 (0 is classed as positive).
buffer_u64An unsigned 64bit integer. This can be a positive or negative value from -(263) to 263 - 1.
buffer_f16A 16bit float. This can be a positive or negative value within the same range as a 16 bit signed integer. (Not currently supported!)
buffer_f32A 32bit float. This can be a positive or negative value within the same range as a 32 bit signed integer.
buffer_f64A 64bit float. This can be a positive or negative value from -(263) to 263 - 1.
buffer_boolA boolean value. Can only be either 1 or 0 (true or false)
buffer_stringA string of any size, finalized with a null terminating character.
buffer_textA string of any size, without the final null terminating character.


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 with the id stored in the variable "buff" them writes a series of signed 16bit integer values to it.


Back: Buffers
Next: buffer_fill

© Copyright YoYo Games Ltd. 2018 All Rights Reserved