'\" t
.\"     Title: vload_halfn
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 02/03/2019
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "VLOAD_HALFN" "3clc" "02/03/2019" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
vload_halfn \- Read a half float vector from a pointer to memory\&.
.SH ""
.HP \w'floatn\ vload_half\fIn\fR('u
.BI "floatn vload_half\fIn\fR(size_t\ " "offset" ", const\ __global\ half\ *" "p" ");"
.HP \w'floatn\ vload_half\fIn\fR('u
.BI "floatn vload_half\fIn\fR(size_t\ " "offset" ", const\ __local\ half\ *" "p" ");"
.HP \w'floatn\ vload_half\fIn\fR('u
.BI "floatn vload_half\fIn\fR(size_t\ " "offset" ", const\ __constant\ half\ *" "p" ");"
.HP \w'floatn\ vload_half\fIn\fR('u
.BI "floatn vload_half\fIn\fR(size_t\ " "offset" ", const\ __private\ half\ *" "p" ");"
.SH "DESCRIPTION"
.PP
Read sizeof(\fBhalf\fR\fB\fIn\fR\fR) bytes of data from address (\fIp\fR
+ (\fIoffset\fR
*
\fIn\fR))\&. The data read is interpreted as a
\fBhalf\fR\fB\fIn\fR\fR
value\&.
.PP
The
\fBhalf\fR\fB\fIn\fR\fR
value read is converted to a
\fBfloat\fR\fB\fIn\fR\fR
value and the
\fBfloat\fR\fB\fIn\fR\fR
value is returned\&. The read address computed as (\fIp\fR
+ (\fIoffset\fR
*
\fIn\fR)) must be 16\-bit aligned\&.
.SH "NOTES"
.PP
Vector Data Load and Store Functions allow you to read and write vector types from a pointer to memory\&.
.PP
The generic type
\fBgentype\fR
is used to indicate the built\-in data types
\fBchar\fR,
\fBuchar\fR,
\fBshort\fR,
\fBushort\fR,
\fBint\fR,
\fBuint\fR,
\fBlong\fR,
\fBulong\fR,
\fBfloat\fR, or
\fBdouble\fR\&.
.PP
The generic type name
\fBgentype\fR\fB\fIn\fR\fR
represents
\fIn\fR\-element vectors of
\fBgentype\fR
elements\&. The suffix
\fIn\fR
is also used in the function names (i\&.e\&.
\fBvload\fR\fB\fIn\fR\fR,
\fBvstore\fR\fB\fIn\fR\fR, etc\&.), where
\fIn\fR
= 2, 3, 4, 8, or 16\&.
.PP
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
\fIp\fR
can be a pointer to
\fBglobal\fR(3clc),
\fBlocal\fR(3clc), or
\fBprivate\fR(3clc)
memory for store functions\&. The pointer argument
\fIp\fR
can be a pointer to __global, __local,
\fBconstant\fR(3clc)
or __private memory for load functions\&.
.PP
When extended by the
\fBcl_khr_fp16\fR(3clc)
extension, the generic type
\fBgentype\fR\fB\fIn\fR\fR
is extended to include
\fBhalf\fR,
\fBhalf2\fR,
\fBhalf3\fR,
\fBhalf4\fR,
\fBhalf8\fR, and
\fBhalf16\fR\&.
.PP
\fBvload3\fR
and
\fBvload_half3\fR
read
\fIx\fR,
\fIy\fR,
\fIz\fR
components from address (\fIp\fR
+ (\fIoffset\fR
* 3)) into a 3\-component vector\&.
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBvectorDataLoadandStoreFunctions\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
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.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 267, section 6.12.7 - Vector Data Load and Store Functions
.RE