| <?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" |
| "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd" [ |
| <!ENTITY vectorFunctionsInc SYSTEM "vectorFunctionsInc.xml"> |
| ]> |
| |
| <refentry> |
| <refentryinfo> |
| <keywordset> |
| <keyword>vloada_halfn</keyword> |
| </keywordset> |
| </refentryinfo> |
| |
| <refmeta> |
| <refentrytitle>vloada_halfn</refentrytitle> |
| |
| <refmiscinfo> |
| <copyright> |
| <year>2007-2013</year> |
| <holder>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.</holder> |
| </copyright> |
| </refmiscinfo> |
| <manvolnum>3</manvolnum> |
| </refmeta> |
| |
| <!-- ================================ SYNOPSIS --> |
| |
| <refnamediv id="vloada_halfn"> |
| <refname>vloada_half<replaceable>n</replaceable></refname> |
| |
| <refpurpose> |
| Read half float vector from a pointer to memory. |
| </refpurpose> |
| </refnamediv> |
| |
| |
| <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title> |
| <funcsynopsis> |
| <funcprototype> |
| <funcdef> |
| <link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link> |
| <function> |
| vloada_half<replaceable>n</replaceable> |
| </function> |
| </funcdef> |
| <paramdef><link xlink:href="scalarDataTypes.html">size_t</link><parameter>offset</parameter></paramdef> |
| <paramdef>const <link xlink:href="scalarDataTypes.html">half</link><parameter>*p</parameter></paramdef> |
| </funcprototype> |
| </funcsynopsis> |
| |
| <funcsynopsis> |
| <funcprototype> |
| <funcdef> |
| <link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link> |
| <function> |
| vloada_half<replaceable>n</replaceable> |
| </function> |
| </funcdef> |
| <paramdef><link xlink:href="scalarDataTypes.html">size_t</link><parameter>offset</parameter></paramdef> |
| <paramdef>const constant <link xlink:href="scalarDataTypes.html">half</link><parameter>*p</parameter></paramdef> |
| </funcprototype> |
| </funcsynopsis> |
| |
| </refsynopsisdiv> |
| |
| <!-- ================================ DESCRIPTION --> |
| |
| <refsect1 id="description"><title>Description</title> |
| <para> |
| For n = 1, 2, 4, 8 and 16 read sizeof(<type>half<replaceable>n</replaceable></type>) bytes |
| of data from address (<varname>p</varname> + (<varname>offset</varname> |
| * <varname>n</varname>)). The data read is interpreted as |
| a <type>half<replaceable>n</replaceable></type> value. The |
| <type>half<replaceable>n</replaceable></type> value read is converted |
| to a <type>float<replaceable>n</replaceable></type> value and the |
| <type>float<replaceable>n</replaceable></type> value is returned. |
| </para> |
| |
| <para> |
| The address computed as (<varname>p</varname> + |
| (<varname>offset</varname> * <varname>n</varname>)) must be aligned to |
| sizeof(<type>half<replaceable>n</replaceable></type>) bytes. |
| </para> |
| |
| <para> |
| For <replaceable>n</replaceable> = 3, <function>vloada_half3</function> reads a |
| <type>half3</type> from address (<varname>p</varname> + (<varname>offset</varname> * |
| 4)) and returns a <type>float3</type>. The address computed as (<varname>p</varname> + |
| (<varname>offset</varname> * 4)) must be aligned to sizeof (<type>half</type>) * 4 bytes. |
| </para> |
| |
| </refsect1> |
| |
| <!-- ================================ NOTES --> |
| <refsect1 id="notes"><title>Notes</title> |
| |
| &vectorFunctionsInc; |
| |
| <para><!-- OpenCL C spec. p. 95, section 6.13.7, footnote 37 --> |
| In addition <function>vloada_half3</function> reads <varname>x</varname>, |
| <varname>y</varname>, <varname>z</varname> components from address |
| (<varname>p</varname> + (<varname>offset</varname> * 4)) into a 3- component vector. |
| </para> |
| </refsect1> |
| |
| <!-- ================================ EXAMPLE --> <!-- DO NOT DELETE IN CASE AN EXAMPLE IS |
| ADDED IN THE FUTURE --> <!-- |
| <refsect2 id="example1"> |
| <title> |
| Example |
| </title> |
| |
| <informaltable frame="none"> |
| <tgroup cols="1" align="left" colsep="0" rowsep="0"> |
| <colspec colname="col1" colnum="1" /> |
| <tbody> |
| <row> |
| <entry> |
| Example goes here - it will be set in "code" type with white space preserved. |
| </entry> |
| </row> |
| </tbody> |
| </tgroup> |
| </informaltable> |
| </refsect2> |
| --> |
| |
| <!-- ================================ SPECIFICATION --> |
| <!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page |
| --> |
| <refsect1 id="specification"><title>Specification</title> |
| <para> |
| <imageobject> |
| <imagedata fileref="pdficon_small1.gif" format="gif" /> |
| </imageobject> |
| |
| <olink uri="vectorDataLoadandStoreFunctions">OpenCL Specification</olink> |
| </para> |
| </refsect1> |
| |
| <!-- ================================ ALSO SEE --> |
| |
| <refsect1 id="seealso"><title>Also see</title> |
| <para> |
| <citerefentry href="vectorDataLoadandStoreFunctions"><refentrytitle>Vector Data Load and Store Functions</refentrytitle></citerefentry> |
| </para> |
| </refsect1> |
| |
| <!-- ============================== COPYRIGHT --> |
| <!-- Content included from copyright.inc.xsl --> |
| |
| <refsect3 id="Copyright"><title></title> |
| <imageobject> |
| <imagedata fileref="KhronosLogo.jpg" format="jpg" /> |
| </imageobject> |
| <para /> |
| </refsect3> |
| |
| <!-- 14-Dec-2013, rev. 19 --> |
| </refentry> |
| |