Buffer.readbits

Available since: Gideros 2026.1
Class: buffer_luau

Description

Reads a range of bitCount bits from the buffer, at specified offset bitOffset, into an unsigned integer.

(number) = buffer.readbits(b,bitOffset,bitCount)

bitCount must be in [0, 32] range.

Parameters

b: (buffer) the buffer
bitOffset: (number) offset from the beginning of the buffer memory, starting from 0
bitCount: (number) length to read

Return values

Returns (number) the bitCount bits from the buffer

Example

---

• 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