forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bitfieldInsert.xhtml
184 lines (183 loc) · 7.59 KB
/
bitfieldInsert.xhtml
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<div class="refentry" id="bitfieldInsert">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>bitfieldInsert — insert a range of bits into an integer</p>
</div>
<div class="refsynopsisdiv">
<h2>Declaration</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">genIType <strong class="fsfunc">bitfieldInsert</strong>(</code>
</td>
<td>genIType <var class="pdparam">base</var>, </td>
</tr>
<tr>
<td> </td>
<td>genIType <var class="pdparam">insert</var>, </td>
</tr>
<tr>
<td> </td>
<td>int <var class="pdparam">offset</var>, </td>
</tr>
<tr>
<td> </td>
<td>int <var class="pdparam">bits</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">genUType <strong class="fsfunc">bitfieldInsert</strong>(</code>
</td>
<td>genUType <var class="pdparam">base</var>, </td>
</tr>
<tr>
<td> </td>
<td>genUType <var class="pdparam">insert</var>, </td>
</tr>
<tr>
<td> </td>
<td>int <var class="pdparam">offset</var>, </td>
</tr>
<tr>
<td> </td>
<td>int <var class="pdparam">bits</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="parameters">
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<em class="parameter">
<code>base</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the integer into which to insert <em class="parameter"><code>insert</code></em>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>insert</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the the value of the bits to insert.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>offset</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the index of the first bit to insert.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>bits</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the number of bits to insert.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">bitfieldInsert</code> inserts the <em class="parameter"><code>bits</code></em> least significant bits of <em class="parameter"><code>insert</code></em>
into <em class="parameter"><code>base</code></em> at offset <em class="parameter"><code>offset</code></em>. The returned value will have bits
[<em class="parameter"><code>offset</code></em>, <em class="parameter"><code>offset</code></em> + <em class="parameter"><code>bits</code></em> + 1] taken from [0, <em class="parameter"><code>bits</code></em> - 1]
of <em class="parameter"><code>insert</code></em> and all other bits taken directly from the corresponding bits of <em class="parameter"><code>base</code></em>. If
<em class="parameter"><code>bits</code></em> is zero, the result will simply be the original value of <em class="parameter"><code>base</code></em>. The result will
be undefined if <em class="parameter"><code>offset</code></em> or <em class="parameter"><code>bits</code></em> is negative, or if the sum of <em class="parameter"><code>offset</code></em>
and <em class="parameter"><code>bits</code></em> is greater than the number of bits used to store the operand.
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="3">
<span class="bold"><strong>OpenGL ES Shading Language Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>1.00</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.00</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.10</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">bitfieldInsert</code>
</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="bitfieldExtract"><span class="citerefentry"><span class="refentrytitle">bitfieldExtract</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 2011-2014 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<a class="link" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p>
</div>
</div>