This function returns the type of a given buffer.
The return value will be one of the following constants:
| Buffer Type Constant | |
|---|---|
| Constant | Description |
| buffer_fixed | A buffer of fixed size. |
| buffer_grow | A buffer that will "grow" dynamically as data is added |
| buffer_wrap | A buffer where the data will "wrap". When the data being added reaches the limit of the buffer size, the overwrite will be placed back at the start of the buffer, and further writing will continue from that point. |
| buffer_fast | A special "stripped" buffer that is extremely fast to read/write to. Can only be used with buffer_u8 data types, and must be 1 byte aligned. |
buffer_get_type(buffer);
| Argument | Type | Description |
|---|---|---|
| buffer | Buffer | The buffer to check. |
type = buffer_get_type(buff);
The above code gets the type of the buffer stored in the variable buff and stores it in a variable.