1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
|
[//]: # (generated using SlashBack 0.2.0)
# func\_integer methods
The following methods are all part of the **func\_integer methods**\.
It contains GLSL functions on integer types\.
## Table of contents
* [**bitCount** function](#bitcount-function)
* [**bitfieldExtract** function](#bitfieldextract-function)
* [**bitfieldInsert** function](#bitfieldinsert-function)
* [**bitfieldReverse** function](#bitfieldreverse-function)
* [**findLSB** function](#findlsb-function)
* [**findMSB** function](#findmsb-function)
* [**imulExtended** function](#imulextended-function)
* [**uaddCarry** function](#uaddcarry-function)
* [**umulExtended** function](#umulextended-function)
* [**usubBorrow** function](#usubborrow-function)
### bitCount\(\) function
#### <code>glm.<code>**bitCount**(**v**: *int*) -\> *int*</code></code>
  Returns the number of bits set to ``` 1 ``` in the binary representation of ``` value ```\.
#### <code>glm.<code>**bitCount**(**v**: *vecN*) -\> *ivecN*</code></code>
  For every component ``` c ``` of ``` v ```:
  Returns the number of bits set to ``` 1 ``` in the binary representation of ``` c ```\.
### bitfieldExtract\(\) function
#### <code>glm.<code>**bitfieldExtract**(**value**: *ctypes*, **offset**: *int*, **bits**: *int*) -\> *int*</code></code>
  Extracts bits ``` [offset, offset + bits - 1] ``` from value, returning them in the least
  significant bits of the result\. For unsigned data types, the most significant bits of the
  result will be set to zero\. For signed data types, the most significant bits will be set to
  the value of bit ``` offset + base - 1 ```\. If ``` bits ``` is zero, the result will be zero\. The result
  will be undefined if ``` offset ``` or ``` bits ``` is negative, or if the sum of ``` offset ``` and ``` bits ``` is
  greater than the number of bits used to store the operand\.
  You can use ``` int32 ```, ``` uint32 ```, ``` int64 ``` or ``` uint64 ``` types to specify the number of bits and the
  sign\.
#### <code>glm.<code>**bitfieldExtract**(**value**: *vecN*, **offset**: *int*, **bits**: *int*) -\> *vecN*</code></code>
  Returns ``` bitfieldExtract(c, offset, bits) ``` for every component ``` c ``` of ``` value ```\.
### bitfieldInsert\(\) function
#### <code>glm.<code>**bitfieldInsert**(**base**: *ctypes*, **insert**: *ctypes*, **offset**: *int*, **bits**: *int*) -\> *int*</code></code>
  Returns the insertion the bits least\-significant bits of insert into base\. The result will
  have ``` bits[offset, offset + bits - 1] ``` taken from ``` bits[0, bits - 1] ``` of ``` insert ```, and all other
  bits taken directly from the corresponding bits of ``` base ```\. If ``` bits ``` is zero, the result will
  simply be ``` base ```\. The result will be undefined if ``` offset ``` or ``` bits ``` is negative, or if the sum of
  ``` offset ``` and ``` bits ``` is greater than the number of bits used to store the operand\.
  You can use ``` int32 ```, ``` uint32 ```, ``` int64 ``` or ``` uint64 ``` types to specify the number of bits and the
  sign\.
#### <code>glm.<code>**bitfieldInsert**(**base**: *vecN*, **insert**: *vecN*, **offset**: *int*, **bits**: *int*) -\> *vecN*</code></code>
  Returns ``` bitfieldInsert(base[i], insert[i], offset, bits) ``` for every index ``` i ```\.
### bitfieldReverse\(\) function
#### <code>glm.<code>**bitfieldReverse**(**value**: *ctypes*) -\> *int*</code></code>
  Returns the reversal of the bits of ``` value ```\. The bit numbered ``` n ``` of the result will be taken
  from ``` bit(bits - 1) - n ``` of ``` value ```, where ``` bits ``` is the total number of bits used to represent
  ``` value ```\. You can use ``` int32 ```, ``` uint32 ```, ``` int64 ``` or ``` uint64 ``` types to specify the number of bits
  and the sign\.
#### <code>glm.<code>**bitfieldReverse**(**value**: *vecN*) -\> *vecN*</code></code>
  Returns the reversal of the bits of ``` value ```\. The bit numbered ``` n ``` of the result will be taken
  from ``` bit(bits - 1) - n ``` of ``` value ```, where ``` bits ``` is the total number of bits used to represent
  ``` value ```\.
### findLSB\(\) function
#### <code>glm.<code>**findLSB**(**value**: *int*) -\> *int*</code></code>
  Returns the bit number of the least significant bit set to ``` 1 ``` in the binary representation
  of ``` value ```\. If ``` value ``` is zero, ``` -1 ``` will be returned\.
#### <code>glm.<code>**findLSB**(**value**: *vecN*) -\> *ivecN*</code></code>
  Returns the bit number of the least significant bit set to ``` 1 ``` in the binary representation
  of ``` value ```\. If ``` value ``` is zero, ``` -1 ``` will be returned\.
### findMSB\(\) function
#### <code>glm.<code>**findMSB**(**value**: *int*) -\> *int*</code></code>
  Returns the bit number of the most significant bit in the binary representation of ``` value ```\.
  For positive integers, the result will be the bit number of the most significant bit set to
  ``` 1 ```\. For negative integers, the result will be the bit number of the most significant bit set
  to ``` 0 ```\. For a value of zero or negative one, ``` -1 ``` will be returned\.
#### <code>glm.<code>**findMSB**(**value**: *vecN*) -\> *ivecN*</code></code>
  Returns the bit number of the least significant bit set to ``` 1 ``` in the binary representation
  of ``` value ```\. If ``` value ``` is zero, ``` -1 ``` will be returned\.
### imulExtended\(\) function
#### <code>glm.<code>**imulExtended**(**x**: *int*, **y**: *int*) -\> *(msb: int, lsb: int)*</code></code>
  Multiplies 32\-bit integers ``` x ``` and ``` y ```, producing a 64\-bit result\. The 32 least\-significant
  bits are returned in ``` lsb ```\. The 32 most\-significant bits are returned in ``` msb ```\.
#### <code>glm.<code>**imulExtended**(**x**: *ivecN*, **y**: *ivecN*, **msb**: *ivecN*, **lsb**: *ivecN*) -\> *ivecN*</code></code>
  Multiplies 32\-bit integers ``` x ``` and ``` y ```, producing a 64\-bit result\. The 32 least\-significant
  bits are returned in ``` lsb ```\. The 32 most\-significant bits are returned in ``` msb ```\.
### uaddCarry\(\) function
#### <code>glm.<code>**uaddCarry**(**x**: *int*, **y**: *int*) -\> *(result: int, carry: int)*</code></code>
  Adds 32\-bit unsigned integer ``` x ``` and ``` y ```, returning the ``` sum ``` modulo ``` pow(2, 32) ```\. The value carry
  is set to ``` 0 ``` if the ``` sum ``` was less than ``` pow(2, 32) ```, or to ``` 1 ``` otherwise\.
#### <code>glm.<code>**uaddCarry**(**x**: *uvecN*, **y**: *uvecN*, **carry**: *uvecN*) -\> *uvecN*</code></code>
  Adds 32\-bit unsigned integer ``` x ``` and ``` y ```, returning the ``` sum ``` modulo ``` pow(2, 32) ```\. The value carry
  is set to ``` 0 ``` if the ``` sum ``` was less than ``` pow(2, 32) ```, or to ``` 1 ``` otherwise\.
### umulExtended\(\) function
#### <code>glm.<code>**umulExtended**(**x**: *int*, **y**: *int*) -\> *(msb: int, lsb: int)*</code></code>
  Multiplies 32\-bit integers ``` x ``` and ``` y ```, producing a 64\-bit result\. The 32 least\-significant
  bits are returned in ``` lsb ```\. The 32 most\-significant bits are returned in ``` msb ```\.
#### <code>glm.<code>**umulExtended**(**x**: *uvecN*, **y**: *uvecN*, **msb**: *uvecN*, **lsb**: *uvecN*) -\> *uvecN*</code></code>
  Multiplies 32\-bit integers ``` x ``` and ``` y ```, producing a 64\-bit result\. The 32 least\-significant
  bits are returned in ``` lsb ```\. The 32 most\-significant bits are returned in ``` msb ```\.
### usubBorrow\(\) function
#### <code>glm.<code>**usubBorrow**(**x**: *int*, **y**: *int*) -\> *(result: int, borrow: int)*</code></code>
  Subtracts the 32\-bit unsigned integer ``` y ``` from ``` x ```, returning the difference if non\-negative,
  or ``` pow(2, 32) ``` plus the difference otherwise\. The value borrow is set to ``` 0 ``` if ``` x >= y ```, or to
  ``` 1 ``` otherwise\.
#### <code>glm.<code>**usubBorrow**(**x**: *uvecN*, **y**: *uvecN*, **borrow**: *uvecN*) -\> *uvecN*</code></code>
  Subtracts the 32\-bit unsigned integer ``` y ``` from ``` x ```, returning the difference if non\-negative,
  or ``` pow(2, 32) ``` plus the difference otherwise\. The value borrow is set to ``` 0 ``` if ``` x >= y ```, or to
  ``` 1 ``` otherwise\.
|