Path: blob/master/Resources/taoframework-2.1.0/bin/Tao.Glfw.xml
178 views
<?xml version="1.0"?>1<doc>2<assembly>3<name>Tao.Glfw</name>4</assembly>5<members>6<member name="T:Tao.Glfw.Glfw">7<summary>8GLFW (OpenGL Framework) binding for .NET, implementing GLFW 2.6.0.9</summary>10<remarks>11<para>12Marcus Geelnard is the author of GLFW, more information can be found on the13GLFW homepage, http://glfw.sourceforge.net.14</para>15<para>16GLFW is a portable API (Application Program Interface) that handles operating17system specific tasks related to OpenGL programming. While OpenGL in general18is portable, easy to use and often results in tidy and compact code, the19operating system specific mechanisms that are required to set up and manage an20OpenGL window are quite the opposite. GLFW tries to remedy this by providing21the following functionality:22</para>23<para>24<list type="bullet">25<item>Opening and managing an OpenGL window.</item>26<item>Keyboard, mouse and joystick input.</item>27<item>A high precision timer.</item>28<item>Multi threading support.</item>29<item>Support for querying and using OpenGL extensions.</item>30<item>Image file loading support.</item>31</list>32</para>33<para>34All this functionality is implemented as a set of easy-to-use functions, which35makes it possible to write an OpenGL application framework in just a few lines36of code. The GLFW API is completely operating system and platform independent,37which makes it very simple to port GLFW based OpenGL applications to a variety38of platforms. Currently supported platforms are:39</para>40<para>41<list type="bullet">42<item>Microsoft Windows 95/98/ME/NT/2000/XP/2003 Server.</item>43<item>44Unix or Unix-like systems running the X Window System, e.g. Linux,45IRIX, FreeBSD, Solaris, QNX, and Mac OSX.46</item>47<item>48Mac OSX (Carbon), only a subset of GLFW is available at this time.49</item>50<item>51AmigaOS, only a subset of GLFW is available at this time.52</item>53</list>54</para>55</remarks>56</member>57<member name="F:Tao.Glfw.Glfw.GLFW_NATIVE_LIBRARY">58<summary>59Specifies the GLFW native library used in the bindings60</summary>61<remarks>62The Windows dll is specified here universally - note that63under Mono the non-windows native library can be mapped using64the ".config" file mechanism. Kudos to the Mono team for this65simple yet elegant solution.66</remarks>67</member>68<member name="F:Tao.Glfw.Glfw.GLFW_VERSION_MAJOR">69<summary>70Major version number.71</summary>72</member>73<member name="F:Tao.Glfw.Glfw.GLFW_VERSION_MINOR">74<summary>75Minor version number.76</summary>77</member>78<member name="F:Tao.Glfw.Glfw.GLFW_VERSION_REVISION">79<summary>80Revision version number.81</summary>82</member>83<member name="F:Tao.Glfw.Glfw.GLFW_RELEASE">84<summary>85Button or key is not pressed.86</summary>87</member>88<member name="F:Tao.Glfw.Glfw.GLFW_PRESS">89<summary>90Button or key is pressed.91</summary>92</member>93<member name="F:Tao.Glfw.Glfw.GLFW_KEY_UNKNOWN">94<summary>95Unknown key.96</summary>97</member>98<member name="F:Tao.Glfw.Glfw.GLFW_KEY_SPACE">99<summary>100Space bar.101</summary>102</member>103<member name="F:Tao.Glfw.Glfw.GLFW_KEY_SPECIAL">104<summary>105Delineates start of 'special' keys.106</summary>107</member>108<member name="F:Tao.Glfw.Glfw.GLFW_KEY_ESC">109<summary>110Escape.111</summary>112</member>113<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F1">114<summary>115Function key 1.116</summary>117</member>118<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F2">119<summary>120Function key 2.121</summary>122</member>123<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F3">124<summary>125Function key 3.126</summary>127</member>128<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F4">129<summary>130Function key 4.131</summary>132</member>133<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F5">134<summary>135Function key 5.136</summary>137</member>138<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F6">139<summary>140Function key 6.141</summary>142</member>143<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F7">144<summary>145Function key 7.146</summary>147</member>148<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F8">149<summary>150Function key 8.151</summary>152</member>153<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F9">154<summary>155Function key 9.156</summary>157</member>158<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F10">159<summary>160Function key 10.161</summary>162</member>163<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F11">164<summary>165Function key 11.166</summary>167</member>168<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F12">169<summary>170Function key 12.171</summary>172</member>173<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F13">174<summary>175Function key 13.176</summary>177</member>178<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F14">179<summary>180Function key 14.181</summary>182</member>183<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F15">184<summary>185Function key 15.186</summary>187</member>188<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F16">189<summary>190Function key 16.191</summary>192</member>193<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F17">194<summary>195Function key 17.196</summary>197</member>198<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F18">199<summary>200Function key 18.201</summary>202</member>203<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F19">204<summary>205Function key 19.206</summary>207</member>208<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F20">209<summary>210Function key 20.211</summary>212</member>213<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F21">214<summary>215Function key 21.216</summary>217</member>218<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F22">219<summary>220Function key 22.221</summary>222</member>223<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F23">224<summary>225Function key 23.226</summary>227</member>228<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F24">229<summary>230Function key 24.231</summary>232</member>233<member name="F:Tao.Glfw.Glfw.GLFW_KEY_F25">234<summary>235Function key 25.236</summary>237</member>238<member name="F:Tao.Glfw.Glfw.GLFW_KEY_UP">239<summary>240Cursor up.241</summary>242</member>243<member name="F:Tao.Glfw.Glfw.GLFW_KEY_DOWN">244<summary>245Cursor down.246</summary>247</member>248<member name="F:Tao.Glfw.Glfw.GLFW_KEY_LEFT">249<summary>250Cursor left.251</summary>252</member>253<member name="F:Tao.Glfw.Glfw.GLFW_KEY_RIGHT">254<summary>255Cursor right.256</summary>257</member>258<member name="F:Tao.Glfw.Glfw.GLFW_KEY_LSHIFT">259<summary>260Left shift key.261</summary>262</member>263<member name="F:Tao.Glfw.Glfw.GLFW_KEY_RSHIFT">264<summary>265Right shift key.266</summary>267</member>268<member name="F:Tao.Glfw.Glfw.GLFW_KEY_LCTRL">269<summary>270Left control key.271</summary>272</member>273<member name="F:Tao.Glfw.Glfw.GLFW_KEY_RCTRL">274<summary>275Right control key.276</summary>277</member>278<member name="F:Tao.Glfw.Glfw.GLFW_KEY_LALT">279<summary>280Left alternate function key.281</summary>282</member>283<member name="F:Tao.Glfw.Glfw.GLFW_KEY_RALT">284<summary>285Right alternate function key.286</summary>287</member>288<member name="F:Tao.Glfw.Glfw.GLFW_KEY_TAB">289<summary>290Tabulator.291</summary>292</member>293<member name="F:Tao.Glfw.Glfw.GLFW_KEY_ENTER">294<summary>295Enter.296</summary>297</member>298<member name="F:Tao.Glfw.Glfw.GLFW_KEY_BACKSPACE">299<summary>300Backspace.301</summary>302</member>303<member name="F:Tao.Glfw.Glfw.GLFW_KEY_INSERT">304<summary>305Insert.306</summary>307</member>308<member name="F:Tao.Glfw.Glfw.GLFW_KEY_DEL">309<summary>310Delete.311</summary>312</member>313<member name="F:Tao.Glfw.Glfw.GLFW_KEY_PAGEUP">314<summary>315Page up.316</summary>317</member>318<member name="F:Tao.Glfw.Glfw.GLFW_KEY_PAGEDOWN">319<summary>320Page down.321</summary>322</member>323<member name="F:Tao.Glfw.Glfw.GLFW_KEY_HOME">324<summary>325Home.326</summary>327</member>328<member name="F:Tao.Glfw.Glfw.GLFW_KEY_END">329<summary>330End.331</summary>332</member>333<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_0">334<summary>335Keypad numeric key 0.336</summary>337</member>338<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_1">339<summary>340Keypad numeric key 1.341</summary>342</member>343<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_2">344<summary>345Keypad numeric key 2.346</summary>347</member>348<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_3">349<summary>350Keypad numeric key 3.351</summary>352</member>353<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_4">354<summary>355Keypad numeric key 4.356</summary>357</member>358<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_5">359<summary>360Keypad numeric key 5.361</summary>362</member>363<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_6">364<summary>365Keypad numeric key 6.366</summary>367</member>368<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_7">369<summary>370Keypad numeric key 7.371</summary>372</member>373<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_8">374<summary>375Keypad numeric key 8.376</summary>377</member>378<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_9">379<summary>380Keypad numeric key 9.381</summary>382</member>383<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_DIVIDE">384<summary>385Keypad divide.386</summary>387</member>388<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_MULTIPLY">389<summary>390Keypad multiply.391</summary>392</member>393<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_SUBTRACT">394<summary>395Keypad subtract.396</summary>397</member>398<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_ADD">399<summary>400Keypad add.401</summary>402</member>403<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_DECIMAL">404<summary>405Keypad decimal.406</summary>407</member>408<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_EQUAL">409<summary>410Keypad equal.411</summary>412</member>413<member name="F:Tao.Glfw.Glfw.GLFW_KEY_KP_ENTER">414<summary>415Keypad enter.416</summary>417</member>418<member name="F:Tao.Glfw.Glfw.GLFW_KEY_LAST">419<summary>420Delinates end of 'special' keys.421</summary>422</member>423<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_1">424<summary>425Mouse identifier 1.426</summary>427</member>428<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_2">429<summary>430Mouse identifier 2.431</summary>432</member>433<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_3">434<summary>435Mouse identifier 3.436</summary>437</member>438<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_4">439<summary>440Mouse identifier 4.441</summary>442</member>443<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_5">444<summary>445Mouse identifier 5.446</summary>447</member>448<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_6">449<summary>450Mouse identifier 6.451</summary>452</member>453<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_7">454<summary>455Mouse identifier 7.456</summary>457</member>458<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_8">459<summary>460Mouse identifier 8.461</summary>462</member>463<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_LEFT">464<summary>465Left mouse button.466</summary>467</member>468<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_RIGHT">469<summary>470Right mouse button.471</summary>472</member>473<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_MIDDLE">474<summary>475Middle mouse button.476</summary>477</member>478<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_BUTTON_LAST">479<summary>480Delineates the last mouse button.481</summary>482</member>483<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_1">484<summary>485Joystick identifier 1.486</summary>487</member>488<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_2">489<summary>490Joystick identifier 2.491</summary>492</member>493<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_3">494<summary>495Joystick identifier 3.496</summary>497</member>498<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_4">499<summary>500Joystick identifier 4.501</summary>502</member>503<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_5">504<summary>505Joystick identifier 5.506</summary>507</member>508<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_6">509<summary>510Joystick identifier 6.511</summary>512</member>513<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_7">514<summary>515Joystick identifier 7.516</summary>517</member>518<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_8">519<summary>520Joystick identifier 8.521</summary>522</member>523<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_9">524<summary>525Joystick identifier 9.526</summary>527</member>528<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_10">529<summary>530Joystick identifier 10.531</summary>532</member>533<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_11">534<summary>535Joystick identifier 11.536</summary>537</member>538<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_12">539<summary>540Joystick identifier 12.541</summary>542</member>543<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_13">544<summary>545Joystick identifier 13.546</summary>547</member>548<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_14">549<summary>550Joystick identifier 14.551</summary>552</member>553<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_15">554<summary>555Joystick identifier 15.556</summary>557</member>558<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_16">559<summary>560Joystick identifier 16.561</summary>562</member>563<member name="F:Tao.Glfw.Glfw.GLFW_JOYSTICK_LAST">564<summary>565Delineates the last joystick identifier.566</summary>567</member>568<member name="F:Tao.Glfw.Glfw.GLFW_WINDOW">569<summary>570Normal desktop window.571</summary>572</member>573<member name="F:Tao.Glfw.Glfw.GLFW_FULLSCREEN">574<summary>575Fullscreen window.576</summary>577</member>578<member name="F:Tao.Glfw.Glfw.GLFW_OPENED">579<summary>580<see cref="F:Tao.OpenGl.Gl.GL_TRUE"/> if window is opened, else <see cref="F:Tao.OpenGl.Gl.GL_FALSE"/>.581</summary>582</member>583<member name="F:Tao.Glfw.Glfw.GLFW_ACTIVE">584<summary>585<see cref="F:Tao.OpenGl.Gl.GL_TRUE"/> if window has focus, else <see cref="F:Tao.OpenGl.Gl.GL_FALSE"/>.586</summary>587</member>588<member name="F:Tao.Glfw.Glfw.GLFW_ICONIFIED">589<summary>590<see cref="F:Tao.OpenGl.Gl.GL_TRUE"/> if window is iconified, else <see cref="F:Tao.OpenGl.Gl.GL_FALSE"/>.591</summary>592</member>593<member name="F:Tao.Glfw.Glfw.GLFW_ACCELERATED">594<summary>595<see cref="F:Tao.OpenGl.Gl.GL_TRUE"/> if window is hardware accelerated, else596<see cref="F:Tao.OpenGl.Gl.GL_FALSE"/>.597</summary>598</member>599<member name="F:Tao.Glfw.Glfw.GLFW_RED_BITS">600<summary>601Number of bits for the red color component.602</summary>603</member>604<member name="F:Tao.Glfw.Glfw.GLFW_GREEN_BITS">605<summary>606Number of bits for the green color component.607</summary>608</member>609<member name="F:Tao.Glfw.Glfw.GLFW_BLUE_BITS">610<summary>611Number of bits for the blue color component.612</summary>613</member>614<member name="F:Tao.Glfw.Glfw.GLFW_ALPHA_BITS">615<summary>616Number of bits for the alpha buffer.617</summary>618</member>619<member name="F:Tao.Glfw.Glfw.GLFW_DEPTH_BITS">620<summary>621Number of bits for the depth buffer.622</summary>623</member>624<member name="F:Tao.Glfw.Glfw.GLFW_STENCIL_BITS">625<summary>626Number of bits for the stencil buffer.627</summary>628</member>629<member name="F:Tao.Glfw.Glfw.GLFW_REFRESH_RATE">630<summary>631Vertical monitor refresh rate in Hz (only used for fullscreen windows). Zero632means system default.633</summary>634</member>635<member name="F:Tao.Glfw.Glfw.GLFW_ACCUM_RED_BITS">636<summary>637Number of bits for the red channel of the accumulator buffer.638</summary>639</member>640<member name="F:Tao.Glfw.Glfw.GLFW_ACCUM_GREEN_BITS">641<summary>642Number of bits for the green channel of the accumulator buffer.643</summary>644</member>645<member name="F:Tao.Glfw.Glfw.GLFW_ACCUM_BLUE_BITS">646<summary>647Number of bits for the blue channel of the accumulator buffer.648</summary>649</member>650<member name="F:Tao.Glfw.Glfw.GLFW_ACCUM_ALPHA_BITS">651<summary>652Number of bits for the alpha channel of the accumulator buffer.653</summary>654</member>655<member name="F:Tao.Glfw.Glfw.GLFW_AUX_BUFFERS">656<summary>657Number of auxiliary buffers.658</summary>659</member>660<member name="F:Tao.Glfw.Glfw.GLFW_STEREO">661<summary>662Specify if stereo rendering should be supported (can be <see cref="F:Tao.OpenGl.Gl.GL_TRUE"/>663or <see cref="F:Tao.OpenGl.Gl.GL_FALSE"/>).664</summary>665</member>666<member name="F:Tao.Glfw.Glfw.GLFW_WINDOW_NO_RESIZE">667<summary>668Specify whether the window can be resized (can be <see cref="F:Tao.OpenGl.Gl.GL_TRUE"/>669or <see cref="F:Tao.OpenGl.Gl.GL_FALSE"/>).670</summary>671</member>672<member name="F:Tao.Glfw.Glfw.GLFW_FSAA_SAMPLES">673<summary>674Specify if full screen antialiasing should be supported. Zero disabless multisampling, greater675values define the number of samples.676</summary>677</member>678<member name="F:Tao.Glfw.Glfw.GLFW_MOUSE_CURSOR">679<summary>680Mouse cursor visibility.681</summary>682</member>683<member name="F:Tao.Glfw.Glfw.GLFW_STICKY_KEYS">684<summary>685Keyboard key “stickiness".686</summary>687</member>688<member name="F:Tao.Glfw.Glfw.GLFW_STICKY_MOUSE_BUTTONS">689<summary>690Mouse button “stickiness”.691</summary>692</member>693<member name="F:Tao.Glfw.Glfw.GLFW_SYSTEM_KEYS">694<summary>695Special system key actions.696</summary>697</member>698<member name="F:Tao.Glfw.Glfw.GLFW_KEY_REPEAT">699<summary>700Keyboard key repeat.701</summary>702</member>703<member name="F:Tao.Glfw.Glfw.GLFW_AUTO_POLL_EVENTS">704<summary>705Automatic event polling when <see cref="M:Tao.Glfw.Glfw.glfwSwapBuffers"/> is called.706</summary>707</member>708<member name="F:Tao.Glfw.Glfw.GLFW_WAIT">709<summary>710Waiting.711</summary>712</member>713<member name="F:Tao.Glfw.Glfw.GLFW_NOWAIT">714<summary>715No waiting.716</summary>717</member>718<member name="F:Tao.Glfw.Glfw.GLFW_PRESENT">719<summary>720<see cref="F:Tao.OpenGl.Gl.GL_TRUE"/> if the joystick is connected, else721<see cref="F:Tao.OpenGl.Gl.GL_FALSE"/>.722</summary>723</member>724<member name="F:Tao.Glfw.Glfw.GLFW_AXES">725<summary>726Number of axes supported by the joystick.727</summary>728</member>729<member name="F:Tao.Glfw.Glfw.GLFW_BUTTONS">730<summary>731Number of buttons supported by the joystick.732</summary>733</member>734<member name="F:Tao.Glfw.Glfw.GLFW_NO_RESCALE_BIT">735<summary>736Do not rescale image to closest 2^m * 2^n resolution.737</summary>738</member>739<member name="F:Tao.Glfw.Glfw.GLFW_ORIGIN_UL_BIT">740<summary>741Specifies that the origin of the loaded image should be in the upper left corner742(default is the lower left corner).743</summary>744</member>745<member name="F:Tao.Glfw.Glfw.GLFW_BUILD_MIPMAPS_BIT">746<summary>747Automatically build and upload all mipmap levels.748</summary>749</member>750<member name="F:Tao.Glfw.Glfw.GLFW_ALPHA_MAP_BIT">751<summary>752Single component alpha maps.753</summary>754</member>755<member name="F:Tao.Glfw.Glfw.GLFW_INFINITY">756<summary>757Infinite amount of time.758</summary>759</member>760<member name="M:Tao.Glfw.Glfw.glfwInit">761<summary>762Initializes GLFW.763</summary>764<returns>765On success <see cref="F:Tao.OpenGl.Gl.GL_TRUE"/> is returned; otherwise <see cref="F:Tao.OpenGl.Gl.GL_FALSE"/>.766</returns>767<remarks>768<para>769No other GLFW functions may be used before this function has been called.770</para>771<para>772This function may take several seconds to complete on some systems, while773on other systems it may take only a fraction of a second to complete.774</para>775</remarks>776</member>777<member name="M:Tao.Glfw.Glfw.glfwTerminate">778<summary>779Terminates GLFW.780</summary>781<remarks>782Among other things it closes the window, if it is opened, and kills any running783threads. This function must be called before a program exits.784</remarks>785</member>786<member name="M:Tao.Glfw.Glfw.glfwGetVersion(System.Int32@,System.Int32@,System.Int32@)">787<summary>788Returns the GLFW library version.789</summary>790<param name="major">791Pointer to an integer that will hold the major version number.792</param>793<param name="minor">794Pointer to an integer that will hold the minor version number.795</param>796<param name="revision">797Pointer to an integer that will hold the revision.798</param>799</member>800<member name="M:Tao.Glfw.Glfw.glfwOpenWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">801<summary>802Opens a window that best matches the parameters given to the function.803</summary>804<param name="width">805The width of the window. If <paramref name="width"/> is zero, it will be806calculated as width = <c>(4 / 3) * height</c>, if <paramref name="height"/> is807not zero. If both <paramref name="width"/> and <paramref name="height"/> are808zero, then <paramref name="width"/> will be set to 640.809</param>810<param name="height">811The height of the window. If <paramref name="height"/> is zero, it will be812calculated as <c>height = (3 / 4) * width</c>, if <paramref name="width"/> is813not zero. If both <paramref name="width"/> and <paramref name="height"/> are814zero, then <paramref name="height"/> will be set to 480.815</param>816<param name="redBits">817The number of bits to use for the red color component of the color buffer818(0 means default color depth). For instance, setting redbits = 5, greenbits = 6,819and bluebits = 5 will generate a 16-bit color buffer, if possible.820</param>821<param name="greenBits">822The number of bits to use for the green color component of the color buffer823(0 means default color depth). For instance, setting redbits = 5, greenbits = 6,824and bluebits = 5 will generate a 16-bit color buffer, if possible.825</param>826<param name="blueBits">827The number of bits to use for the blue color component of the color buffer828(0 means default color depth). For instance, setting redbits = 5, greenbits = 6,829and bluebits = 5 will generate a 16-bit color buffer, if possible.830</param>831<param name="alphaBits">832The number of bits to use for the alpha buffer (0 means no alpha buffer).833</param>834<param name="depthBits">835The number of bits to use for the depth buffer (0 means no depth buffer).836</param>837<param name="stencilBits">838The number of bits to use for the stencil buffer (0 means no stencil buffer).839</param>840<param name="mode">841Selects which type of OpenGL window to use. mode can be either842<see cref="F:Tao.Glfw.Glfw.GLFW_WINDOW"/>, which will generate a normal desktop window, or843<see cref="F:Tao.Glfw.Glfw.GLFW_FULLSCREEN"/>, which will generate a window which covers the844entire screen. When <see cref="F:Tao.Glfw.Glfw.GLFW_FULLSCREEN"/> is selected, the video mode845will be changed to the resolution that closest matches the846<paramref name="width"/> and <paramref name="height"/> parameters.847</param>848<returns>849On success <see cref="F:Tao.OpenGl.Gl.GL_TRUE"/> is returned; otherwise <see cref="F:Tao.OpenGl.Gl.GL_FALSE"/>.850</returns>851<remarks>852<para>853How well the resulting window matches the desired window depends mostly854on the available hardware and OpenGL drivers. In general, selecting a855fullscreen mode has better chances of generating a close match than does856a normal desktop window, since GLFW can freely select from all the available857video modes. A desktop window is normally restricted to the video mode of858the desktop.859</para>860<para>861For additional control of window properties, see862<see cref="M:Tao.Glfw.Glfw.glfwOpenWindowHint(System.Int32,System.Int32)"/>.863</para>864<para>865In fullscreen mode the mouse cursor is hidden by default, and any system866screensavers are prohibited from starting. In windowed mode the mouse cursor867is visible, and screensavers are allowed to start. To change the visibility868of the mouse cursor, use <see cref="M:Tao.Glfw.Glfw.glfwEnable(System.Int32)"/> or869<see cref="M:Tao.Glfw.Glfw.glfwDisable(System.Int32)"/> with the argument <see cref="F:Tao.Glfw.Glfw.GLFW_MOUSE_CURSOR"/>.870</para>871<para>872In order to determine the actual properties of an opened window, use873<see cref="M:Tao.Glfw.Glfw.glfwGetWindowParam(System.Int32)"/> and <see cref="M:Tao.Glfw.Glfw.glfwGetWindowSize(System.Int32@,System.Int32@)"/>874(or <see cref="M:Tao.Glfw.Glfw.glfwSetWindowSizeCallback(Tao.Glfw.Glfw.GLFWwindowsizefun)"/>).875</para>876</remarks>877</member>878<member name="M:Tao.Glfw.Glfw.glfwOpenWindowHint(System.Int32,System.Int32)">879<summary>880Sets additional properties for a window that is to be opened.881</summary>882<param name="target">883884</param>885<param name="hint">886887</param>888<remarks>889<para>890For a hint to be registered, the function must be called before calling891<see cref="M:Tao.Glfw.Glfw.glfwOpenWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/>. When the <see cref="M:Tao.Glfw.Glfw.glfwOpenWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/>892function is called, any hints that were registered with the893<b>glfwOpenWindowHint</b> function are used for setting the894corresponding window properties, and then all hints are reset to their895default values.896</para>897</remarks>898</member>899<member name="M:Tao.Glfw.Glfw.glfwCloseWindow">900<summary>901The function closes an opened window and destroys the associated OpenGL context.902</summary>903</member>904<member name="M:Tao.Glfw.Glfw.glfwSetWindowTitle(System.String)">905<summary>906Changes the title of the opened window.907</summary>908<param name="title">909Pointer to a null terminated ISO 8859-1 (8-bit Latin 1) string that holds the title of the window.910</param>911<remarks>912<para>913The title property of a window is often used in situations other than for the window title, such as the title of an application icon when it is in iconified state.914</para>915</remarks>916</member>917<member name="M:Tao.Glfw.Glfw.glfwGetWindowSize(System.Int32@,System.Int32@)">918<summary>919920</summary>921</member>922<member name="M:Tao.Glfw.Glfw.glfwSetWindowSize(System.Int32,System.Int32)">923<summary>924925</summary>926</member>927<member name="M:Tao.Glfw.Glfw.glfwSetWindowPos(System.Int32,System.Int32)">928<summary>929930</summary>931</member>932<member name="M:Tao.Glfw.Glfw.glfwIconifyWindow">933<summary>934935</summary>936</member>937<member name="M:Tao.Glfw.Glfw.glfwRestoreWindow">938<summary>939940</summary>941</member>942<member name="M:Tao.Glfw.Glfw.glfwSwapBuffers">943<summary>944945</summary>946</member>947<member name="M:Tao.Glfw.Glfw.glfwSwapInterval(System.Int32)">948<summary>949950</summary>951</member>952<member name="M:Tao.Glfw.Glfw.glfwGetWindowParam(System.Int32)">953<summary>954955</summary>956</member>957<member name="M:Tao.Glfw.Glfw.glfwSetWindowSizeCallback(Tao.Glfw.Glfw.GLFWwindowsizefun)">958<summary>959960</summary>961</member>962<member name="M:Tao.Glfw.Glfw.glfwSetWindowCloseCallback(Tao.Glfw.Glfw.GLFWwindowclosefun)">963<summary>964Selects which function to be called upon a window close event.965</summary>966<remarks>967<para>968A window has to be opened for this function to have any effect.969</para>970<para>971Window close events are recorded continuously, but only reported when glfwPollEvents, glfwWaitEvents or glfwSwapBuffers is called.972</para>973<para>974The OpenGLTM context is still valid when this function is called.975</para>976<para>977Note that the window close callback function is not called when glfwCloseWindow is called, but only when the close request comes from the window manager.978</para>979<para>980Do not call glfwCloseWindow from a window close callback function. Close the window by returning GL_TRUE from the function.981</para>982</remarks>983<param name="cbfun">984Pointer to a callback function that will be called when a user requests that the window should be closed.985</param>986</member>987<member name="M:Tao.Glfw.Glfw.glfwSetWindowRefreshCallback(Tao.Glfw.Glfw.GLFWwindowrefreshfun)">988<summary>989The function selects which function to be called upon a window refresh event, which occurs when any part of the window client area has been damaged, and needs to be repainted (for instance, if a part of the window that was previously occluded by another window has become visible).990</summary>991<remarks>992<para>993A window has to be opened for this function to have any effect.994</para>995<para>996Window refresh events are recorded continuously, but only reported when glfwPollEvents, glfwWaitEvents or glfwSwapBuffers is called.997</para>998</remarks>999<param name="cbfun">1000Pointer to a callback function that will be called when the window client area needs to be refreshed.1001</param>1002</member>1003<member name="M:Tao.Glfw.Glfw.glfwGetVideoModes(Tao.Glfw.Glfw.GLFWvidmode[],System.Int32)">1004<summary>10051006</summary>1007</member>1008<member name="M:Tao.Glfw.Glfw.glfwGetDesktopMode(Tao.Glfw.Glfw.GLFWvidmode@)">1009<summary>10101011</summary>1012</member>1013<member name="M:Tao.Glfw.Glfw.glfwPollEvents">1014<summary>10151016</summary>1017</member>1018<member name="M:Tao.Glfw.Glfw.glfwWaitEvents">1019<summary>10201021</summary>1022</member>1023<member name="M:Tao.Glfw.Glfw.glfwGetKey(System.Int32)">1024<summary>10251026</summary>1027</member>1028<member name="M:Tao.Glfw.Glfw.glfwGetMouseButton(System.Int32)">1029<summary>10301031</summary>1032</member>1033<member name="M:Tao.Glfw.Glfw.glfwGetMousePos(System.Int32@,System.Int32@)">1034<summary>10351036</summary>1037</member>1038<member name="M:Tao.Glfw.Glfw.glfwSetMousePos(System.Int32,System.Int32)">1039<summary>10401041</summary>1042</member>1043<member name="M:Tao.Glfw.Glfw.glfwGetMouseWheel">1044<summary>10451046</summary>1047</member>1048<member name="M:Tao.Glfw.Glfw.glfwSetMouseWheel(System.Int32)">1049<summary>10501051</summary>1052</member>1053<member name="M:Tao.Glfw.Glfw.glfwSetKeyCallback(Tao.Glfw.Glfw.GLFWkeyfun)">1054<summary>10551056</summary>1057</member>1058<member name="M:Tao.Glfw.Glfw.glfwSetCharCallback(Tao.Glfw.Glfw.GLFWcharfun)">1059<summary>10601061</summary>1062</member>1063<member name="M:Tao.Glfw.Glfw.glfwSetMouseButtonCallback(Tao.Glfw.Glfw.GLFWmousebuttonfun)">1064<summary>10651066</summary>1067</member>1068<member name="M:Tao.Glfw.Glfw.glfwSetMousePosCallback(Tao.Glfw.Glfw.GLFWmouseposfun)">1069<summary>10701071</summary>1072</member>1073<member name="M:Tao.Glfw.Glfw.glfwSetMouseWheelCallback(Tao.Glfw.Glfw.GLFWmousewheelfun)">1074<summary>10751076</summary>1077</member>1078<member name="M:Tao.Glfw.Glfw.glfwGetJoystickParam(System.Int32,System.Int32)">1079<summary>10801081</summary>1082</member>1083<member name="M:Tao.Glfw.Glfw.glfwGetJoystickPos(System.Int32,System.Single[],System.Int32)">1084<summary>10851086</summary>1087</member>1088<member name="M:Tao.Glfw.Glfw.glfwGetJoystickButtons(System.Int32,System.Byte[],System.Int32)">1089<summary>10901091</summary>1092</member>1093<member name="M:Tao.Glfw.Glfw.glfwGetTime">1094<summary>10951096</summary>1097</member>1098<member name="M:Tao.Glfw.Glfw.glfwSetTime(System.Double)">1099<summary>11001101</summary>1102</member>1103<member name="M:Tao.Glfw.Glfw.glfwSleep(System.Double)">1104<summary>11051106</summary>1107</member>1108<member name="M:Tao.Glfw.Glfw.glfwExtensionSupported(System.String)">1109<summary>11101111</summary>1112</member>1113<member name="M:Tao.Glfw.Glfw.glfwGetProcAddress(System.String)">1114<summary>11151116</summary>1117</member>1118<member name="M:Tao.Glfw.Glfw.glfwGetGLVersion(System.Int32@,System.Int32@,System.Int32@)">1119<summary>11201121</summary>1122</member>1123<member name="M:Tao.Glfw.Glfw.glfwCreateThread(Tao.Glfw.Glfw.GLFWthreadfun,System.IntPtr)">1124<summary>1125The function creates a new thread, which executes within the same1126address space as the calling process. The thread entry point is1127specified with the fun argument.1128</summary>1129<param name="fun">1130A pointer to a function that acts as the entry point for the new1131thread.1132</param>1133<param name="arg">1134An arbitrary argument for the thread. arg will be passed as the1135argument to the thread function pointed to by fun. For instance,1136arg can point to data that is to be processed by the thread.1137</param>1138<returns>1139The function returns a thread identification number if the thread1140was created successfully. This number is always positive. If the1141function fails, a negative number is returned.1142</returns>1143<remarks>1144<para>1145Once the thread function fun returns, the thread dies.1146</para>1147<para>1148Even if the function returns a positive thread ID, indicating1149that the thread was created successfully, the thread may be1150unable to execute, for instance if the thread start address1151is not a valid thread entry point.1152</para>1153</remarks>1154</member>1155<member name="M:Tao.Glfw.Glfw.glfwDestroyThread(System.Int32)">1156<summary>11571158</summary>1159</member>1160<member name="M:Tao.Glfw.Glfw.glfwWaitThread(System.Int32,System.Int32)">1161<summary>11621163</summary>1164</member>1165<member name="M:Tao.Glfw.Glfw.glfwGetThreadID">1166<summary>11671168</summary>1169</member>1170<member name="M:Tao.Glfw.Glfw.glfwCreateMutex">1171<summary>11721173</summary>1174</member>1175<member name="M:Tao.Glfw.Glfw.glfwDestroyMutex(System.IntPtr)">1176<summary>11771178</summary>1179</member>1180<member name="M:Tao.Glfw.Glfw.glfwLockMutex(System.IntPtr)">1181<summary>11821183</summary>1184</member>1185<member name="M:Tao.Glfw.Glfw.glfwUnlockMutex(System.IntPtr)">1186<summary>11871188</summary>1189</member>1190<member name="M:Tao.Glfw.Glfw.glfwCreateCond">1191<summary>11921193</summary>1194</member>1195<member name="M:Tao.Glfw.Glfw.glfwDestroyCond(System.IntPtr)">1196<summary>11971198</summary>1199</member>1200<member name="M:Tao.Glfw.Glfw.glfwWaitCond(System.IntPtr,System.IntPtr,System.Double)">1201<summary>12021203</summary>1204</member>1205<member name="M:Tao.Glfw.Glfw.glfwSignalCond(System.IntPtr)">1206<summary>12071208</summary>1209</member>1210<member name="M:Tao.Glfw.Glfw.glfwBroadcastCond(System.IntPtr)">1211<summary>12121213</summary>1214</member>1215<member name="M:Tao.Glfw.Glfw.glfwGetNumberOfProcessors">1216<summary>12171218</summary>1219</member>1220<member name="M:Tao.Glfw.Glfw.glfwEnable(System.Int32)">1221<summary>12221223</summary>1224</member>1225<member name="M:Tao.Glfw.Glfw.glfwDisable(System.Int32)">1226<summary>12271228</summary>1229</member>1230<member name="M:Tao.Glfw.Glfw.glfwReadImage(System.String,Tao.Glfw.Glfw.GLFWimage@,System.Int32)">1231<summary>12321233</summary>1234</member>1235<member name="M:Tao.Glfw.Glfw.glfwReadMemoryImage(System.IntPtr,System.Int32,Tao.Glfw.Glfw.GLFWimage@,System.Int32)">1236<summary>12371238</summary>1239</member>1240<member name="M:Tao.Glfw.Glfw.glfwFreeImage(Tao.Glfw.Glfw.GLFWimage@)">1241<summary>12421243</summary>1244</member>1245<member name="M:Tao.Glfw.Glfw.glfwLoadTexture2D(System.String,System.Int32)">1246<summary>12471248</summary>1249</member>1250<member name="M:Tao.Glfw.Glfw.glfwLoadMemoryTexture2D(System.IntPtr,System.Int32,System.Int32)">1251<summary>12521253</summary>1254</member>1255<member name="M:Tao.Glfw.Glfw.glfwLoadTextureImage2D(Tao.Glfw.Glfw.GLFWimage@,System.Int32)">1256<summary>12571258</summary>1259</member>1260<member name="T:Tao.Glfw.Glfw.GLFWvidmode">1261<summary>1262Video mode.1263</summary>1264</member>1265<member name="F:Tao.Glfw.Glfw.GLFWvidmode.Width">1266<summary>1267Video width resolution.1268</summary>1269</member>1270<member name="F:Tao.Glfw.Glfw.GLFWvidmode.Height">1271<summary>1272Video height resolution.1273</summary>1274</member>1275<member name="F:Tao.Glfw.Glfw.GLFWvidmode.RedBits">1276<summary>1277Number of red bits.1278</summary>1279</member>1280<member name="F:Tao.Glfw.Glfw.GLFWvidmode.BlueBits">1281<summary>1282Number of blue bits.1283</summary>1284</member>1285<member name="F:Tao.Glfw.Glfw.GLFWvidmode.GreenBits">1286<summary>1287Number of green bits.1288</summary>1289</member>1290<member name="T:Tao.Glfw.Glfw.GLFWimage">1291<summary>1292Image information.1293</summary>1294</member>1295<member name="F:Tao.Glfw.Glfw.GLFWimage.Width">1296<summary>1297Image width resolution.1298</summary>1299</member>1300<member name="F:Tao.Glfw.Glfw.GLFWimage.Height">1301<summary>1302Image height resolution.1303</summary>1304</member>1305<member name="F:Tao.Glfw.Glfw.GLFWimage.Format">1306<summary>1307OpenGL pixel format.1308</summary>1309</member>1310<member name="F:Tao.Glfw.Glfw.GLFWimage.BytesPerPixel">1311<summary>1312Number of bytes per pixel.1313</summary>1314</member>1315<member name="F:Tao.Glfw.Glfw.GLFWimage.Data">1316<summary>1317Image pixel data.1318</summary>1319</member>1320<member name="T:Tao.Glfw.Glfw.GLFWwindowsizefun">1321<summary>1322Callback function that will be called every time the window size changes.1323</summary>1324</member>1325<member name="T:Tao.Glfw.Glfw.GLFWwindowclosefun">1326<summary>1327Callback function that will be called every time the window closes.1328</summary>1329</member>1330<member name="T:Tao.Glfw.Glfw.GLFWwindowrefreshfun">1331<summary>1332Callback function that will be called every time the window refreshes.1333</summary>1334</member>1335<member name="T:Tao.Glfw.Glfw.GLFWmousebuttonfun">1336<summary>1337Callback function that will be called every time a mouse button is pressed1338or released.1339</summary>1340</member>1341<member name="T:Tao.Glfw.Glfw.GLFWmouseposfun">1342<summary>1343Callback function that will be called every time the mouse is moved.1344</summary>1345</member>1346<member name="T:Tao.Glfw.Glfw.GLFWmousewheelfun">1347<summary>1348Callback function that will be called every time the mouse wheel is moved.1349</summary>1350</member>1351<member name="T:Tao.Glfw.Glfw.GLFWkeyfun">1352<summary>1353Callback function that will be called every time a key is pressed or released.1354</summary>1355</member>1356<member name="T:Tao.Glfw.Glfw.GLFWcharfun">1357<summary>1358Callback function that will be called every time a printable character is1359generated by the keyboard.1360</summary>1361</member>1362<member name="T:Tao.Glfw.Glfw.GLFWthreadfun">1363<summary>1364Callback function that acts as the entry point for the new thread.1365</summary>1366</member>1367</members>1368</doc>136913701371