BitExtract

	Script Example Missing Function BitExtract needs a script example, help out by writing one.
	Before submitting check out Editing Guidelines Script Examples.

This function returns the unsigned number formed by the bits field to field + width - 1 (range: 0-31).

Syntax

uint bitExtract ( uint var, int field, [int width = 1] )

Required arguments

• var: The value
• field: The field number
• width: Number of bits to extract

Returns

Returns the extracted value/bit sequence.

Example

function getColorAlpha(color)
   return bitExtract(color,24,8) -- return bits 24-32 ( the alpha, http://en.wikipedia.org/wiki/RGBA_color_space ) 
end

See Also

• bitAnd
• bitNot
• bitOr
• bitXor
• bitTest
• bitLRotate
• bitRRotate
• bitLShift
• bitRShift
• bitArShift
• bitExtract
• bitReplace