This library is a back-ported feature from
[Lua 5.2](https://www.lua.org/manual/5.2/manual.html#6.7) that provides
functions to perform bitwise operations.


Returns the number `x` shifted `disp` bits to the right. The number `disp`
may be any representable integer. Negative displacements shift to the
left.

This shift operation is what is called arithmetic shift. Vacant bits on
the left are filled with copies of the higher bit of `x`; vacant bits on
the right are filled with zeros. In particular, displacements with
absolute values higher than 31 result in zero or 0xFFFFFFFF (all original
bits are shifted out).


bit32.arshift

disp

Returns a number after its bits have been arithmetically shifted to the
right by a given displacement.


Returns the bitwise _and_ of its operands.


bit32.band

numbers

Returns the bitwise negation of `x`. For any integer `x`, the following
identity holds:

```lua
assert(bit32.bnot(x) == (-1 - x) % 2^32)
```


bit32.bnot

Returns the bitwise negation of a given number.


Returns the bitwise _or_ of its operands.


bit32.bor

Returns a boolean signalling whether the bitwise _and_ of its operands is
different from zero.


bit32.btest

Returns a boolean describing whether the bitwise and of its operands is
different from zero.


Returns the bitwise _exclusive or_ of its operands.


bit32.bxor

Returns the bitwise exclusive or of its operands.


Returns the number of consecutive zero bits in the 32-bit representation
of the provided number starting from the left-most (most significant) bit.
Returns 32 if the provided number is zero.


bit32.countlz

Returns the number of consecutive zero bits in the 32-bit representation
of the provided number starting from the left-most (most significant) bit.


Returns the number of consecutive zero bits in the 32-bit representation
of the provided number starting from the right-most (least significant)
bit. Returns 32 if the provided number is zero.


bit32.countrz

Returns the number of consecutive zero bits in the 32-bit representation
of the provided number starting from the right-most (least significant)
bit.


Returns the unsigned number formed by the bits `field` to
`field + width - 1` from `n`. Bits are numbered from 0 (least significant)
to 31 (most significant). All accessed bits must be in the range [0, 31].
The default for `width` is 1.


bit32.extract

field

width

Extract a range of bits from a number and return them as an unsigned
number.


Returns a copy of `n` with the bits `field` to `field + width - 1`
replaced by the value `v`. See `Library.bit32.extract()` for details about
`field` and `width`.


bit32.replace

Return a copy of a number with a range of bits replaced by a given value.


Returns the number `x` rotated `disp` bits to the left. The number `disp`
may be any representable integer. For any valid displacement, the
following identity holds:

```lua
assert(bit32.lrotate(x, disp) == bit32.lrotate(x, disp % 32))
```

In particular, negative displacements rotate to the right.


bit32.lrotate

Returns a number after its bits have been rotated to the left by a given
number of times.


Returns the number `x` shifted `disp` bits to the left. The number `disp`
may be any representable integer. Negative displacements shift to the
right. In any direction, vacant bits are filled with zeros. In particular,
displacements with absolute values higher than 31 result in zero (all bits
are shifted out).

For positive displacements, the following equality holds:

```lua
assert(bit32.lshift(b, disp) == (b * 2^disp) % 2^32)
```


bit32.lshift

Returns a number whose bits have been logically shifted to the left by a
given displacement.


Returns the number `x` rotated `disp` bits to the right. The number `disp`
may be any representable integer.

For any valid displacement, the following identity holds:

```lua
assert(bit32.rrotate(x, disp) == bit32.rrotate(x , disp % 32))
```

In particular, negative displacements rotate to the left.


bit32.rrotate

Returns a number after its bits have been rotated to the right by a given
number of times.


Returns the number `x` shifted `disp` bits to the right. The number `disp`
may be any representable integer. Negative displacements shift to the
left. In any direction, vacant bits are filled with zeros. In particular,
displacements with absolute values higher than 31 result in zero (all bits
are shifted out).

For positive displacements, the following equality holds:

```lua
assert(bit32.rshift(b, disp) == math.floor(b % 2^32 / 2^disp))
```

This shift operation is what is called logical shift.


bit32.rshift

Returns a number whose bits have been logically shifted to the right by a
given displacement.


bit32

A library of functions to perform bitwise operations.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

bit32

Summary

Functions

Functions

arshift

Parameters

Returns

band

Parameters

Returns

bnot

Parameters

Returns

bor

Parameters

Returns

btest

Parameters

Returns

bxor

Parameters

Returns

countlz

Parameters

Returns

countrz

Parameters

Returns

extract

Parameters

Returns

replace

Parameters

Returns

lrotate

Parameters

Returns

lshift

Parameters

Returns

rrotate

Parameters

Returns

rshift

Parameters

Returns