Lua:signExtend

<> Lua API Reference

function signExtend(value, mostSignificantBit) : integer

Sign-extends the given value.

If the specified most significant bit is set, the value will be extended as a negative signed integer. If the bit is not set, the value remains positive.

Function Parameters

Parameter	Type	Description
value	Integer	The value to sign-extend.
mostSignificantBit	Integer	The bit index to treat as the most significant sign bit.

Returns

integer — The sign-extended integer value.

Examples

1 local value = signExtend(0x7F, 7)
2 
3 print(value)
4 -- 127

1 local value = signExtend(0x80, 7)
2 
3 print(value)
4 -- -128

1 local value = signExtend(0xFF, 7)
2 
3 print(value)
4 -- -1

Main Pages

Core Lua documentation entry points

◆ Lua
◆ Script Engine