vloada_halfn

Read half float vector from a pointer to memory.

floatn vloada_halfn ( size_t offset,
  const __global half *p)
floatn vloada_halfn ( size_t offset,
  const __local half *p)
floatn vloada_halfn ( size_t offset,
  const __constant half *p)
floatn vloada_halfn ( size_t offset,
  const __private half *p)

Description

For n = 1, 2, 4, 8 and 16 read sizeof(halfn) bytes of data from address (p + (offset * n)). The data read is interpreted as a halfn value. The halfn value read is converted to a floatn value and the floatn value is returned.

The address computed as (p + (offset * n)) must be aligned to sizeof(halfn) bytes.

For n = 3, vloada_half3 reads a half3 from address (p + (offset * 4)) and returns a float3. The address computed as (p + (offset * 4)) must be aligned to sizeof (half) * 4 bytes.

Notes

Vector Data Load and Store Functions allow you to read and write vector types from a pointer to memory.

The generic type gentype is used to indicate the built-in data types char, uchar, short, ushort, int, uint, long, ulong, float, or double.

The generic type name gentypen represents n-element vectors of gentype elements. The suffix n is also used in the function names (i.e. vloadn, vstoren, etc.), where n = 2, 3, 4, 8, or 16.

The results of vector data load and store functions are undefined if the address being read from or written to is not correctly aligned. The pointer argument p can be a pointer to __global, __local, or __private memory for store functions. The pointer argument p can be a pointer to __global, __local, __constant or __private memory for load functions.

In addition vloada_half3 reads x, y, z components from address (p + (offset * 4)) into a 3- component vector.

Specification

OpenCL Specification

Also see

Vector Data Load and Store Functions

Copyright © 2007-2011 The Khronos Group Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.