Jean-Luc Brouillet | be21638 | 2015-03-22 12:44:27 -0700 | [diff] [blame^] | 1 | # |
| 2 | # Copyright (C) 2015 The Android Open Source Project |
| 3 | # |
| 4 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | # you may not use this file except in compliance with the License. |
| 6 | # You may obtain a copy of the License at |
| 7 | # |
| 8 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | # |
| 10 | # Unless required by applicable law or agreed to in writing, software |
| 11 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | # See the License for the specific language governing permissions and |
| 14 | # limitations under the License. |
| 15 | # |
| 16 | |
| 17 | header: |
| 18 | summary: Standard RenderScript types |
| 19 | description: |
| 20 | Integers:<ul> |
| 21 | <li>8 bit: char, int8_t</li> |
| 22 | <li>16 bit: short, int16_t</li> |
| 23 | <li>32 bit: int, in32_t</li> |
| 24 | <li>64 bit: long, long long, int64_t</li></ul> |
| 25 | |
| 26 | Unsigned integers:<ul> |
| 27 | <li>8 bit: uchar, uint8_t</li> |
| 28 | <li>16 bit: ushort, uint16_t</li> |
| 29 | <li>32 bit: uint, uint32_t</li> |
| 30 | <li>64 bit: ulong, uint64_t</li></ul> |
| 31 | |
| 32 | Floating point:<ul> |
| 33 | <li>32 bit: float</li> |
| 34 | <li>64 bit: double</li></ul> |
| 35 | |
| 36 | Vectors of length 2, 3, and 4 are supported for all the types above. |
| 37 | end: |
| 38 | |
| 39 | type: int8_t |
| 40 | simple: char |
| 41 | summary: 8 bit signed integer |
| 42 | description: |
| 43 | 8 bit integer type |
| 44 | end: |
| 45 | |
| 46 | type: int16_t |
| 47 | simple: short |
| 48 | summary: 16 bit signed integer |
| 49 | description: |
| 50 | 16 bit integer type |
| 51 | end: |
| 52 | |
| 53 | type: int32_t |
| 54 | simple: int |
| 55 | summary: 32 bit signed integer |
| 56 | description: |
| 57 | 32 bit integer type |
| 58 | end: |
| 59 | |
| 60 | type: int64_t |
| 61 | version: 9 20 |
| 62 | simple: long long |
| 63 | summary: 64 bit signed integer |
| 64 | description: |
| 65 | 64 bit integer type |
| 66 | end: |
| 67 | |
| 68 | type: int64_t |
| 69 | version: 21 |
| 70 | simple: long |
| 71 | end: |
| 72 | |
| 73 | type: uint8_t |
| 74 | simple: unsigned char |
| 75 | summary: 8 bit unsigned integer |
| 76 | description: |
| 77 | 8 bit unsigned integer type |
| 78 | end: |
| 79 | |
| 80 | type: uint16_t |
| 81 | simple: unsigned short |
| 82 | summary: 16 bit unsigned integer |
| 83 | description: |
| 84 | 16 bit unsigned integer type |
| 85 | end: |
| 86 | |
| 87 | type: uint32_t |
| 88 | simple: unsigned int |
| 89 | summary: 32 bit unsigned integer |
| 90 | description: |
| 91 | 32 bit unsigned integer type |
| 92 | end: |
| 93 | |
| 94 | type: uint64_t |
| 95 | version: 9 20 |
| 96 | simple: unsigned long long |
| 97 | summary: 64 bit unsigned integer |
| 98 | description: |
| 99 | 64 bit unsigned integer type |
| 100 | end: |
| 101 | |
| 102 | type: uint64_t |
| 103 | version: 21 |
| 104 | simple: unsigned long |
| 105 | end: |
| 106 | |
| 107 | type: uchar |
| 108 | simple: uint8_t |
| 109 | summary: 8 bit unsigned integer |
| 110 | description: |
| 111 | 8 bit unsigned integer type |
| 112 | end: |
| 113 | |
| 114 | type: ushort |
| 115 | simple: uint16_t |
| 116 | summary: 16 bit unsigned integer |
| 117 | description: |
| 118 | 16 bit unsigned integer type |
| 119 | end: |
| 120 | |
| 121 | type: uint |
| 122 | simple: uint32_t |
| 123 | summary: 32 bit unsigned integer |
| 124 | description: |
| 125 | 32 bit unsigned integer type |
| 126 | end: |
| 127 | |
| 128 | type: ulong |
| 129 | simple: uint64_t |
| 130 | summary: 64 bit unsigned integer |
| 131 | description: |
| 132 | Typedef for unsigned long (use for 64-bit unsigned integers) |
| 133 | end: |
| 134 | |
| 135 | type: size_t |
| 136 | size: 64 |
| 137 | simple: uint64_t |
| 138 | summary: Unsigned size type |
| 139 | description: |
| 140 | Typedef for size_t |
| 141 | end: |
| 142 | |
| 143 | type: size_t |
| 144 | size: 32 |
| 145 | simple: uint32_t |
| 146 | end: |
| 147 | |
| 148 | type: ssize_t |
| 149 | size: 64 |
| 150 | simple: int64_t |
| 151 | summary: Signed size type |
| 152 | description: |
| 153 | Typedef for ssize_t |
| 154 | end: |
| 155 | |
| 156 | type: ssize_t |
| 157 | size: 32 |
| 158 | simple: int32_t |
| 159 | end: |
| 160 | |
| 161 | type: float2 |
| 162 | simple: float __attribute__((ext_vector_type(2))) |
| 163 | summary: Two 32 bit floats |
| 164 | description: |
| 165 | Vector version of the basic float type. |
| 166 | Provides two float fields packed into a single 64 bit field with 64 bit alignment. |
| 167 | end: |
| 168 | |
| 169 | type: float3 |
| 170 | simple: float __attribute__((ext_vector_type(3))) |
| 171 | summary: Three 32 bit floats |
| 172 | description: |
| 173 | Vector version of the basic float type. |
| 174 | Provides three float fields packed into a single 128 bit field with 128 bit alignment. |
| 175 | end: |
| 176 | |
| 177 | type: float4 |
| 178 | simple: float __attribute__((ext_vector_type(4))) |
| 179 | summary: Four 32 bit floats |
| 180 | description: |
| 181 | Vector version of the basic float type. |
| 182 | Provides four float fields packed into a single 128 bit field with 128 bit alignment. |
| 183 | end: |
| 184 | |
| 185 | |
| 186 | type: double2 |
| 187 | simple: double __attribute__((ext_vector_type(2))) |
| 188 | summary: Two 64 bit floats |
| 189 | description: |
| 190 | Vector version of the basic double type. Provides two double fields packed |
| 191 | into a single 128 bit field with 128 bit alignment. |
| 192 | end: |
| 193 | |
| 194 | type: double3 |
| 195 | simple: double __attribute__((ext_vector_type(3))) |
| 196 | summary: Three 64 bit floats |
| 197 | description: |
| 198 | Vector version of the basic double type. Provides three double fields packed |
| 199 | into a single 256 bit field with 256 bit alignment. |
| 200 | end: |
| 201 | |
| 202 | type: double4 |
| 203 | simple: double __attribute__((ext_vector_type(4))) |
| 204 | summary: Four 64 bit floats |
| 205 | description: |
| 206 | Vector version of the basic double type. Provides four double fields packed |
| 207 | into a single 256 bit field with 256 bit alignment. |
| 208 | end: |
| 209 | |
| 210 | |
| 211 | type: uchar2 |
| 212 | simple: uchar __attribute__((ext_vector_type(2))) |
| 213 | summary: Two 8 bit unsigned integers |
| 214 | description: |
| 215 | Vector version of the basic uchar type. Provides two uchar fields packed |
| 216 | into a single 16 bit field with 16 bit alignment. |
| 217 | end: |
| 218 | |
| 219 | type: uchar3 |
| 220 | simple: uchar __attribute__((ext_vector_type(3))) |
| 221 | summary: Three 8 bit unsigned integers |
| 222 | description: |
| 223 | Vector version of the basic uchar type. Provides three uchar fields packed |
| 224 | into a single 32 bit field with 32 bit alignment. |
| 225 | end: |
| 226 | |
| 227 | type: uchar4 |
| 228 | simple: uchar __attribute__((ext_vector_type(4))) |
| 229 | summary: Four 8 bit unsigned integers |
| 230 | description: |
| 231 | Vector version of the basic uchar type. Provides four uchar fields packed |
| 232 | into a single 32 bit field with 32 bit alignment. |
| 233 | end: |
| 234 | |
| 235 | |
| 236 | type: ushort2 |
| 237 | simple: ushort __attribute__((ext_vector_type(2))) |
| 238 | summary: Two 16 bit unsigned integers |
| 239 | description: |
| 240 | Vector version of the basic ushort type. Provides two ushort fields packed |
| 241 | into a single 32 bit field with 32 bit alignment. |
| 242 | end: |
| 243 | |
| 244 | type: ushort3 |
| 245 | simple: ushort __attribute__((ext_vector_type(3))) |
| 246 | summary: Three 16 bit unsigned integers |
| 247 | description: |
| 248 | Vector version of the basic ushort type. Provides three ushort fields packed |
| 249 | into a single 64 bit field with 64 bit alignment. |
| 250 | end: |
| 251 | |
| 252 | type: ushort4 |
| 253 | simple: ushort __attribute__((ext_vector_type(4))) |
| 254 | summary: Four 16 bit unsigned integers |
| 255 | description: |
| 256 | Vector version of the basic ushort type. Provides four ushort fields packed |
| 257 | into a single 64 bit field with 64 bit alignment. |
| 258 | end: |
| 259 | |
| 260 | |
| 261 | type: uint2 |
| 262 | simple: uint __attribute__((ext_vector_type(2))) |
| 263 | summary: Two 32 bit unsigned integers |
| 264 | description: |
| 265 | Vector version of the basic uint type. Provides two uint fields packed into a |
| 266 | single 64 bit field with 64 bit alignment. |
| 267 | end: |
| 268 | |
| 269 | type: uint3 |
| 270 | simple: uint __attribute__((ext_vector_type(3))) |
| 271 | summary: Three 32 bit unsigned integers |
| 272 | description: |
| 273 | Vector version of the basic uint type. Provides three uint fields packed into |
| 274 | a single 128 bit field with 128 bit alignment. |
| 275 | end: |
| 276 | |
| 277 | type: uint4 |
| 278 | simple: uint __attribute__((ext_vector_type(4))) |
| 279 | summary: Four 32 bit unsigned integers |
| 280 | description: |
| 281 | Vector version of the basic uint type. Provides four uint fields packed into |
| 282 | a single 128 bit field with 128 bit alignment. |
| 283 | end: |
| 284 | |
| 285 | |
| 286 | type: ulong2 |
| 287 | simple: ulong __attribute__((ext_vector_type(2))) |
| 288 | summary: Two 64 bit unsigned integers |
| 289 | description: |
| 290 | Vector version of the basic ulong type. Provides two ulong fields packed into |
| 291 | a single 128 bit field with 128 bit alignment. |
| 292 | end: |
| 293 | |
| 294 | type: ulong3 |
| 295 | simple: ulong __attribute__((ext_vector_type(3))) |
| 296 | summary: Three 64 bit unsigned integers |
| 297 | description: |
| 298 | Vector version of the basic ulong type. Provides three ulong fields packed |
| 299 | into a single 256 bit field with 256 bit alignment. |
| 300 | end: |
| 301 | |
| 302 | type: ulong4 |
| 303 | simple: ulong __attribute__((ext_vector_type(4))) |
| 304 | summary: Four 64 bit unsigned integers |
| 305 | description: |
| 306 | Vector version of the basic ulong type. Provides four ulong fields packed |
| 307 | into a single 256 bit field with 256 bit alignment. |
| 308 | end: |
| 309 | |
| 310 | |
| 311 | type: char2 |
| 312 | simple: char __attribute__((ext_vector_type(2))) |
| 313 | summary: Two 8 bit signed integers |
| 314 | description: |
| 315 | Vector version of the basic char type. Provides two char fields packed into a |
| 316 | single 16 bit field with 16 bit alignment. |
| 317 | end: |
| 318 | |
| 319 | type: char3 |
| 320 | simple: char __attribute__((ext_vector_type(3))) |
| 321 | summary: Three 8 bit signed integers |
| 322 | description: |
| 323 | Vector version of the basic char type. Provides three char fields packed into |
| 324 | a single 32 bit field with 32 bit alignment. |
| 325 | end: |
| 326 | |
| 327 | type: char4 |
| 328 | simple: char __attribute__((ext_vector_type(4))) |
| 329 | summary: Four 8 bit signed integers |
| 330 | description: |
| 331 | Vector version of the basic char type. Provides four char fields packed into |
| 332 | a single 32 bit field with 32 bit alignment. |
| 333 | end: |
| 334 | |
| 335 | type: short2 |
| 336 | simple: short __attribute__((ext_vector_type(2))) |
| 337 | summary: Two 16 bit signed integers |
| 338 | description: |
| 339 | Vector version of the basic short type. Provides two short fields packed into |
| 340 | a single 32 bit field with 32 bit alignment. |
| 341 | end: |
| 342 | |
| 343 | type: short3 |
| 344 | simple: short __attribute__((ext_vector_type(3))) |
| 345 | summary: Three 16 bit signed integers |
| 346 | description: |
| 347 | Vector version of the basic short type. Provides three short fields packed |
| 348 | into a single 64 bit field with 64 bit alignment. |
| 349 | end: |
| 350 | |
| 351 | type: short4 |
| 352 | simple: short __attribute__((ext_vector_type(4))) |
| 353 | summary: Four 16 bit signed integers |
| 354 | description: |
| 355 | Vector version of the basic short type. Provides four short fields packed |
| 356 | into a single 64 bit field with 64 bit alignment. |
| 357 | end: |
| 358 | |
| 359 | |
| 360 | type: int2 |
| 361 | simple: int __attribute__((ext_vector_type(2))) |
| 362 | summary: Two 32 bit signed integers |
| 363 | description: |
| 364 | Vector version of the basic int type. Provides two int fields packed into a |
| 365 | single 64 bit field with 64 bit alignment. |
| 366 | end: |
| 367 | |
| 368 | type: int3 |
| 369 | simple: int __attribute__((ext_vector_type(3))) |
| 370 | summary: Three 32 bit signed integers |
| 371 | description: |
| 372 | Vector version of the basic int type. Provides three int fields packed into a |
| 373 | single 128 bit field with 128 bit alignment. |
| 374 | end: |
| 375 | |
| 376 | type: int4 |
| 377 | simple: int __attribute__((ext_vector_type(4))) |
| 378 | summary: Four 32 bit signed integers |
| 379 | description: |
| 380 | Vector version of the basic int type. Provides two four fields packed into a |
| 381 | single 128 bit field with 128 bit alignment. |
| 382 | end: |
| 383 | |
| 384 | |
| 385 | type: long2 |
| 386 | simple: long __attribute__((ext_vector_type(2))) |
| 387 | summary: Two 64 bit signed integers |
| 388 | description: |
| 389 | Vector version of the basic long type. Provides two long fields packed into a |
| 390 | single 128 bit field with 128 bit alignment. |
| 391 | end: |
| 392 | |
| 393 | type: long3 |
| 394 | simple: long __attribute__((ext_vector_type(3))) |
| 395 | summary: Three 64 bit signed integers |
| 396 | description: |
| 397 | Vector version of the basic long type. Provides three long fields packed into |
| 398 | a single 256 bit field with 256 bit alignment. |
| 399 | end: |
| 400 | |
| 401 | type: long4 |
| 402 | simple: long __attribute__((ext_vector_type(4))) |
| 403 | summary: Four 64 bit signed integers |
| 404 | description: |
| 405 | Vector version of the basic long type. Provides four long fields packed into |
| 406 | a single 256 bit field with 256 bit alignment. |
| 407 | end: |