vloadn(3clc)

vloadn3clc

Read vectors from a pointer to memory.

gentypen vloadn(size_t offset, const __global gentype *p);

gentypen vloadn(size_t offset, const __local gentype *p);

gentypen vloadn(size_t offset, const __constant gentype *p);

gentypen vloadn(size_t offset, const __private gentype *p);

Overview

Return sizeof (gentypen) bytes of data read from address (p + (offset * n)).

The address computed as (p + (offset * n)) must be 8-bit aligned if gentype is char or uchar; 16-bit aligned if gentype is short or ushort; 32-bit aligned if gentype is int, uint, or float; 64-bit aligned if gentype is long or ulong.

If the half extension is enabled, the address computed as (p + (offset * n)) must be 16-bit aligned.

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(3clc), local(3clc), or private(3clc) memory for store functions. The pointer argument p can be a pointer to __global, __local, constant(3clc) or __private memory for load functions.

When extended by the cl_khr_fp16(3clc) extension, the generic type gentypen is extended to include half, half2, half3, half4, half8, and half16.

vload3 and vload_half3 read x, y, z components from address (p + (offset * 3)) into a 3-component vector.

Specification

OpenCL Specification[1]

Notes

1.

OpenCL Specification

page 267, section 6.12.7 - Vector Data Load and Store Functions

Releases

5 releases since Debian 8 (Jessie); the text changed 3 times.

  1. 8–9
  2. 10
  3. 11
  4. 13

Authors

The Khronos Group

From opencl-1.2-man-doc 1.0~svn33624-5.1 in Debian 13 (Trixie). Parsed by carta from the page's man source.