| <?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>smoothstep</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> |
| <meta name="keywords" content=" smoothstep " /> |
| </head> |
| <body> |
| <div class="refentry"> |
| <a id="idm1"></a> |
| <div class="titlepage"></div> |
| <div xmlns="" class="refnamediv"> |
| <a xmlns="http://www.w3.org/1999/xhtml" id="step"></a> |
| <h1>smoothstep</h1> |
| <p> |
| Step and interpolate. |
| </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"> |
| gentype |
| <strong class="fsfunc"> |
| smoothstep |
| </strong> |
| (</code> |
| <td>gentype <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">edge0</var>, </td> |
| </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td>gentype <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">edge1</var>, </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td>gentype <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">x</var><code>)</code></td> |
| </tr> |
| </table> |
| </div> |
| <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"> |
| gentype |
| <strong class="fsfunc"> |
| smoothstep |
| </strong> |
| (</code> |
| <td>float <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">edge0</var>, </td> |
| </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td>float <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">edge1</var>, </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td>gentype <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">x</var><code>)</code></td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| <div class="refsect2"> |
| <a id="double"></a> |
| <h3></h3> |
| <div class="informaltable"> |
| <table class="informaltable" border="0"> |
| <colgroup> |
| <col align="left" class="col1" /> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td align="left"> |
| gentype <code class="function">smoothstep</code> (<span class="type">double</span> <code class="varname">edge0</code>, |
| <span class="type">double</span> <code class="varname">edge1</code>, |
| <span class="type">gentype</span> <code class="varname">x</code>) // if double extension enabled |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| gentype <code class="function">smoothstep</code> (<span class="type">half</span> <code class="varname">edge0</code>, |
| <span class="type">half</span> <code class="varname">edge1</code>, |
| <span class="type">gentype</span> <code class="varname">x</code>) // if half extension enabled |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a id="description"></a> |
| <h2>Description</h2> |
| <p> |
| Returns 0.0 if <code class="varname">x</code> less than or equal to <code class="varname">edge0</code> and 1.0 if <code class="varname">x</code> greater than or equal to <code class="varname">edge1</code> and performs smooth Hermite interpolation between 0 and 1 when <code class="varname">edge0</code> < <code class="varname">x</code> < <code class="varname">edge1</code>. This is useful in cases where you would want a threshold function with a smooth transition.</p> |
| <p>This is equivalent to:</p> |
| <div class="literallayout"> |
| <p> gentype <span class="emphasis"><em>t</em></span>;<br /> |
| <span class="emphasis"><em>t</em></span> = clamp(((<span class="emphasis"><em>x</em></span> - <span class="emphasis"><em>edge0</em></span>) / (<span class="emphasis"><em>edge1</em></span> - <span class="emphasis"><em>edge0</em></span>), 0, 1);<br /> |
| return <span class="emphasis"><em>t</em></span> * <span class="emphasis"><em>t</em></span> * (3 - 2 * <span class="emphasis"><em>t</em></span> );</p> |
| </div> |
| <p> |
| Results are undefined if <code class="varname">edge0</code> greater than or equal to <code class="varname">edge1</code> or if <code class="varname">x</code>, |
| <code class="varname">edge0</code> or <code class="varname">edge1</code> is a NaN. |
| </p> |
| <p>This function can be implemented using contractions such as <a class="citerefentry" href="mad.html"><span class="citerefentry"><span class="refentrytitle">mad</span></span></a> or <a class="citerefentry" href="fma.html"><span class="citerefentry"><span class="refentrytitle">fma</span></span></a>.</p> |
| </div> |
| <div class="refsect1"> |
| <a id="notes"></a> |
| <h2>Notes</h2> |
| <p> |
| Built-in common functions operate component-wise and the description is per-component. We use the generic type name <span class="type">gentype</span> to indicate that the |
| function can take <span class="type">float</span>, <span class="type">float2</span>, <span class="type">float4</span>, <span class="type">float8</span>, or <span class="type">float16</span> as the type for the arguments. |
| </p> |
| <p> |
| The built-in common functions are implemented using the round to nearest even rounding mode. |
| </p> |
| <p> |
| If extended with <a class="citerefentry" href="cl_khr_fp64.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp64</span></span></a>, generic type name <span class="type">gentype</span> may indicate <span class="type">double</span> and <span class="type">double{2|4|8|16}</span> as arguments and return values. If extended with <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a>, generic type name <span class="type">gentype</span> may indicate <span class="type">half</span> and <span class="type">half{2|4|8|16}</span> as arguments and return values. |
| </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.0.pdf#page=180" target="OpenCL Spec">OpenCL Specification</a> |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a id="seealso"></a> |
| <h2>Also see</h2> |
| <p> |
| <a class="citerefentry" href="commonFunctions.html"><span class="citerefentry"><span class="refentrytitle">Common Functions</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-2009 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> |
