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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
|
page.title=RenderScript Vector Math Functions
@jd:body
<div class='renderscript'>
<h2>Overview</h2>
<p> These functions interpret the input arguments as representation of vectors in
n-dimensional space.
</p>
<p> The precision of the mathematical operations on 32 bit floats is affected by the pragmas
rs_fp_relaxed and rs_fp_full. See <a href='rs_math.html'>Mathematical Constants and Functions</a> for details.
</p>
<p> Different precision/speed tradeoffs can be achieved by using variants of the common math
functions. Functions with a name starting with<ul>
<li>native_: May have custom hardware implementations with weaker precision. Additionally,
subnormal values may be flushed to zero, rounding towards zero may be used, and NaN and
infinity input may not be handled correctly.</li>
<li>fast_: May perform internal computations using 16 bit floats. Additionally, subnormal
values may be flushed to zero, and rounding towards zero may be used.</li>
</ul>
</p>
<h2>Summary</h2>
<table class='jd-sumtable'><tbody>
<tr><th colspan='2'>Functions</th></tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:cross'>cross</a>
</td>
<td class='jd-descrcol' width='100%'>
Cross product of two vectors
</td>
</tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:distance'>distance</a>
</td>
<td class='jd-descrcol' width='100%'>
Distance between two points
</td>
</tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:dot'>dot</a>
</td>
<td class='jd-descrcol' width='100%'>
Dot product of two vectors
</td>
</tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:fast_distance'>fast_distance</a>
</td>
<td class='jd-descrcol' width='100%'>
Approximate distance between two points
</td>
</tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:fast_length'>fast_length</a>
</td>
<td class='jd-descrcol' width='100%'>
Approximate length of a vector
</td>
</tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:fast_normalize'>fast_normalize</a>
</td>
<td class='jd-descrcol' width='100%'>
Approximate normalized vector
</td>
</tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:length'>length</a>
</td>
<td class='jd-descrcol' width='100%'>
Length of a vector
</td>
</tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:native_distance'>native_distance</a>
</td>
<td class='jd-descrcol' width='100%'>
Approximate distance between two points
</td>
</tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:native_length'>native_length</a>
</td>
<td class='jd-descrcol' width='100%'>
Approximate length of a vector
</td>
</tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:native_normalize'>native_normalize</a>
</td>
<td class='jd-descrcol' width='100%'>
Approximately normalize a vector
</td>
</tr>
<tr class='alt-color api apilevel-1'>
<td class='jd-linkcol'>
<a href='rs_vector_math.html#android_rs:normalize'>normalize</a>
</td>
<td class='jd-descrcol' width='100%'>
Normalize a vector
</td>
</tr>
</tbody></table>
<h2>Functions</h2>
<a name='android_rs:cross'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>cross</span>
<span class='normal'>: Cross product of two vectors</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td><a href='rs_value_types.html#android_rs:float3'>float3</a> cross(<a href='rs_value_types.html#android_rs:float3'>float3</a> left_vector, <a href='rs_value_types.html#android_rs:float3'>float3</a> right_vector);
</td>
<td> </td>
</tr>
<tr>
<td><a href='rs_value_types.html#android_rs:float4'>float4</a> cross(<a href='rs_value_types.html#android_rs:float4'>float4</a> left_vector, <a href='rs_value_types.html#android_rs:float4'>float4</a> right_vector);
</td>
<td> </td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Computes the cross product of two vectors.
</p>
</div>
</div>
<a name='android_rs:distance'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>distance</span>
<span class='normal'>: Distance between two points</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td>float distance(float left_vector, float right_vector);
</td>
<td> </td>
</tr>
<tr>
<td>float distance(<a href='rs_value_types.html#android_rs:float2'>float2</a> left_vector, <a href='rs_value_types.html#android_rs:float2'>float2</a> right_vector);
</td>
<td> </td>
</tr>
<tr>
<td>float distance(<a href='rs_value_types.html#android_rs:float3'>float3</a> left_vector, <a href='rs_value_types.html#android_rs:float3'>float3</a> right_vector);
</td>
<td> </td>
</tr>
<tr>
<td>float distance(<a href='rs_value_types.html#android_rs:float4'>float4</a> left_vector, <a href='rs_value_types.html#android_rs:float4'>float4</a> right_vector);
</td>
<td> </td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Compute the distance between two points.
</p>
<p> See also <a href='rs_vector_math.html#android_rs:fast_distance'>fast_distance</a>(), <a href='rs_vector_math.html#android_rs:native_distance'>native_distance</a>().
</p>
</div>
</div>
<a name='android_rs:dot'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>dot</span>
<span class='normal'>: Dot product of two vectors</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td>float dot(float left_vector, float right_vector);
</td>
<td> </td>
</tr>
<tr>
<td>float dot(<a href='rs_value_types.html#android_rs:float2'>float2</a> left_vector, <a href='rs_value_types.html#android_rs:float2'>float2</a> right_vector);
</td>
<td> </td>
</tr>
<tr>
<td>float dot(<a href='rs_value_types.html#android_rs:float3'>float3</a> left_vector, <a href='rs_value_types.html#android_rs:float3'>float3</a> right_vector);
</td>
<td> </td>
</tr>
<tr>
<td>float dot(<a href='rs_value_types.html#android_rs:float4'>float4</a> left_vector, <a href='rs_value_types.html#android_rs:float4'>float4</a> right_vector);
</td>
<td> </td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Computes the dot product of two vectors.
</p>
</div>
</div>
<a name='android_rs:fast_distance'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>fast_distance</span>
<span class='normal'>: Approximate distance between two points</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td>float fast_distance(float left_vector, float right_vector);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
<tr>
<td>float fast_distance(<a href='rs_value_types.html#android_rs:float2'>float2</a> left_vector, <a href='rs_value_types.html#android_rs:float2'>float2</a> right_vector);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
<tr>
<td>float fast_distance(<a href='rs_value_types.html#android_rs:float3'>float3</a> left_vector, <a href='rs_value_types.html#android_rs:float3'>float3</a> right_vector);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
<tr>
<td>float fast_distance(<a href='rs_value_types.html#android_rs:float4'>float4</a> left_vector, <a href='rs_value_types.html#android_rs:float4'>float4</a> right_vector);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Computes the approximate distance between two points.
</p>
<p> The precision is what would be expected from doing the computation using 16 bit floating
point values.
</p>
<p> See also <a href='rs_vector_math.html#android_rs:distance'>distance</a>(), <a href='rs_vector_math.html#android_rs:native_distance'>native_distance</a>().
</p>
</div>
</div>
<a name='android_rs:fast_length'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>fast_length</span>
<span class='normal'>: Approximate length of a vector</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td>float fast_length(float v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
<tr>
<td>float fast_length(<a href='rs_value_types.html#android_rs:float2'>float2</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
<tr>
<td>float fast_length(<a href='rs_value_types.html#android_rs:float3'>float3</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
<tr>
<td>float fast_length(<a href='rs_value_types.html#android_rs:float4'>float4</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Computes the approximate length of a vector.
</p>
<p> The precision is what would be expected from doing the computation using 16 bit floating
point values.
</p>
<p> See also <a href='rs_vector_math.html#android_rs:length'>length</a>(), <a href='rs_vector_math.html#android_rs:native_length'>native_length</a>().
</p>
</div>
</div>
<a name='android_rs:fast_normalize'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>fast_normalize</span>
<span class='normal'>: Approximate normalized vector</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td>float fast_normalize(float v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
<tr>
<td><a href='rs_value_types.html#android_rs:float2'>float2</a> fast_normalize(<a href='rs_value_types.html#android_rs:float2'>float2</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
<tr>
<td><a href='rs_value_types.html#android_rs:float3'>float3</a> fast_normalize(<a href='rs_value_types.html#android_rs:float3'>float3</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
<tr>
<td><a href='rs_value_types.html#android_rs:float4'>float4</a> fast_normalize(<a href='rs_value_types.html#android_rs:float4'>float4</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 17</a>
</td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Approximately normalizes a vector.
</p>
<p> For vectors of size 1, returns -1.f for negative values, 0.f for null values, and 1.f for
positive values.
</p>
<p> The precision is what would be expected from doing the computation using 16 bit floating
point values.
</p>
<p> See also <a href='rs_vector_math.html#android_rs:normalize'>normalize</a>(), <a href='rs_vector_math.html#android_rs:native_normalize'>native_normalize</a>().
</p>
</div>
</div>
<a name='android_rs:length'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>length</span>
<span class='normal'>: Length of a vector</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td>float length(float v);
</td>
<td> </td>
</tr>
<tr>
<td>float length(<a href='rs_value_types.html#android_rs:float2'>float2</a> v);
</td>
<td> </td>
</tr>
<tr>
<td>float length(<a href='rs_value_types.html#android_rs:float3'>float3</a> v);
</td>
<td> </td>
</tr>
<tr>
<td>float length(<a href='rs_value_types.html#android_rs:float4'>float4</a> v);
</td>
<td> </td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Computes the length of a vector.
</p>
<p> See also <a href='rs_vector_math.html#android_rs:fast_length'>fast_length</a>(), <a href='rs_vector_math.html#android_rs:native_length'>native_length</a>().
</p>
</div>
</div>
<a name='android_rs:native_distance'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>native_distance</span>
<span class='normal'>: Approximate distance between two points</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td>float native_distance(float left_vector, float right_vector);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
<tr>
<td>float native_distance(<a href='rs_value_types.html#android_rs:float2'>float2</a> left_vector, <a href='rs_value_types.html#android_rs:float2'>float2</a> right_vector);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
<tr>
<td>float native_distance(<a href='rs_value_types.html#android_rs:float3'>float3</a> left_vector, <a href='rs_value_types.html#android_rs:float3'>float3</a> right_vector);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
<tr>
<td>float native_distance(<a href='rs_value_types.html#android_rs:float4'>float4</a> left_vector, <a href='rs_value_types.html#android_rs:float4'>float4</a> right_vector);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Computes the approximate distance between two points.
</p>
<p> See also <a href='rs_vector_math.html#android_rs:distance'>distance</a>(), <a href='rs_vector_math.html#android_rs:fast_distance'>fast_distance</a>().
</p>
</div>
</div>
<a name='android_rs:native_length'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>native_length</span>
<span class='normal'>: Approximate length of a vector</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td>float native_length(float v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
<tr>
<td>float native_length(<a href='rs_value_types.html#android_rs:float2'>float2</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
<tr>
<td>float native_length(<a href='rs_value_types.html#android_rs:float3'>float3</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
<tr>
<td>float native_length(<a href='rs_value_types.html#android_rs:float4'>float4</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Compute the approximate length of a vector.
</p>
<p> See also <a href='rs_vector_math.html#android_rs:length'>length</a>(), <a href='rs_vector_math.html#android_rs:fast_length'>fast_length</a>().
</p>
</div>
</div>
<a name='android_rs:native_normalize'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>native_normalize</span>
<span class='normal'>: Approximately normalize a vector</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td>float native_normalize(float v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
<tr>
<td><a href='rs_value_types.html#android_rs:float2'>float2</a> native_normalize(<a href='rs_value_types.html#android_rs:float2'>float2</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
<tr>
<td><a href='rs_value_types.html#android_rs:float3'>float3</a> native_normalize(<a href='rs_value_types.html#android_rs:float3'>float3</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
<tr>
<td><a href='rs_value_types.html#android_rs:float4'>float4</a> native_normalize(<a href='rs_value_types.html#android_rs:float4'>float4</a> v);
</td>
<td> Added in <a href='http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels'>API level 21</a>
</td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Approximately normalizes a vector.
</p>
<p> See also <a href='rs_vector_math.html#android_rs:normalize'>normalize</a>(), <a href='rs_vector_math.html#android_rs:fast_normalize'>fast_normalize</a>().
</p>
</div>
</div>
<a name='android_rs:normalize'></a>
<div class='jd-details'>
<h4 class='jd-details-title'>
<span class='sympad'>normalize</span>
<span class='normal'>: Normalize a vector</span>
</h4>
<div class='jd-details-descr'>
<table class='jd-tagtable'><tbody>
<tr>
<td>float normalize(float v);
</td>
<td> </td>
</tr>
<tr>
<td><a href='rs_value_types.html#android_rs:float2'>float2</a> normalize(<a href='rs_value_types.html#android_rs:float2'>float2</a> v);
</td>
<td> </td>
</tr>
<tr>
<td><a href='rs_value_types.html#android_rs:float3'>float3</a> normalize(<a href='rs_value_types.html#android_rs:float3'>float3</a> v);
</td>
<td> </td>
</tr>
<tr>
<td><a href='rs_value_types.html#android_rs:float4'>float4</a> normalize(<a href='rs_value_types.html#android_rs:float4'>float4</a> v);
</td>
<td> </td>
</tr>
</tbody></table>
</div>
<div class='jd-tagdata jd-tagdescr'>
<p> Normalize a vector.
</p>
<p> For vectors of size 1, returns -1.f for negative values, 0.f for null values, and 1.f for
positive values.
</p>
<p> See also <a href='rs_vector_math.html#android_rs:fast_normalize'>fast_normalize</a>(), <a href='rs_vector_math.html#android_rs:native_normalize'>native_normalize</a>().
</p>
</div>
</div>
</div>
|
