| <?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
| <!-- saved from url=(0013)about:internet --> | |
| <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | |
| <style xmlns="" type="text/css"> | |
| /* This style sets a margin around the entire page */ | |
| html, body { | |
| margin: 10px; | |
| } | |
| p { | |
| font: normal 16px verdana, sans-serif; | |
| margin: 0; | |
| padding-bottom:12px; | |
| } | |
| h1 { | |
| font: bold 25px verdana, sans-serif; | |
| margin-top: 0; | |
| margin-bottom: 3px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| h2 { | |
| font: bold 19px verdana, sans-serif; | |
| margin-top: 28px; | |
| margin-bottom: 3px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| h3 { | |
| font: bold 19px verdana, sans-serif !important; | |
| margin-top: 28px; | |
| margin-bottom: 3px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| li { | |
| font: normal 16px verdana, sans-serif; | |
| margin-top: 0; | |
| margin-bottom: 18px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| .pdparam { | |
| font: italic 16px verdana, sans-serif; | |
| } | |
| .term { | |
| font: italic 16px verdana, sans-serif; | |
| font-weight: normal; | |
| } | |
| .type { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| .parameter { | |
| font-style: italic; | |
| } | |
| a:link, a:visited { | |
| color: blue; | |
| text-decoration: none; | |
| font: normal 16px; | |
| } | |
| a:hover { | |
| background-color: #FFFF99; | |
| font: normal 16px; | |
| } | |
| div.funcsynopsis { | |
| text-align: left; | |
| background-color: #e6e6e6; | |
| font: normal 16px verdana, sans-serif; | |
| padding-top: 10px; | |
| padding-bottom: 10px; | |
| } | |
| div.funcsynopsis table { | |
| border-collapse: separate; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.funcsynopsis td { | |
| background-color: #e6e6e6; | |
| border: 0 solid #000; | |
| padding: 1px; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.refsect1 { | |
| font-family: verdana, sans-serif; | |
| font-size: 16px; | |
| } | |
| code.constant { | |
| font: normal 16px courier new, monospace !important; | |
| } | |
| span.errorname { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| code.function { | |
| font: bold 16px verdana, sans-serif !important; | |
| } | |
| b.fsfunc { | |
| font: bold 16px verdana, sans-serif !important; | |
| } | |
| code.varname { | |
| font: italic 16px verdana, sans-serif; | |
| } | |
| code.replaceable { | |
| font: italic 16px courier new, monospace; | |
| } | |
| code.funcdef { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| .citerefentry { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| .parameter { | |
| font-style: italic; | |
| } | |
| code.fsfunc { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| /* PARAMETER: This style controls spacing between the terms in Parameter section */ | |
| dt { | |
| margin-top: 15px; | |
| } | |
| /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ | |
| div.refsect1 table { | |
| width: 100%; | |
| margin-top: 10px; | |
| background-color: #FFF; | |
| border-collapse: collapse; | |
| border-color: #000; | |
| border-width: 1px; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.refsect1 th { | |
| border-collapse: collapse; | |
| border-color: #000; | |
| border-width: 1px; | |
| font: bold 16px verdana, sans-serif; | |
| } | |
| div.refsect1 td { | |
| background-color: #FFF; | |
| padding: 5px; | |
| vertical-align: text-top; | |
| border-collapse: collapse; | |
| border-color: #000; | |
| border-width: 1px; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.refsect1 p{ | |
| font: normal 16px verdana, sans-serif; | |
| margin-top: 8px; | |
| margin-bottom: 8px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| /* EXAMPLE: These styles apply only to the Example section */ | |
| div.refsect2 { | |
| font: normal 16px courier new, monospace !important; | |
| } | |
| div.refsect2 table { | |
| margin-top: 0; | |
| background-color: #e6e6e6; | |
| width: 100%; | |
| border: 0 solid #000; | |
| padding: 2px; | |
| font: normal 16px courier new, monospace !important; | |
| } | |
| div.refsect2 td { | |
| background-color: #e6e6e6; | |
| font: normal 16px courier new, monospace !important; | |
| white-space:pre; | |
| } | |
| /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ | |
| div.refsect3 { | |
| font: normal 11px verdana, sans-serif; | |
| margin-top: 50px; | |
| margin-bottom: 20px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| </style> | |
| <title>clCreatePipe</title> | |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> | |
| <meta name="keywords" content="clCreatePipe" /> | |
| </head> | |
| <body> | |
| <div class="refentry"> | |
| <a id="id-1"></a> | |
| <div class="titlepage"></div> | |
| <div xmlns="" class="refnamediv"> | |
| <a xmlns="http://www.w3.org/1999/xhtml" id="clCreatePipe"></a> | |
| <h1> | |
| clCreatePipe | |
| </h1> | |
| <p> | |
| Creates a pipe object. | |
| </p> | |
| </div> | |
| <div class="refsynopsisdiv"> | |
| <h2></h2> | |
| <div class="funcsynopsis"> | |
| <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> | |
| <tr valign="bottom"> | |
| <td> | |
| <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef"> | |
| <a class="link" href="abstractDataTypes.html" target="pagedisplay">cl_mem</a> <strong class="fsfunc">clCreatePipe</strong> | |
| (</code> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_context</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var>, </td> | |
| </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_mem_flags" target="pagedisplay">cl_mem_flags</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">flags</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">pipe_packet_size</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">pipe_max_packets</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>const cl_pipe_properties <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">* properties</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*errcode_ret</var><code>)</code></td> | |
| </tr> | |
| </table> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="parameters"></a> | |
| <h2>Parameters</h2> | |
| <div class="variablelist"> | |
| <dl class="variablelist"> | |
| <dt> | |
| <span class="term"> <code class="varname"> context </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A valid OpenCL context used to create the pipe object. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> flags </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A bit-field that is used to specify | |
| allocation and usage information such as the memory | |
| arena that should be used to allocate the pipe object and how it | |
| will be used. The table below describes | |
| the possible values for <code class="varname">flags</code>. | |
| Only <code class="constant">CL_MEM_READ_ONLY</code>, | |
| <code class="constant">CL_MEM_WRITE_ONLY</code>, <code class="constant">CL_MEM_READ_WRITE</code>, | |
| and <code class="constant">CL_MEM_HOST_NO_ACCESS</code> | |
| can be specified when creating a pipe object. | |
| If value specified for <code class="varname">flags</code> is 0, | |
| the default is used which is | |
| <code class="constant">CL_MEM_READ_WRITE</code> | |
| | <code class="constant">CL_MEM_HOST_NO_ACCESS</code>. | |
| </p> | |
| <div class="informaltable"> | |
| <table class="informaltable" border="1"> | |
| <colgroup> | |
| <col align="left" class="col1" /> | |
| <col /> | |
| </colgroup> | |
| <thead> | |
| <tr> | |
| <th align="left">cl_mem_flags</th> | |
| <th align="left">Description</th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_READ_WRITE</code> | |
| </td> | |
| <td align="left"> | |
| This flag specifies that the memory object will be read and written by a kernel. This | |
| is the default. | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_WRITE_ONLY</code> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| This flag specifies that the memory object will be written but not read by | |
| a kernel. | |
| </p> | |
| <p> | |
| Reading from a buffer or image object created with | |
| <code class="constant">CL_MEM_WRITE_ONLY</code> inside a kernel is undefined. | |
| </p> | |
| <p> | |
| <code class="constant">CL_MEM_READ_WRITE</code> and <code class="constant">CL_MEM_WRITE_ONLY</code> | |
| are mutually exclusive. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_READ_ONLY</code> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| This flag specifies that the memory object is a read-only memory object when | |
| used inside a kernel. | |
| </p> | |
| <p> | |
| Writing to a buffer or image object created with | |
| <code class="constant">CL_MEM_READ_ONLY</code> inside a kernel is undefined. | |
| </p> | |
| <p> | |
| <code class="constant">CL_MEM_READ_WRITE</code> or <code class="constant">CL_MEM_WRITE_ONLY</code> | |
| and <code class="constant">CL_MEM_READ_ONLY</code> are mutually exclusive. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_USE_HOST_PTR</code> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| This flag is valid only if <code class="varname">host_ptr</code> is not NULL. If | |
| specified, it indicates that the application wants the OpenCL implementation | |
| to use memory referenced by <code class="varname">host_ptr</code> as the storage bits | |
| for the memory object. | |
| </p> | |
| <p> | |
| OpenCL implementations are allowed to cache the buffer contents pointed to by | |
| <code class="varname">host_ptr</code> in device memory. This cached copy can be used when | |
| kernels are executed on a device. | |
| </p> | |
| <p> | |
| The result of OpenCL commands that operate on multiple buffer objects created with | |
| the same <code class="varname">host_ptr</code> or overlapping host regions is considered | |
| to be undefined. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_ALLOC_HOST_PTR</code> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| This flag specifies that the application wants the OpenCL implementation to | |
| allocate memory from host accessible memory. | |
| </p> | |
| <p> | |
| <code class="constant">CL_MEM_ALLOC_HOST_PTR</code> and | |
| <code class="constant">CL_MEM_USE_HOST_PTR</code> are mutually exclusive. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_COPY_HOST_PTR</code> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| This flag is valid only if <code class="varname">host_ptr</code> is not NULL. If specified, | |
| it indicates that the application wants the OpenCL implementation to allocate | |
| memory for the memory object and copy the data from memory referenced by | |
| <code class="varname">host_ptr</code>. | |
| </p> | |
| <p> | |
| <code class="constant">CL_MEM_COPY_HOST_PTR</code> and | |
| <code class="constant">CL_MEM_USE_HOST_PTR</code> are mutually exclusive. | |
| </p> | |
| <p> | |
| <code class="constant">CL_MEM_COPY_HOST_PTR</code> can be used with | |
| <code class="constant">CL_MEM_ALLOC_HOST_PTR</code> to initialize the contents of the | |
| <span class="type">cl_mem</span> object allocated using host-accessible (e.g. PCIe) memory. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_HOST_WRITE_ONLY</code> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| This flag specifies that the host will only write to the memory object (using | |
| OpenCL APIs that enqueue a write or a map for write). This can be used to optimize | |
| write access from the host (e.g. enable write-combined allocations for memory | |
| objects for devices that communicate with the host over a system bus such as PCIe). | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_HOST_READ_ONLY</code> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| This flag specifies that the host will only read the memory object (using OpenCL | |
| APIs that enqueue a read or a map for read). | |
| </p> | |
| <p> | |
| <code class="constant">CL_MEM_HOST_WRITE_ONLY</code> and | |
| <code class="constant">CL_MEM_HOST_READ_ONLY</code> are mutually exclusive. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_HOST_NO_ACCESS</code> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| This flag specifies that the host will not read or write the memory object. | |
| </p> | |
| <p> | |
| <code class="constant">CL_MEM_HOST_WRITE_ONLY</code> or | |
| <code class="constant">CL_MEM_HOST_READ_ONLY</code> and | |
| <code class="constant">CL_MEM_HOST_NO_ACCESS</code> are mutually exclusive. | |
| </p> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </div> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> pipe_packet_size </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Size in bytes of a pipe packet. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname">pipe_max_packets</code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the pipe capacity by specifying the | |
| maximum number of packets the pipe can hold. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname">properties</code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A list of properties for the pipe and their corresponding values. Each property | |
| name is immediately followed by the corresponding desired value. | |
| The list is terminated with 0. | |
| In OpenCL 2.0, <code class="varname">properties</code> must be NULL. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname">errcode_ret</code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Will return an appropriate error code. If <code class="varname">errcode_ret</code> | |
| is NULL, no error code is returned. | |
| </p> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="description"></a> | |
| <h2>Notes</h2> | |
| <p> | |
| Pipes follow the same memory consistency model as | |
| defined for buffer and image objects. The | |
| pipe state i.e. contents of the pipe across kernel | |
| executions (on the same or different devices) is | |
| enforced at a synchronization point. | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="errors"></a> | |
| <h2>Errors</h2> | |
| <p> | |
| <code class="function">clCreatePipe</code> returns a valid non-zero pipe object and | |
| <code class="varname">errcode_ret</code> is set to <span class="errorname">CL_SUCCESS</span> if the | |
| pipe object is created successfully. Otherwise, it returns a NULL value with one of | |
| the following error values returned in <code class="varname">errcode_ret</code>: | |
| </p> | |
| <div class="itemizedlist"> | |
| <ul class="itemizedlist" style="list-style-type: disc; "> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_CONTEXT</span> if <code class="varname">context</code> is not a valid context. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if values specified in | |
| <code class="varname">flags</code> are not as defined above. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">properties</code> is not NULL. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_PIPE_SIZE</span> if <code class="varname">pipe_packet_size</code> | |
| is 0 or the <code class="varname">pipe_packet_size</code> exceeds | |
| <code class="constant">CL_DEVICE_PIPE_MAX_PACKET_SIZE</code> value specified in table 4.3 | |
| (see <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>) | |
| for all devices in <code class="varname">context</code> or if | |
| <code class="varname">pipe_max_packets</code> is 0. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_MEM_OBJECT_ALLOCATION_FAILURE</span> if there is a failure to | |
| allocate memory for the pipe object. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate | |
| resources required by the OpenCL implementation on the device. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate | |
| resources required by the OpenCL implementation on the host. | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="specification"></a> | |
| <h2>Specification</h2> | |
| <p> | |
| <img src="pdficon_small1.gif" /> | |
| <a href="https://www.khronos.org/registry/cl/specs/opencl-2.1.pdf#page=160" target="OpenCL Spec">OpenCL Specification</a> | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="seealso"></a> | |
| <h2>Also see</h2> | |
| <p> | |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a>, | |
| <a class="citerefentry" href="clCreateImage.html"><span class="citerefentry"><span class="refentrytitle">clCreateImage</span></span></a> | |
| </p> | |
| </div> | |
| <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2015 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. | |
| </div> | |
| </div> | |
| </body> | |
| </html> |