| <?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>clCreateImage</title> | |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> | |
| <meta name="keywords" content="clCreateImage" /> | |
| </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="clCreateImage"></a> | |
| <h1> | |
| clCreateImage | |
| </h1> | |
| <p> | |
| Creates a 1D image, 1D image buffer, 1D image array, 2D image, 2D image array or 3D image 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">clCreateImage</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>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="cl_image_format.html" target="pagedisplay">cl_image_format</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*image_format</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="cl_image_desc.html" target="pagedisplay">cl_image_desc</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*image_desc</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">void</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*host_ptr</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 on which the image object is to be created. | |
| </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 about the image memory object being created and is | |
| described in the table below. | |
| </p> | |
| <p> | |
| For all image types except <code class="constant">CL_MEM_OBJECT_IMAGE1D_BUFFER</code>, | |
| 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>. | |
| </p> | |
| <p> | |
| For <code class="constant">CL_MEM_OBJECT_IMAGE1D_BUFFER</code> image type, | |
| or an image created from another | |
| memory object (image or buffer), if the | |
| <code class="constant">CL_MEM_READ_WRITE</code>, <code class="constant">CL_MEM_READ_ONLY</code> | |
| or <code class="constant">CL_MEM_WRITE_ONLY</code> values are not specified in | |
| <code class="varname">flags</code>, they are inherited from the corresponding | |
| memory access qualifers associated with <code class="varname">mem_object</code>. | |
| The <code class="constant">CL_MEM_USE_HOST_PTR</code>, | |
| <code class="constant">CL_MEM_ALLOC_HOST_PTR</code> and | |
| <code class="constant">CL_MEM_COPY_HOST_PTR</code> values cannot | |
| be specified in <code class="varname">flags</code> but are inherited | |
| from the corresponding memory access qualifiers associated with | |
| <code class="varname">mem_object</code>. If <code class="constant">CL_MEM_COPY_HOST_PTR</code> | |
| is specified in the memory access qualifier values associated with | |
| <code class="varname">mem_object</code> it does not imply any additional copies | |
| when the image is created from <code class="varname">mem_object</code>. | |
| If the <code class="constant">CL_MEM_HOST_WRITE_ONLY</code>, | |
| <code class="constant">CL_MEM_HOST_READ_ONLY</code> or | |
| <code class="constant">CL_MEM_HOST_NO_ACCESS</code> values are not specified in | |
| <code class="varname">flags</code>, they are inherited from the corresponding memory | |
| access qualifiers associated with <code class="varname">mem_object</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"> image_format </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A pointer to a structure that | |
| describes format properties of the image to be allocated. See | |
| <a class="citerefentry" href="cl_image_format.html"><span class="citerefentry"><span class="refentrytitle">cl_image_format</span></span></a> | |
| for a detailed description of the image format descriptor. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> image_desc </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A pointer to a structure that | |
| describes type and dimensions of the image to be allocated. See | |
| <a class="citerefentry" href="cl_image_desc.html"><span class="citerefentry"><span class="refentrytitle">cl_image_desc</span></span></a> | |
| for more information. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> host_ptr </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A pointer to the image data that may already be allocated by the application. | |
| Refer to table below for a description of how large the buffer that | |
| <code class="varname">host_ptr</code> points to must be. | |
| </p> | |
| <div class="informaltable"> | |
| <table class="informaltable" border="1"> | |
| <colgroup> | |
| <col align="left" class="col1" /> | |
| <col align="left" class="col2" /> | |
| </colgroup> | |
| <thead> | |
| <tr> | |
| <th align="left">Image Type</th> | |
| <th align="left">Size of buffer that <code class="varname">host_ptr</code> points to</th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_OBJECT_IMAGE1D</code> | |
| </td> | |
| <td align="left"> | |
| <code class="constant">≥ image_row_pitch</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_OBJECT_IMAGE1D_BUFFER</code> | |
| </td> | |
| <td align="left"> | |
| <code class="constant">≥ image_row_pitch</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_OBJECT_IMAGE2D</code> | |
| </td> | |
| <td align="left"> | |
| <code class="constant">≥ image_row_pitch * image_height</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_OBJECT_IMAGE3D</code> | |
| </td> | |
| <td align="left"> | |
| <code class="constant">≥ image_slice_pitch * image_depth</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_OBJECT_IMAGE1D_ARRAY</code> | |
| </td> | |
| <td align="left"> | |
| <code class="constant">≥ image_slice_pitch * image_array_size</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_OBJECT_IMAGE2D_ARRAY</code> | |
| </td> | |
| <td align="left"> | |
| <code class="constant">≥ image_slice_pitch * image_array_size</code> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </div> | |
| <p> | |
| <code class="function">clCreateImage</code> can be used to create a 2D image from a | |
| buffer object or a 2D image from another 2D image object. | |
| </p> | |
| <p> | |
| A 2D image can be created from a buffer by specifying a buffer | |
| object in the <code class="code">image_desc->mem_object</code> passed to | |
| <code class="function">clCreateImage</code> for <code class="code">image_desc->image_type</code> = | |
| <code class="constant">CL_MEM_OBJECT_IMAGE2D</code>. If | |
| <code class="code">image_desc->mem_object</code> is created with | |
| <code class="constant">CL_MEM_USE_HOST_PTR</code>, the | |
| <code class="varname">host_ptr</code> specified to | |
| <code class="function">clCreateBuffer</code> must be aligned to the | |
| minimum of the <code class="constant">CL_DEVICE_IMAGE_BASE_ADDRESS_ALIGNMENT</code> | |
| value for all devices in | |
| the context associated with <code class="code">image_desc->mem_object</code> | |
| and that support images. | |
| </p> | |
| <p> | |
| A 2D image can be created from another 2D image object | |
| by specifying an image object in the | |
| <code class="code">image_desc->mem_object</code> passed to | |
| <code class="function">clCreateImage</code> for <code class="code">image_desc->image_type</code> | |
| = <code class="constant">CL_MEM_OBJECT_IMAGE2D</code>. This | |
| allows users to create a new image object that shares the | |
| image data store with <code class="code">mem_object</code> but | |
| views the pixels in the image with a different channel | |
| order and channel type. The restrictions are: | |
| </p> | |
| <p> | |
| (1) all the values specified in <code class="code">image_desc</code> | |
| except for <code class="code">mem_object</code> must match the image | |
| descriptor information associated with <code class="code">mem_object</code>. | |
| </p> | |
| <p> | |
| (2) The <code class="code">image_desc</code> used for creation of | |
| <code class="code">mem_object</code> may not be equivalent to image | |
| descriptor information associated with | |
| <code class="code">mem_object</code>. To ensure the values | |
| in <code class="code">image_desc</code> | |
| will match one can query <code class="code">mem_object</code> | |
| for associated information using <code class="function">clGetImageInfo</code> | |
| function described in section 5.3.7. | |
| </p> | |
| <p> | |
| (3) the channel data type specified in | |
| <code class="varname">image_format</code> must match | |
| the channel data type | |
| associated with <code class="code">mem_object</code>. | |
| The channel order values supported are: | |
| </p> | |
| <div class="informaltable"> | |
| <table class="informaltable" border="1"> | |
| <colgroup> | |
| <col align="center" class="col1" /> | |
| <col align="center" class="col2" /> | |
| </colgroup> | |
| <thead> | |
| <tr> | |
| <th align="center">image_channel_order specified in image_format</th> | |
| <th align="center">image channel order of mem_object</th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">CL_sBGRA</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_BGRA</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">CL_BGRA</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_sBGRA</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">CL_sRGBA</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_sRGBA</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">CL_sRGB</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGB</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">CL_RGB</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_sRGB</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">CL_sRGBx</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBx</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">CL_RGBx</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_sRGBx</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">CL_DEPTH</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_R</code> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </div> | |
| <p> | |
| (4) The channel order specified must have the same number of | |
| channels as the channel order of <code class="code">mem_object</code>. | |
| </p> | |
| <p> | |
| This allows developers to create a sRGB view of the image from | |
| a linear RGB view or vice-versa i.e. the pixels | |
| stored in the image can be accessed aslinear RGB or sRGB values. | |
| </p> | |
| <p> | |
| For a 3D image or 2D image array, the image data specified by | |
| <code class="varname">host_ptr</code> is stored as a linear sequence of adjacent 2D | |
| image slices or 2D images respectively. Each 2D image is a linear sequence | |
| of adjacent scanlines. Each scanline is a linear sequence of image elements. | |
| </p> | |
| <p> | |
| For a 2D image, the image data specified by <code class="varname">host_ptr</code> | |
| is stored as a linear sequence of adjacent scanlines. Each scanline is | |
| a linear sequence of image elements. | |
| </p> | |
| <p> | |
| For a 1D image array, the image data specified by <code class="varname">host_ptr</code> | |
| is stored as a linear sequence of adjacent 1D images respectively. Each 1D | |
| image or 1D image buffer is a single scanline which is a linear sequence | |
| of adjacent elements. | |
| </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="notes"></a> | |
| <h2>Notes</h2> | |
| <p> | |
| If the <a class="citerefentry" href="cl_khr_mipmap_image.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_mipmap_image</span></span></a> extension is enabled, | |
| then a mip-mapped 1D image, 1D image array, 2D image, 2D image array or 3D image is created by specifying | |
| <code class="varname">num_mip_levels</code> to be a value > 1 in <code class="varname">cl_image_desc</code> | |
| passed to <code class="function">clCreateImage</code>. The dimensions of a mip-mapped image can be a power of | |
| two or a non-power of two. Each successively smaller mipmap level is half the size of the previous level. | |
| If this half value is a fractional value, it is rounded down to the nearest integer. | |
| </p> | |
| <h4><a id="id-1.6.3"></a>Restrictions</h4> | |
| <p> | |
| The following restrictions apply when mip-mapped images are created with <code class="function">clCreateImage</code>. | |
| </p> | |
| <p> | |
| </p> | |
| <div class="itemizedlist"> | |
| <ul class="itemizedlist" style="list-style-type: disc; "> | |
| <li class="listitem"><code class="constant">CL_MEM_USE_HOST_PTR</code> or <code class="constant">CL_MEM_COPY_HOST_PTR</code> | |
| cannot be specified if a mipmapped image is created. | |
| </li> | |
| <li class="listitem"> | |
| The <code class="varname">host_ptr</code> argument to | |
| <code class="function">clCreateImage</code> must be a NULL value. | |
| </li> | |
| <li class="listitem"> | |
| Mip-mapped images cannot be created for | |
| <code class="constant">CL_MEM_OBJECT_IMAGE1D_BUFFER</code> images, depth images or | |
| multi-sampled (i.e. msaa) images. | |
| </li> | |
| </ul> | |
| </div> | |
| <p> | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="errors"></a> | |
| <h2>Errors</h2> | |
| <p> | |
| <code class="function">clCreateImage</code> returns a valid non-zero image object and | |
| <code class="varname">errcode_ret</code> is set to <span class="errorname">CL_SUCCESS</span> if the | |
| image 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 valid. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</span> if values specified in | |
| <code class="varname">image_format</code> are not valid or if <code class="varname">image_format</code> | |
| is NULL. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</span> if a 2D image is created from a buffer | |
| and the row pitch and base address alignment does not follow the rules described for | |
| creating a 2D image from a buffer. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</span> if a 2D image is created from a 2D | |
| image object and the rules described above are not followed. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_IMAGE_DESCRIPTOR</span> if values specified in | |
| <code class="varname">image_desc</code> are not valid or if <code class="varname">image_desc</code> | |
| is NULL. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_IMAGE_SIZE</span> if image dimensions specified | |
| in <code class="varname">image_desc</code> exceed the maximum image dimensions | |
| described in the table of allowed values for <code class="varname">param_name</code> | |
| for <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>. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_HOST_PTR</span> if <code class="varname">host_ptr</code> | |
| is NULL and <code class="constant">CL_MEM_USE_HOST_PTR</code> or | |
| <code class="constant">CL_MEM_COPY_HOST_PTR</code> are set in <code class="varname">flags</code> or if | |
| <code class="varname">host_ptr</code> is not NULL but <code class="constant">CL_MEM_COPY_HOST_PTR</code> | |
| or <code class="constant">CL_MEM_USE_HOST_PTR</code> are not set in <code class="varname">flags</code>. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if an image buffer | |
| is being created and the buffer object was | |
| created with <code class="constant">CL_MEM_WRITE_ONLY</code> and | |
| <code class="varname">flags</code> specifies <code class="constant">CL_MEM_READ_WRITE</code> or | |
| <code class="constant">CL_MEM_READ_ONLY</code>, or if the buffer | |
| object was created with <code class="constant">CL_MEM_READ_ONLY</code> | |
| and <code class="varname">flags</code> specifies <code class="constant">CL_MEM_READ_WRITE</code> | |
| or <code class="constant">CL_MEM_WRITE_ONLY</code>, or if <code class="varname">flags</code> | |
| specifies <code class="constant">CL_MEM_USE_HOST_PTR</code> or | |
| <code class="constant">CL_MEM_ALLOC_HOST_PTR</code> or | |
| <code class="constant">CL_MEM_COPY_HOST_PTR</code>. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if an image | |
| buffer is being created or an image is being created | |
| from another memory object (image or buffer) and the | |
| <code class="varname">mem_object</code> object was created | |
| with <code class="constant">CL_MEM_HOST_WRITE_ONLY</code> and | |
| <code class="varname">flags</code> specifies <code class="constant">CL_MEM_HOST_READ_ONLY</code>, | |
| or if <code class="varname">mem_object</code> was created with | |
| <code class="constant">CL_MEM_HOST_READ_ONLY</code> and <code class="varname">flags</code> specifies | |
| <code class="constant">CL_MEM_HOST_WRITE_ONLY</code>, or if | |
| <code class="varname">mem_object</code> was created with | |
| <code class="constant">CL_MEM_HOST_NO_ACCESS</code> and | |
| <code class="varname">flags</code> specifies <code class="constant">CL_MEM_HOST_READ_ONLY</code> or | |
| <code class="constant">CL_MEM_HOST_WRITE_ONLY</code>. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_IMAGE_FORMAT_NOT_SUPPORTED</span> if the | |
| <code class="varname">image_format</code> is not supported. | |
| </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 image object. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if there are | |
| no devices in <code class="varname">context</code> that support | |
| images (i.e. <code class="constant">CL_DEVICE_IMAGE_SUPPORT</code> | |
| (specified in the table of OpenCL Device Queries for | |
| <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>) | |
| is <code class="constant">CL_FALSE</code>). | |
| </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=128" target="OpenCL Spec">OpenCL Specification</a> | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="seealso"></a> | |
| <h2>Also see</h2> | |
| <p> | |
| <a class="citerefentry" href="cl_image_desc.html"><span class="citerefentry"><span class="refentrytitle">cl_image_desc</span></span></a>, | |
| <a class="citerefentry" href="cl_image_format.html"><span class="citerefentry"><span class="refentrytitle">cl_image_format</span></span></a>, | |
| <a class="citerefentry" href="classDiagram.html"><span class="citerefentry"><span class="refentrytitle">Cardinality Diagram</span></span></a>, | |
| <a class="citerefentry" href="cl_khr_mipmap_image.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_mipmap_image</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> |