1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: GCProgram Class Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18 $(document).ready(initResizable);
19 $(window).load(resizeHeight);
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25 $(document).ready(function() { init_search(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">Compute Library
43  <span id="projectnumber">18.03</span>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="pages.xhtml"><span>Related Pages</span></a></li>
59 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
61 <li><a href="files.xhtml"><span>Files</span></a></li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
69 <input type="text" id="MSearchField" value="Search" accesskey="S"
70 onfocus="searchBox.OnSearchFieldFocus(true)"
71 onblur="searchBox.OnSearchFieldFocus(false)"
72 onkeyup="searchBox.OnSearchFieldChange(event)"/>
73 </span><span class="right">
74 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
80 <div id="navrow2" class="tabs2">
82 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
83 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
84 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
85 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_g_c_program.xhtml','');});
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105 onmouseover="return searchBox.OnSearchSelectShow()"
106 onmouseout="return searchBox.OnSearchSelectHide()"
107 onkeydown="return searchBox.OnSearchSelectKey(event)">
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0"
113 name="MSearchResults" id="MSearchResults">
118 <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> </div>
120 <div class="headertitle">
121 <div class="title">GCProgram Class Reference</div> </div>
123 <div class="contents">
125 <p><a class="el" href="classarm__compute_1_1_g_c_program.xhtml" title="GCProgram class. ">GCProgram</a> class.
126 <a href="classarm__compute_1_1_g_c_program.xhtml#details">More...</a></p>
128 <p><code>#include <<a class="el" href="_g_c_kernel_library_8h_source.xhtml">GCKernelLibrary.h</a>></code></p>
129 <table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
131 Public Member Functions</h2></td></tr>
132 <tr class="memitem:aca45a2e24e9ad0a4ebaf2964589a6934"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml#aca45a2e24e9ad0a4ebaf2964589a6934">GCProgram</a> ()</td></tr>
133 <tr class="memdesc:aca45a2e24e9ad0a4ebaf2964589a6934"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#aca45a2e24e9ad0a4ebaf2964589a6934">More...</a><br /></td></tr>
134 <tr class="separator:aca45a2e24e9ad0a4ebaf2964589a6934"><td class="memSeparator" colspan="2"> </td></tr>
135 <tr class="memitem:adc13d76cb0c84a46a95570e3c8b3b2c0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml#adc13d76cb0c84a46a95570e3c8b3b2c0">GCProgram</a> (std::string <a class="el" href="classarm__compute_1_1_g_c_program.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>, std::string source)</td></tr>
136 <tr class="memdesc:adc13d76cb0c84a46a95570e3c8b3b2c0"><td class="mdescLeft"> </td><td class="mdescRight">Construct program from source file. <a href="#adc13d76cb0c84a46a95570e3c8b3b2c0">More...</a><br /></td></tr>
137 <tr class="separator:adc13d76cb0c84a46a95570e3c8b3b2c0"><td class="memSeparator" colspan="2"> </td></tr>
138 <tr class="memitem:a8983f4d244bb5ac30a705358fd0d9e8c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml#a8983f4d244bb5ac30a705358fd0d9e8c">GCProgram</a> (const <a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> &)=default</td></tr>
139 <tr class="memdesc:a8983f4d244bb5ac30a705358fd0d9e8c"><td class="mdescLeft"> </td><td class="mdescRight">Default Copy Constructor. <a href="#a8983f4d244bb5ac30a705358fd0d9e8c">More...</a><br /></td></tr>
140 <tr class="separator:a8983f4d244bb5ac30a705358fd0d9e8c"><td class="memSeparator" colspan="2"> </td></tr>
141 <tr class="memitem:adce48db8b06643f4e4072f9ea558d0ea"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml#adce48db8b06643f4e4072f9ea558d0ea">GCProgram</a> (<a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> &&)=default</td></tr>
142 <tr class="memdesc:adce48db8b06643f4e4072f9ea558d0ea"><td class="mdescLeft"> </td><td class="mdescRight">Default Move Constructor. <a href="#adce48db8b06643f4e4072f9ea558d0ea">More...</a><br /></td></tr>
143 <tr class="separator:adce48db8b06643f4e4072f9ea558d0ea"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:a4212dc2dbdd340faeba056d37cb912de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml#a4212dc2dbdd340faeba056d37cb912de">operator=</a> (const <a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> &)=default</td></tr>
145 <tr class="memdesc:a4212dc2dbdd340faeba056d37cb912de"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment operator. <a href="#a4212dc2dbdd340faeba056d37cb912de">More...</a><br /></td></tr>
146 <tr class="separator:a4212dc2dbdd340faeba056d37cb912de"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:a7792915d53fb314715e22f350a174072"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml#a7792915d53fb314715e22f350a174072">operator=</a> (<a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> &&)=default</td></tr>
148 <tr class="memdesc:a7792915d53fb314715e22f350a174072"><td class="mdescLeft"> </td><td class="mdescRight">Default move assignment operator. <a href="#a7792915d53fb314715e22f350a174072">More...</a><br /></td></tr>
149 <tr class="separator:a7792915d53fb314715e22f350a174072"><td class="memSeparator" colspan="2"> </td></tr>
150 <tr class="memitem:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a> () const </td></tr>
151 <tr class="memdesc:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="mdescLeft"> </td><td class="mdescRight">Returns program name. <a href="#a37627d5d5bba7f4a8690c71c2ab3cb07">More...</a><br /></td></tr>
152 <tr class="separator:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:a5b4af3fb9839027279876a231a328ec9"><td class="memItemLeft" align="right" valign="top">GLuint </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml#a5b4af3fb9839027279876a231a328ec9">link_program</a> (GLuint shader)</td></tr>
154 <tr class="memdesc:a5b4af3fb9839027279876a231a328ec9"><td class="mdescLeft"> </td><td class="mdescRight">Link program. <a href="#a5b4af3fb9839027279876a231a328ec9">More...</a><br /></td></tr>
155 <tr class="separator:a5b4af3fb9839027279876a231a328ec9"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:acab405c2120743ab9e063930064a6b0a"><td class="memItemLeft" align="right" valign="top">GLuint </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml#acab405c2120743ab9e063930064a6b0a">compile_shader</a> (const std::string &build_options)</td></tr>
157 <tr class="memdesc:acab405c2120743ab9e063930064a6b0a"><td class="mdescLeft"> </td><td class="mdescRight">Compile shader. <a href="#acab405c2120743ab9e063930064a6b0a">More...</a><br /></td></tr>
158 <tr class="separator:acab405c2120743ab9e063930064a6b0a"><td class="memSeparator" colspan="2"> </td></tr>
160 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
161 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_g_c_program.xhtml" title="GCProgram class. ">GCProgram</a> class. </p>
163 <p>Definition at line <a class="el" href="_g_c_kernel_library_8h_source.xhtml#l00039">39</a> of file <a class="el" href="_g_c_kernel_library_8h_source.xhtml">GCKernelLibrary.h</a>.</p>
164 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
165 <a class="anchor" id="aca45a2e24e9ad0a4ebaf2964589a6934"></a>
166 <div class="memitem">
167 <div class="memproto">
168 <table class="memname">
170 <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> </td>
172 <td class="paramname"></td><td>)</td>
176 </div><div class="memdoc">
178 <p>Default constructor. </p>
182 <a class="anchor" id="adc13d76cb0c84a46a95570e3c8b3b2c0"></a>
183 <div class="memitem">
184 <div class="memproto">
185 <table class="memname">
187 <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> </td>
189 <td class="paramtype">std::string </td>
190 <td class="paramname"><em>name</em>, </td>
193 <td class="paramkey"></td>
195 <td class="paramtype">std::string </td>
196 <td class="paramname"><em>source</em> </td>
204 </div><div class="memdoc">
206 <p>Construct program from source file. </p>
207 <dl class="params"><dt>Parameters</dt><dd>
208 <table class="params">
209 <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td><a class="el" href="classarm__compute_1_1_program.xhtml" title="Program class. ">Program</a> name. </td></tr>
210 <tr><td class="paramdir">[in]</td><td class="paramname">source</td><td><a class="el" href="classarm__compute_1_1_program.xhtml" title="Program class. ">Program</a> source. </td></tr>
217 <a class="anchor" id="a8983f4d244bb5ac30a705358fd0d9e8c"></a>
218 <div class="memitem">
219 <div class="memproto">
220 <table class="mlabels">
222 <td class="mlabels-left">
223 <table class="memname">
225 <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> </td>
227 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> & </td>
228 <td class="paramname"></td><td>)</td>
233 <td class="mlabels-right">
234 <span class="mlabels"><span class="mlabel">default</span></span> </td>
237 </div><div class="memdoc">
239 <p>Default Copy Constructor. </p>
243 <a class="anchor" id="adce48db8b06643f4e4072f9ea558d0ea"></a>
244 <div class="memitem">
245 <div class="memproto">
246 <table class="mlabels">
248 <td class="mlabels-left">
249 <table class="memname">
251 <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> </td>
253 <td class="paramtype"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> && </td>
254 <td class="paramname"></td><td>)</td>
259 <td class="mlabels-right">
260 <span class="mlabels"><span class="mlabel">default</span></span> </td>
263 </div><div class="memdoc">
265 <p>Default Move Constructor. </p>
269 <h2 class="groupheader">Member Function Documentation</h2>
270 <a class="anchor" id="acab405c2120743ab9e063930064a6b0a"></a>
271 <div class="memitem">
272 <div class="memproto">
273 <table class="memname">
275 <td class="memname">GLuint compile_shader </td>
277 <td class="paramtype">const std::string & </td>
278 <td class="paramname"><em>build_options</em></td><td>)</td>
282 </div><div class="memdoc">
284 <p>Compile shader. </p>
285 <dl class="params"><dt>Parameters</dt><dd>
286 <table class="params">
287 <tr><td class="paramdir">[in]</td><td class="paramname">build_options</td><td>Shader build options.</td></tr>
291 <dl class="section return"><dt>Returns</dt><dd>GLES shader object. </dd></dl>
293 <p>Referenced by <a class="el" href="_g_c_kernel_library_8h_source.xhtml#l00062">GCProgram::name()</a>.</p>
297 <a class="anchor" id="a5b4af3fb9839027279876a231a328ec9"></a>
298 <div class="memitem">
299 <div class="memproto">
300 <table class="memname">
302 <td class="memname">GLuint link_program </td>
304 <td class="paramtype">GLuint </td>
305 <td class="paramname"><em>shader</em></td><td>)</td>
309 </div><div class="memdoc">
311 <p>Link program. </p>
312 <dl class="params"><dt>Parameters</dt><dd>
313 <table class="params">
314 <tr><td class="paramdir">[in]</td><td class="paramname">shader</td><td>Shader used to link program.</td></tr>
318 <dl class="section return"><dt>Returns</dt><dd>linked program id . </dd></dl>
320 <p>Referenced by <a class="el" href="_g_c_kernel_library_8h_source.xhtml#l00062">GCProgram::name()</a>.</p>
324 <a class="anchor" id="a37627d5d5bba7f4a8690c71c2ab3cb07"></a>
325 <div class="memitem">
326 <div class="memproto">
327 <table class="mlabels">
329 <td class="mlabels-left">
330 <table class="memname">
332 <td class="memname">std::string name </td>
334 <td class="paramname"></td><td>)</td>
339 <td class="mlabels-right">
340 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
343 </div><div class="memdoc">
345 <p>Returns program name. </p>
346 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_program.xhtml" title="Program class. ">Program</a>'s name. </dd></dl>
348 <p>Definition at line <a class="el" href="_g_c_kernel_library_8h_source.xhtml#l00062">62</a> of file <a class="el" href="_g_c_kernel_library_8h_source.xhtml">GCKernelLibrary.h</a>.</p>
350 <p>References <a class="el" href="classarm__compute_1_1_g_c_program.xhtml#acab405c2120743ab9e063930064a6b0a">GCProgram::compile_shader()</a>, and <a class="el" href="classarm__compute_1_1_g_c_program.xhtml#a5b4af3fb9839027279876a231a328ec9">GCProgram::link_program()</a>.</p>
351 <div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> _name;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div></div><!-- fragment -->
354 <a class="anchor" id="a4212dc2dbdd340faeba056d37cb912de"></a>
355 <div class="memitem">
356 <div class="memproto">
357 <table class="mlabels">
359 <td class="mlabels-left">
360 <table class="memname">
362 <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a>& operator= </td>
364 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> & </td>
365 <td class="paramname"></td><td>)</td>
370 <td class="mlabels-right">
371 <span class="mlabels"><span class="mlabel">default</span></span> </td>
374 </div><div class="memdoc">
376 <p>Default copy assignment operator. </p>
380 <a class="anchor" id="a7792915d53fb314715e22f350a174072"></a>
381 <div class="memitem">
382 <div class="memproto">
383 <table class="mlabels">
385 <td class="mlabels-left">
386 <table class="memname">
388 <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a>& operator= </td>
390 <td class="paramtype"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a> && </td>
391 <td class="paramname"></td><td>)</td>
396 <td class="mlabels-right">
397 <span class="mlabels"><span class="mlabel">default</span></span> </td>
400 </div><div class="memdoc">
402 <p>Default move assignment operator. </p>
406 <hr/>The documentation for this class was generated from the following file:<ul>
407 <li>arm_compute/core/GLES_COMPUTE/<a class="el" href="_g_c_kernel_library_8h_source.xhtml">GCKernelLibrary.h</a></li>
409 </div><!-- contents -->
410 </div><!-- doc-content -->
411 <!-- start footer part -->
412 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
414 <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_g_c_program.xhtml">GCProgram</a></li>
415 <li class="footer">Generated on Fri Mar 2 2018 12:37:58 for Compute Library by
416 <a href="http://www.doxygen.org/index.html">
417 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>