<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="Source to the Rust file `/Users/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/cl-sys-0.4.1/src/cl_gl_h.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>cl_gl_h.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
</pre><pre class="rust ">
<span class="doccomment">//! OpenGL Extensions.</span>
<span class="attribute">#![<span class="ident">allow</span>(<span class="ident">non_camel_case_types</span>, <span class="ident">dead_code</span>, <span class="ident">unused_variables</span>, <span class="ident">improper_ctypes</span>, <span class="ident">non_upper_case_globals</span>)]</span>
<span class="kw">use</span> <span class="ident">libc</span>::{<span class="ident">c_void</span>, <span class="ident">size_t</span>};
<span class="kw">use</span> <span class="ident">cl_h</span>::{<span class="ident">cl_context_properties</span>, <span class="ident">cl_int</span>, <span class="ident">cl_uint</span>};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">"opencl_vendor_mesa"</span>))]</span>
<span class="kw">use</span> <span class="ident">platform_h</span>::{<span class="ident">cl_GLuint</span>, <span class="ident">cl_GLint</span>, <span class="ident">cl_GLenum</span>};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">"opencl_vendor_mesa"</span>))]</span>
<span class="kw">use</span> <span class="ident">cl_h</span>::{<span class="ident">cl_context</span>, <span class="ident">cl_mem_flags</span>, <span class="ident">cl_mem</span>, <span class="ident">cl_command_queue</span>, <span class="ident">cl_event</span>};
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">cl_gl_object_type</span> <span class="op">=</span> <span class="ident">cl_uint</span>;
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">cl_gl_texture_info</span> <span class="op">=</span> <span class="ident">cl_uint</span>;
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">cl_gl_platform_info</span> <span class="op">=</span> <span class="ident">cl_uint</span>;
<span class="comment">// typedef struct __GLsync *cl_GLsync;</span>
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">cl_gl_context_info</span> <span class="op">=</span> <span class="ident">cl_uint</span>;
<span class="comment">// cl_gl_object_type = 0x2000 - 0x200F enum values are currently taken</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_OBJECT_BUFFER</span>: <span class="ident">cl_gl_object_type</span> <span class="op">=</span> <span class="number">0x2000</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_OBJECT_TEXTURE2D</span>: <span class="ident">cl_gl_object_type</span> <span class="op">=</span> <span class="number">0x2001</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_OBJECT_TEXTURE3D</span>: <span class="ident">cl_gl_object_type</span> <span class="op">=</span> <span class="number">0x2002</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_OBJECT_RENDERBUFFER</span>: <span class="ident">cl_gl_object_type</span> <span class="op">=</span> <span class="number">0x2003</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_OBJECT_TEXTURE2D_ARRAY</span>: <span class="ident">cl_gl_object_type</span> <span class="op">=</span> <span class="number">0x200E</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_OBJECT_TEXTURE1D</span>: <span class="ident">cl_gl_object_type</span> <span class="op">=</span> <span class="number">0x200F</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_OBJECT_TEXTURE1D_ARRAY</span>: <span class="ident">cl_gl_object_type</span> <span class="op">=</span> <span class="number">0x2010</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_OBJECT_TEXTURE_BUFFER</span>: <span class="ident">cl_gl_object_type</span> <span class="op">=</span> <span class="number">0x2011</span>;
<span class="comment">// cl_gl_texture_info</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_TEXTURE_TARGET</span>: <span class="ident">cl_gl_texture_info</span> <span class="op">=</span> <span class="number">0x2004</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_MIPMAP_LEVEL</span>: <span class="ident">cl_gl_texture_info</span> <span class="op">=</span> <span class="number">0x2005</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_NUM_SAMPLES</span>: <span class="ident">cl_gl_texture_info</span> <span class="op">=</span> <span class="number">0x2012</span>;
<span class="comment">// cl_khr_gl_sharing extension</span>
<span class="comment">// * NOTE: Originally lower case: `cl_kgr_gl_sharing`</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_KHR_GL_SHARING</span>: <span class="ident">cl_int</span> <span class="op">=</span> <span class="number">1</span>;
<span class="comment">// Additional Error Codes</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_INVALID_GL_SHAREGROUP_REFERENCE_KHR</span>: <span class="ident">cl_int</span> <span class="op">=</span> <span class="op">-</span><span class="number">1000</span>;
<span class="comment">// cl_gl_context_info</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_CURRENT_DEVICE_FOR_GL_CONTEXT_KHR</span>: <span class="ident">cl_gl_context_info</span> <span class="op">=</span> <span class="number">0x2006</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_DEVICES_FOR_GL_CONTEXT_KHR</span>: <span class="ident">cl_gl_context_info</span> <span class="op">=</span> <span class="number">0x2007</span>;
<span class="comment">// Additional cl_context_properties</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GL_CONTEXT_KHR</span>: <span class="ident">cl_context_properties</span> <span class="op">=</span> <span class="number">0x2008</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_EGL_DISPLAY_KHR</span>: <span class="ident">cl_context_properties</span> <span class="op">=</span> <span class="number">0x2009</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_GLX_DISPLAY_KHR</span>: <span class="ident">cl_context_properties</span> <span class="op">=</span> <span class="number">0x200A</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_WGL_HDC_KHR</span>: <span class="ident">cl_context_properties</span> <span class="op">=</span> <span class="number">0x200B</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CL_CGL_SHAREGROUP_KHR</span>: <span class="ident">cl_context_properties</span> <span class="op">=</span> <span class="number">0x200C</span>;
<span class="comment">// typedef CL_API_ENTRY cl_int (CL_API_CALL *clGetGLContextInfoKHR_fn)(</span>
<span class="comment">// const cl_context_properties * properties,</span>
<span class="comment">// cl_gl_context_info param_name,</span>
<span class="comment">// size_t param_value_size,</span>
<span class="comment">// void * param_value,</span>
<span class="comment">// size_t * param_value_size_ret);</span>
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">clGetGLContextInfoKHR_fn</span> <span class="op">=</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="kw">extern</span> <span class="string">"system"</span> <span class="kw">fn</span>(
<span class="ident">properties</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">cl_context_properties</span>,
<span class="ident">param_name</span>: <span class="ident">cl_gl_context_info</span>,
<span class="ident">param_value_size</span>: <span class="ident">size_t</span>,
<span class="ident">param_value</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_void</span>,
<span class="ident">param_value_size_ret</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">size_t</span>)
<span class="op">-></span> <span class="ident">cl_int</span>;
<span class="comment">//#[link_args = "-L$OPENCL_LIB -lOpenCL"]</span>
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, <span class="ident">link</span>(<span class="ident">name</span> <span class="op">=</span> <span class="string">"OpenCL"</span>, <span class="ident">kind</span> <span class="op">=</span> <span class="string">"framework"</span>))]</span>
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"windows"</span>, <span class="ident">link</span>(<span class="ident">name</span> <span class="op">=</span> <span class="string">"OpenCL"</span>))]</span>
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>), <span class="ident">link</span>(<span class="ident">name</span> <span class="op">=</span> <span class="string">"OpenCL"</span>))]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">"opencl_vendor_mesa"</span>))]</span> <span class="comment">// Mesa does not support context sharing with OpenGL.</span>
<span class="kw">extern</span> <span class="string">"system"</span> {
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clCreateFromGLBuffer</span>(<span class="ident">context</span>: <span class="ident">cl_context</span>,
<span class="ident">flags</span>: <span class="ident">cl_mem_flags</span>,
<span class="ident">bufobj</span>: <span class="ident">cl_GLuint</span>,
<span class="ident">errcode_ret</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">cl_int</span>) <span class="op">-></span> <span class="ident">cl_mem</span>;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clCreateFromGLTexture</span>(<span class="ident">context</span>: <span class="ident">cl_context</span>,
<span class="ident">flags</span>: <span class="ident">cl_mem_flags</span>,
<span class="ident">texture_target</span>: <span class="ident">cl_GLenum</span>,
<span class="ident">miplevel</span>: <span class="ident">cl_GLint</span>,
<span class="ident">texture</span>: <span class="ident">cl_GLuint</span>,
<span class="ident">errcode_ret</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">cl_int</span>) <span class="op">-></span> <span class="ident">cl_mem</span>;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clGetGLObjectInfo</span>(<span class="ident">memobj</span>: <span class="ident">cl_mem</span>,
<span class="ident">gl_object_type</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">cl_gl_object_type</span>,
<span class="ident">gl_object_name</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">cl_GLuint</span>) <span class="op">-></span> <span class="ident">cl_int</span>;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clGetGLTextureInfo</span>(<span class="ident">memobj</span>: <span class="ident">cl_mem</span>,
<span class="ident">param_name</span>: <span class="ident">cl_gl_texture_info</span>,
<span class="ident">param_value_size</span>: <span class="ident">size_t</span>,
<span class="ident">param_value</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_void</span>,
<span class="ident">param_value_size_ret</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">size_t</span>) <span class="op">-></span> <span class="ident">cl_int</span>;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clCreateFromGLRenderbuffer</span>(<span class="ident">context</span>: <span class="ident">cl_context</span>,
<span class="ident">flags</span>: <span class="ident">cl_mem_flags</span>,
<span class="ident">renderbuffer</span>: <span class="ident">cl_GLuint</span>,
<span class="ident">errcode_ret</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">cl_int</span>) <span class="op">-></span> <span class="ident">cl_mem</span>;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clEnqueueAcquireGLObjects</span>(<span class="ident">command_queue</span>: <span class="ident">cl_command_queue</span>,
<span class="ident">num_objects</span>: <span class="ident">cl_uint</span>,
<span class="ident">mem_objects</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">cl_mem</span>,
<span class="ident">num_events_in_wait_list</span>: <span class="ident">cl_uint</span>,
<span class="ident">event_wait_list</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">cl_event</span>,
<span class="ident">event</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">cl_event</span>) <span class="op">-></span> <span class="ident">cl_int</span>;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clEnqueueReleaseGLObjects</span>(<span class="ident">command_queue</span>: <span class="ident">cl_command_queue</span>,
<span class="ident">num_objects</span>: <span class="ident">cl_uint</span>,
<span class="ident">mem_objects</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">cl_mem</span>,
<span class="ident">num_events_in_wait_list</span>: <span class="ident">cl_uint</span>,
<span class="ident">event_wait_list</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">cl_event</span>,
<span class="ident">event</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">cl_event</span>) <span class="op">-></span> <span class="ident">cl_int</span>;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clGetGLContextInfoKHR</span>(<span class="ident">properties</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">cl_context_properties</span>,
<span class="ident">param_name</span>: <span class="ident">cl_gl_context_info</span>,
<span class="ident">param_value_size</span>: <span class="ident">size_t</span>,
<span class="ident">param_value</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_void</span>,
<span class="ident">param_value_size_ret</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">size_t</span>) <span class="op">-></span> <span class="ident">cl_int</span>;
<span class="comment">// Deprecated OpenCL 1.1 APIs</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clCreateFromGLTexture2D</span>(<span class="ident">context</span>: <span class="ident">cl_context</span>,
<span class="ident">flags</span>: <span class="ident">cl_mem_flags</span>,
<span class="ident">texture_target</span>: <span class="ident">cl_GLenum</span>,
<span class="ident">miplevel</span>: <span class="ident">cl_GLint</span>,
<span class="ident">texture</span>: <span class="ident">cl_GLuint</span>,
<span class="ident">errcode_ret</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">cl_int</span>) <span class="op">-></span> <span class="ident">cl_mem</span>;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clCreateFromGLTexture3D</span>(<span class="ident">context</span>: <span class="ident">cl_context</span>,
<span class="ident">flags</span>: <span class="ident">cl_mem_flags</span>,
<span class="ident">texture_target</span>: <span class="ident">cl_GLenum</span>,
<span class="ident">miplevel</span>: <span class="ident">cl_GLint</span>,
<span class="ident">texture</span>: <span class="ident">cl_GLuint</span>,
<span class="ident">errcode_ret</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">cl_int</span>) <span class="op">-></span> <span class="ident">cl_mem</span>;
}</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "cl_sys";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>