Buffer.read

Available since: Gideros 2025.1
Class: buffer_luau

Description

Reads the data from the buffer by reinterpreting bytes at the offset and converting it into a number.

(number) = buffer.readi8(b,offset)
(number) = buffer.readu8(b,offset)
(number) = buffer.readi16(b,offset)
(number) = buffer.readu16(b,offset)
(number) = buffer.readi32(b,offset)
(number) = buffer.readu32(b,offset)
(number) = buffer.readf32(b,offset)
(number) = buffer.readf64(b,offset)

Parameters

b: (buffer) the buffer
offset: (number) offset from the beginning of the buffer memory, starting from 0

Return values

Returns (number) data buffer converted as a number

• readi8:an 8-bit signed integer from the buffer
• readu8: an 8-bit unsigned integer from the buffer
• readi16: a 16-bit signed integer from the buffer
• readu16: a 16-bit unsigned integer from the buffer
• readi32: a 32-bit signed integer from the buffer
• readu32: a 32-bit unsigned integer from the buffer
• readf32: a 32-bit floating-point value from the buffer
• readf64: a 64-bit floating-point value from the buffer

Example

local str = "Hello Gideros!"
local b = buffer.fromstring(str)
local offset = 0
print(buffer.readi8(b, offset))
print(buffer.readu8(b, offset))
print(buffer.readi16(b, offset))
print(buffer.readu16(b, offset))
print(buffer.readi32(b, offset))
print(buffer.readu32(b, offset))
print(buffer.readf32(b, offset))
print(buffer.readf64(b, offset))

---

• buffer.copy
  
• buffer.create
  
• buffer.extract
  
• buffer.fill
  
• buffer.fromstring
  
• buffer.len
  
• buffer.read
  
• buffer.readstring
  
• buffer.resize
  
• buffer.setarrayaccess
  
• buffer.tostring
  
• buffer.write
  
• buffer.writestring
  

---

---

• Main Page
• Lua API
• Main API
• Plugins