| <?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>clCreateSamplerWithProperties</title> | |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> | |
| <meta name="keywords" content="clCreateSamplerWithProperties" /> | |
| </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="clCreateSamplerWithProperties"></a> | |
| <h1> | |
| clCreateSamplerWithProperties | |
| </h1> | |
| <p> | |
| Creates a sampler 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_sampler</a> <strong class="fsfunc">clCreateSamplerWithProperties</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>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_sampler_properties" target="pagedisplay">cl_sampler_properties</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*sampler_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> | |
| Must be a valid OpenCL context. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname">sampler_properties</code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies a list of sampler property names and | |
| their corresponding values. | |
| Each sampler property name is immediately followed | |
| by the corresponding desired value. The | |
| list is terminated with 0. The list of supported | |
| properties is described in the table below. If a | |
| supported property and its value is not specified in | |
| <code class="varname">sampler_properties</code>, its default value will be | |
| used. <code class="varname">sampler_properties</code> can be | |
| NULL in which case the default values for supported sampler | |
| properties will be used. | |
| </p> | |
| <div class="informaltable"> | |
| <table class="informaltable" border="1"> | |
| <colgroup> | |
| <col align="left" class="col1" /> | |
| <col align="left" class="col2" /> | |
| <col align="left" class="col3" /> | |
| </colgroup> | |
| <thead> | |
| <tr> | |
| <th align="left">cl_sampler_properties enum</th> | |
| <th align="left">Property Value</th> | |
| <th align="left">Description</th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_SAMPLER_NORMALIZED_COORDS</code> | |
| </td> | |
| <td align="left"> | |
| <span class="type">cl_bool</span> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| A boolean value that specifies | |
| whether the image coordinates | |
| specified are normalized or not. | |
| </p> | |
| <p> | |
| The default value (i.e. the value used | |
| if this property is not specified in | |
| <code class="varname">sampler_properties</code>) is <code class="constant">CL_TRUE</code>. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_SAMPLER_ADDRESSING_MODE</code> | |
| </td> | |
| <td align="left"> | |
| <span class="type">cl_addressing_mode</span> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| Specifies how out-of-range image | |
| coordinates are handled when reading | |
| from an image. | |
| </p> | |
| <p> | |
| Valid values are: | |
| </p> | |
| <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><code class="constant">CL_ADDRESS_MIRRORED_REPEAT</code></li><li class="listitem"><code class="constant">CL_ADDRESS_REPEAT</code></li><li class="listitem"><code class="constant">CL_ADDRESS_CLAMP_TO_EDGE</code></li><li class="listitem"><code class="constant">CL_ADDRESS_CLAMP</code></li><li class="listitem"><code class="constant">CL_ADDRESS_NONE</code></li></ul></div> | |
| <p> | |
| The default is <code class="constant">CL_ADDRESS_CLAMP</code>. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_SAMPLER_FILTER_MODE</code> | |
| </td> | |
| <td align="left"> | |
| <span class="type">cl_filter_mode</span> | |
| </td> | |
| <td align="left"> | |
| <p> | |
| Specifies the type of filter that must | |
| be applied when reading an image. | |
| Valid values are: | |
| </p> | |
| <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><code class="constant">CL_FILTER_NEAREST</code></li><li class="listitem"><code class="constant">CL_FILTER_LINEAR</code></li></ul></div> | |
| <p> | |
| The default is <code class="constant">CL_FILTER_NEAREST</code>. | |
| </p> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </div> | |
| <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 supported, the following sampler | |
| properties can be specified when a sampler object is | |
| created using <code class="function">clCreateSamplerWithProperties</code>: | |
| </p> | |
| <div class="informaltable"> | |
| <table class="informaltable" border="1"> | |
| <colgroup> | |
| <col align="left" class="col1" /> | |
| <col align="left" class="col2" /> | |
| <col align="left" class="col3" /> | |
| </colgroup> | |
| <thead> | |
| <tr> | |
| <th align="left">cl_sampler_properties enum</th> | |
| <th align="left">Property Value</th> | |
| <th align="left">Default Value</th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_SAMPLER_MIP_FILTER_MODE_KHR</code> | |
| </td> | |
| <td align="left"> | |
| <span class="type">cl_filter_mode</span> | |
| </td> | |
| <td align="left"> | |
| <code class="constant">CL_FILTER_NEAREST_KHR</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_SAMPLER_LOD_MIN_KHR</code> | |
| </td> | |
| <td align="left"> | |
| <span class="type">cl_float</span> | |
| </td> | |
| <td align="left"> | |
| <code class="constant">0.0f</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_SAMPLER_LOD_MAX_KHR</code> | |
| </td> | |
| <td align="left"> | |
| <span class="type">cl_float</span> | |
| </td> | |
| <td align="left"> | |
| <code class="constant">MAXFLOAT</code> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </div> | |
| <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 supported, | |
| The sampler properties | |
| <code class="constant">CL_SAMPLER_MIP_FILTER_MODE_KHR</code>, | |
| <code class="constant">CL_SAMPLER_LOD_MIN_KHR</code> and | |
| <code class="constant">CL_SAMPLER_LOD_MAX_KHR</code> cannot be specified with | |
| any samplers initialized in the OpenCL program | |
| source. Only the default values for these | |
| properties will be used. To create a sampler | |
| with specific values for these properties, a sampler | |
| object must be created with | |
| <code class="function">clCreateSamplerWithProperties</code> | |
| and passed as an argument to a kernel. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> errcode_ret </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Returns 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> | |
| A sampler object describes how to sample an image when the | |
| image is read in the kernel. The built-in functions to read from an image in a kernel | |
| take a sampler as an argument. The sampler arguments to the image read function can | |
| be sampler objects created using OpenCL functions and passed as argument values to | |
| the kernel or can be samplers declared inside a kernel. | |
| </p> | |
| <p> | |
| For more information about working with samplers, see | |
| <a class="citerefentry" href="sampler_t.html"><span class="citerefentry"><span class="refentrytitle">sampler_t</span></span></a> | |
| </p> | |
| <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 supported, the sampler properties | |
| <code class="constant">CL_SAMPLER_MIP_FILTER_MODE_KHR</code>, | |
| <code class="constant">CL_SAMPLER_LOD_MIN_KHR</code> and | |
| <code class="constant">CL_SAMPLER_LOD_MAX_KHR</code> cannot be | |
| specified with any samplers initialized in the OpenCL | |
| program source. Only the default values for these | |
| properties will be used. To create a sampler | |
| with specific values for these properties, a | |
| sampler object must be created with | |
| <code class="function">clCreateSamplerWithProperties</code> | |
| and passed as an argument to a kernel. | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="errors"></a> | |
| <h2>Errors</h2> | |
| <p> | |
| Returns a valid non-zero sampler object and <code class="varname">errcode_ret</code> is set to | |
| <span class="errorname">CL_SUCCESS</span> if the sampler 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 the property | |
| name in <code class="varname">sampler_properties</code> is not a supported | |
| property name, if the value specified for a supported property | |
| name is not valid, or if the | |
| same property name is specified more than once. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if images are not | |
| supported by any device associated with <code class="varname">context</code> | |
| (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 <span class="errorname">CL_FALSE</span>). | |
| </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#namedest=clCreateSamplerWithProperties" target="OpenCL Spec">OpenCL Specification</a> | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="seealso"></a> | |
| <h2>Also see</h2> | |
| <p> | |
| <a class="citerefentry" href="clRetainSampler.html"><span class="citerefentry"><span class="refentrytitle">clRetainSampler</span></span></a>, | |
| <a class="citerefentry" href="clReleaseSampler.html"><span class="citerefentry"><span class="refentrytitle">clReleaseSampler</span></span></a>, | |
| <a class="citerefentry" href="clGetSamplerInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetSamplerInfo</span></span></a> | |
| <a class="citerefentry" href="sampler_t.html"><span class="citerefentry"><span class="refentrytitle">sampler_t</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> |