| <?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>imageDescriptor</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /> |
| <meta name="keywords" content="imageDescriptor" /> |
| </head> |
| <body> |
| <div class="refentry"> |
| <a id="idm3248"></a> |
| <div class="titlepage"></div> |
| <div xmlns="" class="refnamediv"> |
| <a xmlns="http://www.w3.org/1999/xhtml" id="cl_image_format"></a> |
| <h1>imageDescriptor</h1> |
| <p> |
| The image descriptor structure describes the type and dimensions of the image or image array and is defined as: |
| </p> |
| </div> |
| <div class="refsect2"> |
| <a id="synopsis"></a> |
| <h3> |
| </h3> |
| <div class="informaltable"> |
| <table border="0"> |
| <colgroup> |
| <col align="left" class="col1" /> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td align="left">typedef struct _cl_image_desc { |
| cl_mem_object_type image_type; |
| size_t image_width; |
| size_t image_height; |
| size_t image_depth; |
| size_t image_array_size; |
| size_t image_row_pitch; |
| size_t image_slice_pitch; |
| cl_uint num_mip_levels; |
| cl_uint num_samples; |
| cl_mem buffer; |
| } cl_image_desc;</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a id="parameters"></a> |
| <h2>Members</h2> |
| <div class="variablelist"> |
| <dl> |
| <dt> |
| <span class="term">image_type</span> |
| </dt> |
| <dd> |
| <p> |
| Describes the image type and must be either |
| <code class="constant">CL_MEM_OBJECT_IMAGE1D</code>, |
| <code class="constant">CL_MEM_OBJECT_IMAGE1D_BUFFER</code>, |
| <code class="constant">CL_MEM_OBJECT_IMAGE1D_ARRAY</code>, |
| <code class="constant">CL_MEM_OBJECT_IMAGE2D</code>, |
| <code class="constant">CL_MEM_OBJECT_IMAGE2D_ARRAY</code>, or |
| <code class="constant">CL_MEM_OBJECT_IMAGE3D</code>. |
| </p> |
| </dd> |
| <dt> |
| <span class="term">image_width</span> |
| </dt> |
| <dd> |
| <p> |
| The width of the image in pixels. For a 2D |
| image and image array, the image width must be ≤ |
| <code class="constant">CL_DEVICE_IMAGE2D_MAX_WIDTH</code>. For a 3D image, the image |
| width must be ≤ <code class="constant">CL_DEVICE_IMAGE3D_MAX_WIDTH</code>. For |
| a 1D image buffer, the image width must be ≤ |
| <code class="constant">CL_DEVICE_IMAGE_MAX_BUFFER_SIZE</code>. For |
| a 1D image and 1D image array, the image width must be ≤ |
| <code class="constant">CL_DEVICE_IMAGE2D_MAX_WIDTH</code>. |
| </p> |
| </dd> |
| <dt> |
| <span class="term">image_height</span> |
| </dt> |
| <dd> |
| <p> |
| The height of the image in pixels. This is only used if the image is a 2D, 3D |
| or 2D image array. For a 2D image or image array, the image height must be |
| ≤ <code class="constant">CL_DEVICE_IMAGE2D_MAX_HEIGHT</code>. For a 3D image, the |
| image height must be ≤ <code class="constant">CL_DEVICE_IMAGE3D_MAX_HEIGHT</code>. |
| </p> |
| </dd> |
| <dt> |
| <span class="term">image_depth</span> |
| </dt> |
| <dd> |
| <p> |
| The depth of the image in pixels. This is only used if the |
| image is a 3D image and must be a value ≥ 1 and ≤ |
| <code class="constant">CL_DEVICE_IMAGE3D_MAX_DEPTH</code>. |
| </p> |
| </dd> |
| <dt> |
| <span class="term">image_array_size</span> |
| </dt> |
| <dd> |
| <p> |
| The number of images in the image array. This is only |
| used if the image is a 1D or 2D image array. The values for |
| <code class="varname">image_array_size</code>, if specified, must be a value ≥ |
| 1 and ≤ <code class="constant">CL_DEVICE_IMAGE_MAX_ARRAY_SIZE</code>. |
| </p> |
| <p> |
| Note that reading and writing 2D image arrays from a kernel with |
| <code class="varname">image_array_size</code> = 1 may be lower performance than |
| 2D images. |
| </p> |
| </dd> |
| <dt> |
| <span class="term">image_row_pitch</span> |
| </dt> |
| <dd> |
| <p> |
| The scan-line pitch in bytes. This must be 0 if <code class="varname">host_ptr</code> |
| is NULL and can be either 0 or ≥ image_width * size of element in bytes if |
| <code class="varname">host_ptr</code> is not NULL. If <code class="varname">host_ptr</code> |
| is not NULL and <code class="varname">image_row_pitch</code> = |
| 0, <code class="varname">image_row_pitch</code> is calculated as |
| <code class="varname">image_width</code> * size of element in bytes. If |
| <code class="varname">image_row_pitch</code> is not 0, it must be a multiple of |
| the image element size in bytes. |
| </p> |
| </dd> |
| <dt> |
| <span class="term">image_slice_pitch</span> |
| </dt> |
| <dd> |
| <p> |
| The size in bytes of each 2D slice in the 3D image or the size in |
| bytes of each image in a 1D or 2D image array. This must be 0 if |
| <code class="varname">host_ptr</code> is NULL. If <code class="varname">host_ptr</code> |
| is not NULL, <code class="varname">image_slice_pitch</code> can |
| be either 0 or ≥ <code class="varname">image_row_pitch</code> * |
| <code class="varname">image_height</code> for a 2D image array or 3D image |
| and can be either 0 or ≥ <code class="varname">image_row_pitch</code> |
| for a 1D image array. If <code class="varname">host_ptr</code> |
| is not NULL and <code class="varname">image_slice_pitch</code> = |
| 0, <code class="varname">image_slice_pitch</code> is calculated as |
| <code class="varname">image_row_pitch</code> * <code class="varname">image_height</code> |
| for a 2D image array or 3D image and <code class="varname">image_row_pitch</code> |
| for a 1D image array. If <code class="varname">image_slice_pitch</code> is not 0, |
| it must be a multiple of the <code class="varname">image_row_pitch</code>. |
| </p> |
| </dd> |
| <dt> |
| <span class="term">num_mip_level, </span> |
| <span class="term">num_samples</span> |
| </dt> |
| <dd> |
| <p> |
| Must be 0. |
| </p> |
| </dd> |
| <dt> |
| <span class="term">buffer</span> |
| </dt> |
| <dd> |
| <p> |
| Refers to a valid buffer memory object if <code class="varname">image_type</code> |
| is <code class="constant">CL_MEM_OBJECT_IMAGE1D_BUFFER</code>. Otherwise it must |
| be NULL. For a 1D image buffer object, the image pixels are taken from |
| the buffer object's data store. When the contents of a buffer object's |
| data store are modified, those changes are reflected in the contents of |
| the 1D image buffer object and vice-versa at corresponding sychronization |
| points. The <code class="varname">image_width</code> * size of element in bytes |
| must be ≤ size of buffer object data store. |
| </p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a id="note"></a> |
| <h2>Note</h2> |
| <p> |
| Concurrent reading from, writing to and copying between both a buffer object and 1D image |
| buffer object associated with the buffer object is undefined. Only reading from both |
| a buffer object and 1D image buffer object associated with the buffer object is defined. |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a id="specification"></a> |
| <h2>Specification</h2> |
| <p> |
| <img src="pdficon_small1.gif" /> |
| |
| <a href="http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf#page=95" 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_format.html"><span class="citerefentry"><span class="refentrytitle">cl_image_format</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-2011 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> |