| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>CudaModule (OpenJ9 JDK 16)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: openj9.cuda, package: com.ibm.cuda, class: CudaModule"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.cuda.CudaModule class"> |
| <meta name="keywords" content="getFunction()"> |
| <meta name="keywords" content="getGlobal()"> |
| <meta name="keywords" content="getSurface()"> |
| <meta name="keywords" content="getTexture()"> |
| <meta name="keywords" content="unload()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar.top"> |
| <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 16</strong></div></div> |
| <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/CudaModule.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../module-summary.html">openj9.cuda</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.cuda</a></div> |
| <h1 title="Class CudaModule" class="title">Class CudaModule</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a> |
| <div class="inheritance">com.ibm.cuda.CudaModule</div> |
| </div> |
| <section class="description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">CudaModule</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span></div> |
| <div class="block">The <code>CudaModule</code> class represents a module that has been loaded |
| on a CUDA-capable device. |
| <p> |
| When no longer required, a module must be unloaded (see <a href="#unload()"><code>unload()</code></a>).</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested.class.summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="CudaModule.Cache.html" title="class in com.ibm.cuda">CudaModule.Cache</a></span></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The <code>Cache</code> class provides a simple mechanism to avoid reloading |
| modules repeatedly.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor.summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.cuda.CudaDevice,byte%5B%5D)">CudaModule</a></span>​(<a href="CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a> device, |
| byte[] image)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Loads a module on the specified device, using the given image and the |
| default options.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.cuda.CudaDevice,byte%5B%5D,com.ibm.cuda.CudaJitOptions)">CudaModule</a></span>​(<a href="CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a> device, |
| byte[] image, |
| <a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a> options)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Loads a module on the specified device, using the given image and the |
| given options.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.cuda.CudaDevice,java.io.InputStream)">CudaModule</a></span>​(<a href="CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a> device, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> input)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Loads a module on the specified device from the given input stream using |
| the default options.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.cuda.CudaDevice,java.io.InputStream,com.ibm.cuda.CudaJitOptions)">CudaModule</a></span>​(<a href="CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a> device, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> input, |
| <a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a> options)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Loads a module on the specified device from the given input stream using |
| the specified options.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaFunction.html" title="class in com.ibm.cuda">CudaFunction</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getFunction(java.lang.String)">getFunction</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the function of the specified name from this module.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaGlobal.html" title="class in com.ibm.cuda">CudaGlobal</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getGlobal(java.lang.String)">getGlobal</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the global variable of the specified name from this module.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaSurface.html" title="class in com.ibm.cuda">CudaSurface</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getSurface(java.lang.String)">getSurface</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the surface of the specified name from this module.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaTexture.html" title="class in com.ibm.cuda">CudaTexture</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getTexture(java.lang.String)">getTexture</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the texture of the specified name from this module.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#unload()">unload</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Unloads this module from the associated device.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor.detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(com.ibm.cuda.CudaDevice,byte[])"> |
| <h3>CudaModule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CudaModule</span>​<span class="parameters">(<a href="CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a> device, |
| byte[] image)</span> |
| throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></span></div> |
| <div class="block">Loads a module on the specified device, using the given image and the |
| default options.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>device</code> - the specified device</dd> |
| <dd><code>image</code> - the module image</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" target="_blank">SecurityException</a></code> - if a security manager exists and the calling thread |
| does not have permission to load GPU modules</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(com.ibm.cuda.CudaDevice,byte[],com.ibm.cuda.CudaJitOptions)"> |
| <h3>CudaModule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CudaModule</span>​<span class="parameters">(<a href="CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a> device, |
| byte[] image, |
| <a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a> options)</span> |
| throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></span></div> |
| <div class="block">Loads a module on the specified device, using the given image and the |
| given options.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>device</code> - the specified device</dd> |
| <dd><code>image</code> - the module image</dd> |
| <dd><code>options</code> - the desired options</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" target="_blank">SecurityException</a></code> - if a security manager exists and the calling thread |
| does not have permission to load GPU modules</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(com.ibm.cuda.CudaDevice,java.io.InputStream)"> |
| <h3>CudaModule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CudaModule</span>​<span class="parameters">(<a href="CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a> device, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> input)</span> |
| throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div> |
| <div class="block">Loads a module on the specified device from the given input stream using |
| the default options.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>device</code> - the specified device</dd> |
| <dd><code>input</code> - a stream containing the module image</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if an I/O error occurs reading <code>input</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" target="_blank">SecurityException</a></code> - if a security manager exists and the calling thread |
| does not have permission to load GPU modules</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(com.ibm.cuda.CudaDevice,java.io.InputStream,com.ibm.cuda.CudaJitOptions)"> |
| <h3>CudaModule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CudaModule</span>​<span class="parameters">(<a href="CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a> device, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> input, |
| <a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a> options)</span> |
| throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div> |
| <div class="block">Loads a module on the specified device from the given input stream using |
| the specified options.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>device</code> - the specified device</dd> |
| <dd><code>input</code> - a stream containing the module image</dd> |
| <dd><code>options</code> - the desired options</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if an I/O error occurs reading <code>input</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" target="_blank">SecurityException</a></code> - if a security manager exists and the calling thread |
| does not have permission to load GPU modules</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getFunction(java.lang.String)"> |
| <h3>getFunction</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CudaFunction.html" title="class in com.ibm.cuda">CudaFunction</a></span> <span class="element-name">getFunction</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> name)</span> |
| throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></span></div> |
| <div class="block">Returns the function of the specified name from this module.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the link-name of the desired function</dd> |
| <dt>Returns:</dt> |
| <dd>the function of the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalStateException</a></code> - if this module has been unloaded (see <a href="#unload()"><code>unload()</code></a>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGlobal(java.lang.String)"> |
| <h3>getGlobal</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CudaGlobal.html" title="class in com.ibm.cuda">CudaGlobal</a></span> <span class="element-name">getGlobal</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> name)</span> |
| throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></span></div> |
| <div class="block">Returns the global variable of the specified name from this module.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the link-name of the desired global variable</dd> |
| <dt>Returns:</dt> |
| <dd>the global variable of the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalStateException</a></code> - if this module has been unloaded (see <a href="#unload()"><code>unload()</code></a>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSurface(java.lang.String)"> |
| <h3>getSurface</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CudaSurface.html" title="class in com.ibm.cuda">CudaSurface</a></span> <span class="element-name">getSurface</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> name)</span> |
| throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></span></div> |
| <div class="block">Returns the surface of the specified name from this module.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the link-name of the desired surface</dd> |
| <dt>Returns:</dt> |
| <dd>the surface of the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalStateException</a></code> - if this module has been unloaded (see <a href="#unload()"><code>unload()</code></a>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTexture(java.lang.String)"> |
| <h3>getTexture</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CudaTexture.html" title="class in com.ibm.cuda">CudaTexture</a></span> <span class="element-name">getTexture</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> name)</span> |
| throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></span></div> |
| <div class="block">Returns the texture of the specified name from this module.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the link-name of the desired texture</dd> |
| <dt>Returns:</dt> |
| <dd>the texture of the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalStateException</a></code> - if this module has been unloaded (see <a href="#unload()"><code>unload()</code></a>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unload()"> |
| <h3>unload</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">unload</span>() |
| throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></span></div> |
| <div class="block">Unloads this module from the associated device. |
| <p> |
| Note that this has no effect on any <a href="CudaModule.Cache.html" title="class in com.ibm.cuda"><code>caches</code></a>.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |