structGLFWimage.html 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.9.4"/>
  8. <title>GLFW: GLFWimage Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <div class="glfwheader">
  22. <a href="https://www.glfw.org/" id="glfwhome">GLFW</a>
  23. <ul class="glfwnavbar">
  24. <li><a href="https://www.glfw.org/documentation.html">Documentation</a></li>
  25. <li><a href="https://www.glfw.org/download.html">Download</a></li>
  26. <li><a href="https://www.glfw.org/community.html">Community</a></li>
  27. </ul>
  28. </div>
  29. </div>
  30. <!-- end header part -->
  31. <!-- Generated by Doxygen 1.9.4 -->
  32. <script type="text/javascript">
  33. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  34. var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  35. /* @license-end */
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  41. $(function() {
  42. initMenu('',true,false,'search.php','Search');
  43. $(document).ready(function() { init_search(); });
  44. });
  45. /* @license-end */
  46. </script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-attribs">Data Fields</a> </div>
  64. <div class="headertitle"><div class="title">GLFWimage Struct Reference<div class="ingroups"><a class="el" href="group__window.html">Window reference</a></div></div></div>
  65. </div><!--header-->
  66. <div class="contents">
  67. <p>Image data.
  68. <a href="structGLFWimage.html#details">More...</a></p>
  69. <p><code>#include &lt;<a class="el" href="glfw3_8h_source.html">glfw3.h</a>&gt;</code></p>
  70. <table class="memberdecls">
  71. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  72. Data Fields</h2></td></tr>
  73. <tr class="memitem:af6a71cc999fe6d3aea31dd7e9687d835"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGLFWimage.html#af6a71cc999fe6d3aea31dd7e9687d835">width</a></td></tr>
  74. <tr class="separator:af6a71cc999fe6d3aea31dd7e9687d835"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a0b7d95368f0c80d5e5c9875057c7dbec"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGLFWimage.html#a0b7d95368f0c80d5e5c9875057c7dbec">height</a></td></tr>
  76. <tr class="separator:a0b7d95368f0c80d5e5c9875057c7dbec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a0c532a5c2bb715555279b7817daba0fb"><td class="memItemLeft" align="right" valign="top">unsigned char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGLFWimage.html#a0c532a5c2bb715555279b7817daba0fb">pixels</a></td></tr>
  78. <tr class="separator:a0c532a5c2bb715555279b7817daba0fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. </table>
  80. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  81. <div class="textblock"><p >This describes a single 2D image. See the documentation for each related function what the expected pixel format is.</p>
  82. <dl class="section see"><dt>See also</dt><dd><a class="el" href="input_guide.html#cursor_custom">Custom cursor creation</a> </dd>
  83. <dd>
  84. <a class="el" href="window_guide.html#window_icon">Window icon</a></dd></dl>
  85. <dl class="section since"><dt>Since</dt><dd>Added in version 2.1. <b>GLFW 3:</b> Removed format and bytes-per-pixel members. </dd></dl>
  86. </div><h2 class="groupheader">Field Documentation</h2>
  87. <a id="af6a71cc999fe6d3aea31dd7e9687d835" name="af6a71cc999fe6d3aea31dd7e9687d835"></a>
  88. <h2 class="memtitle"><span class="permalink"><a href="#af6a71cc999fe6d3aea31dd7e9687d835">&#9670;&nbsp;</a></span>width</h2>
  89. <div class="memitem">
  90. <div class="memproto">
  91. <table class="memname">
  92. <tr>
  93. <td class="memname">int GLFWimage::width</td>
  94. </tr>
  95. </table>
  96. </div><div class="memdoc">
  97. <p >The width, in pixels, of this image. </p>
  98. </div>
  99. </div>
  100. <a id="a0b7d95368f0c80d5e5c9875057c7dbec" name="a0b7d95368f0c80d5e5c9875057c7dbec"></a>
  101. <h2 class="memtitle"><span class="permalink"><a href="#a0b7d95368f0c80d5e5c9875057c7dbec">&#9670;&nbsp;</a></span>height</h2>
  102. <div class="memitem">
  103. <div class="memproto">
  104. <table class="memname">
  105. <tr>
  106. <td class="memname">int GLFWimage::height</td>
  107. </tr>
  108. </table>
  109. </div><div class="memdoc">
  110. <p >The height, in pixels, of this image. </p>
  111. </div>
  112. </div>
  113. <a id="a0c532a5c2bb715555279b7817daba0fb" name="a0c532a5c2bb715555279b7817daba0fb"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#a0c532a5c2bb715555279b7817daba0fb">&#9670;&nbsp;</a></span>pixels</h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">unsigned char* GLFWimage::pixels</td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. <p >The pixel data of this image, arranged left-to-right, top-to-bottom. </p>
  124. </div>
  125. </div>
  126. <hr/>The documentation for this struct was generated from the following file:<ul>
  127. <li><a class="el" href="glfw3_8h_source.html">glfw3.h</a></li>
  128. </ul>
  129. </div><!-- contents -->
  130. <address class="footer">
  131. <p>
  132. Last update on Fri Jul 22 2022 for GLFW 3.3.8
  133. </p>
  134. </address>
  135. </body>
  136. </html>