struct.cl_image_desc.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `cl_image_desc` struct in crate `cl_sys`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, cl_image_desc">
  9. <title>cl_sys::cl_image_desc - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
  14. <script src="../storage.js"></script>
  15. </head>
  16. <body class="rustdoc struct">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'>Struct cl_image_desc</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.image_type">image_type</a><a href="#structfield.image_width">image_width</a><a href="#structfield.image_height">image_height</a><a href="#structfield.image_depth">image_depth</a><a href="#structfield.image_array_size">image_array_size</a><a href="#structfield.image_row_pitch">image_row_pitch</a><a href="#structfield.image_slice_pitch">image_slice_pitch</a><a href="#structfield.num_mip_levels">num_mip_levels</a><a href="#structfield.num_samples">num_samples</a><a href="#structfield.buffer">buffer</a></div></div><p class='location'><a href='index.html'>cl_sys</a></p><script>window.sidebarCurrent = {name: 'cl_image_desc', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>cl_sys</a>::<wbr><a class="struct" href=''>cl_image_desc</a></span><span class='out-of-band'><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='../src/cl_sys/cl_h.rs.html#97-109' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust struct'><div class="docblock attributes">#[repr(C)]
  51. </div>pub struct cl_image_desc {
  52. pub image_type: <a class="type" href="../cl_sys/type.cl_mem_object_type.html" title="type cl_sys::cl_mem_object_type">cl_mem_object_type</a>,
  53. pub image_width: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a>,
  54. pub image_height: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a>,
  55. pub image_depth: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a>,
  56. pub image_array_size: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a>,
  57. pub image_row_pitch: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a>,
  58. pub image_slice_pitch: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a>,
  59. pub num_mip_levels: <a class="type" href="../cl_sys/type.cl_uint.html" title="type cl_sys::cl_uint">cl_uint</a>,
  60. pub num_samples: <a class="type" href="../cl_sys/type.cl_uint.html" title="type cl_sys::cl_uint">cl_uint</a>,
  61. pub buffer: <a class="type" href="../cl_sys/type.cl_mem.html" title="type cl_sys::cl_mem">cl_mem</a>,
  62. }</pre><h2 id='fields' class='fields small-section-header'>
  63. Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.image_type" class="structfield small-section-header">
  64. <a href="#structfield.image_type" class="anchor field"></a>
  65. <span id="image_type.v" class='invisible'>
  66. <code>image_type: <a class="type" href="../cl_sys/type.cl_mem_object_type.html" title="type cl_sys::cl_mem_object_type">cl_mem_object_type</a></code>
  67. </span></span><span id="structfield.image_width" class="structfield small-section-header">
  68. <a href="#structfield.image_width" class="anchor field"></a>
  69. <span id="image_width.v" class='invisible'>
  70. <code>image_width: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a></code>
  71. </span></span><span id="structfield.image_height" class="structfield small-section-header">
  72. <a href="#structfield.image_height" class="anchor field"></a>
  73. <span id="image_height.v" class='invisible'>
  74. <code>image_height: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a></code>
  75. </span></span><span id="structfield.image_depth" class="structfield small-section-header">
  76. <a href="#structfield.image_depth" class="anchor field"></a>
  77. <span id="image_depth.v" class='invisible'>
  78. <code>image_depth: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a></code>
  79. </span></span><span id="structfield.image_array_size" class="structfield small-section-header">
  80. <a href="#structfield.image_array_size" class="anchor field"></a>
  81. <span id="image_array_size.v" class='invisible'>
  82. <code>image_array_size: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a></code>
  83. </span></span><span id="structfield.image_row_pitch" class="structfield small-section-header">
  84. <a href="#structfield.image_row_pitch" class="anchor field"></a>
  85. <span id="image_row_pitch.v" class='invisible'>
  86. <code>image_row_pitch: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a></code>
  87. </span></span><span id="structfield.image_slice_pitch" class="structfield small-section-header">
  88. <a href="#structfield.image_slice_pitch" class="anchor field"></a>
  89. <span id="image_slice_pitch.v" class='invisible'>
  90. <code>image_slice_pitch: <a class="type" href="../cl_sys/type.size_t.html" title="type cl_sys::size_t">size_t</a></code>
  91. </span></span><span id="structfield.num_mip_levels" class="structfield small-section-header">
  92. <a href="#structfield.num_mip_levels" class="anchor field"></a>
  93. <span id="num_mip_levels.v" class='invisible'>
  94. <code>num_mip_levels: <a class="type" href="../cl_sys/type.cl_uint.html" title="type cl_sys::cl_uint">cl_uint</a></code>
  95. </span></span><span id="structfield.num_samples" class="structfield small-section-header">
  96. <a href="#structfield.num_samples" class="anchor field"></a>
  97. <span id="num_samples.v" class='invisible'>
  98. <code>num_samples: <a class="type" href="../cl_sys/type.cl_uint.html" title="type cl_sys::cl_uint">cl_uint</a></code>
  99. </span></span><span id="structfield.buffer" class="structfield small-section-header">
  100. <a href="#structfield.buffer" class="anchor field"></a>
  101. <span id="buffer.v" class='invisible'>
  102. <code>buffer: <a class="type" href="../cl_sys/type.cl_mem.html" title="type cl_sys::cl_mem">cl_mem</a></code>
  103. </span></span></section>
  104. <section id='search' class="content hidden"></section>
  105. <section class="footer"></section>
  106. <aside id="help" class="hidden">
  107. <div>
  108. <h1 class="hidden">Help</h1>
  109. <div class="shortcuts">
  110. <h2>Keyboard Shortcuts</h2>
  111. <dl>
  112. <dt><kbd>?</kbd></dt>
  113. <dd>Show this help dialog</dd>
  114. <dt><kbd>S</kbd></dt>
  115. <dd>Focus the search field</dd>
  116. <dt><kbd>↑</kbd></dt>
  117. <dd>Move up in search results</dd>
  118. <dt><kbd>↓</kbd></dt>
  119. <dd>Move down in search results</dd>
  120. <dt><kbd>↹</kbd></dt>
  121. <dd>Switch tab</dd>
  122. <dt><kbd>&#9166;</kbd></dt>
  123. <dd>Go to active search result</dd>
  124. <dt><kbd>+</kbd></dt>
  125. <dd>Expand all sections</dd>
  126. <dt><kbd>-</kbd></dt>
  127. <dd>Collapse all sections</dd>
  128. </dl>
  129. </div>
  130. <div class="infos">
  131. <h2>Search Tricks</h2>
  132. <p>
  133. Prefix searches with a type followed by a colon (e.g.
  134. <code>fn:</code>) to restrict the search to a given type.
  135. </p>
  136. <p>
  137. Accepted types are: <code>fn</code>, <code>mod</code>,
  138. <code>struct</code>, <code>enum</code>,
  139. <code>trait</code>, <code>type</code>, <code>macro</code>,
  140. and <code>const</code>.
  141. </p>
  142. <p>
  143. Search functions by type signature (e.g.
  144. <code>vec -> usize</code> or <code>* -> vec</code>)
  145. </p>
  146. </div>
  147. </div>
  148. </aside>
  149. <script>
  150. window.rootPath = "../";
  151. window.currentCrate = "cl_sys";
  152. </script>
  153. <script src="../main.js"></script>
  154. <script defer src="../search-index.js"></script>
  155. </body>
  156. </html>