OpenTK.GLControl.xml 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>OpenTK.GLControl</name>
  5. </assembly>
  6. <members>
  7. <member name="T:OpenTK.GLControl">
  8. <summary>
  9. OpenGL-aware WinForms control.
  10. The WinForms designer will always call the default constructor.
  11. Inherit from this class and call one of its specialized constructors
  12. to enable antialiasing or custom <see cref="P:OpenTK.GLControl.GraphicsMode"/>s.
  13. </summary>
  14. </member>
  15. <member name="F:OpenTK.GLControl.components">
  16. <summary>
  17. Required designer variable.
  18. </summary>
  19. </member>
  20. <member name="M:OpenTK.GLControl.Dispose(System.Boolean)">
  21. <summary>
  22. Clean up any resources being used.
  23. </summary>
  24. <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
  25. </member>
  26. <member name="M:OpenTK.GLControl.InitializeComponent">
  27. <summary>
  28. Required method for Designer support - do not modify
  29. the contents of this method with the code editor.
  30. </summary>
  31. </member>
  32. <member name="M:OpenTK.GLControl.#ctor">
  33. <summary>
  34. Constructs a new instance.
  35. </summary>
  36. </member>
  37. <member name="M:OpenTK.GLControl.#ctor(OpenTK.Graphics.GraphicsMode)">
  38. <summary>
  39. Constructs a new instance with the specified GraphicsMode.
  40. </summary>
  41. <param name="mode">The OpenTK.Graphics.GraphicsMode of the control.</param>
  42. </member>
  43. <member name="M:OpenTK.GLControl.#ctor(OpenTK.Graphics.GraphicsMode,System.Int32,System.Int32,OpenTK.Graphics.GraphicsContextFlags)">
  44. <summary>
  45. Constructs a new instance with the specified GraphicsMode.
  46. </summary>
  47. <param name="mode">The OpenTK.Graphics.GraphicsMode of the control.</param>
  48. <param name="major">The major version for the OpenGL GraphicsContext.</param>
  49. <param name="minor">The minor version for the OpenGL GraphicsContext.</param>
  50. <param name="flags">The GraphicsContextFlags for the OpenGL GraphicsContext.</param>
  51. </member>
  52. <member name="P:OpenTK.GLControl.CreateParams">
  53. <summary>
  54. Gets the <c>CreateParams</c> instance for this <c>GLControl</c>
  55. </summary>
  56. </member>
  57. <member name="M:OpenTK.GLControl.OnHandleCreated(System.EventArgs)">
  58. <summary>Raises the HandleCreated event.</summary>
  59. <param name="e">Not used.</param>
  60. </member>
  61. <member name="M:OpenTK.GLControl.OnHandleDestroyed(System.EventArgs)">
  62. <summary>Raises the HandleDestroyed event.</summary>
  63. <param name="e">Not used.</param>
  64. </member>
  65. <member name="M:OpenTK.GLControl.OnPaint(System.Windows.Forms.PaintEventArgs)">
  66. <summary>
  67. Raises the System.Windows.Forms.Control.Paint event.
  68. </summary>
  69. <param name="e">A System.Windows.Forms.PaintEventArgs that contains the event data.</param>
  70. </member>
  71. <member name="M:OpenTK.GLControl.OnResize(System.EventArgs)">
  72. <summary>
  73. Raises the Resize event.
  74. Note: this method may be called before the OpenGL context is ready.
  75. Check that IsHandleCreated is true before using any OpenGL methods.
  76. </summary>
  77. <param name="e">A System.EventArgs that contains the event data.</param>
  78. </member>
  79. <member name="T:OpenTK.GLControl.DelayUpdate">
  80. <summary>
  81. Needed to delay the invoke on OS X. Also needed because OpenTK is .NET 2, otherwise I'd use an inline Action.
  82. </summary>
  83. </member>
  84. <member name="M:OpenTK.GLControl.PerformContextUpdate">
  85. <summary>
  86. Execute the delayed context update
  87. </summary>
  88. </member>
  89. <member name="M:OpenTK.GLControl.OnParentChanged(System.EventArgs)">
  90. <summary>
  91. Raises the ParentChanged event.
  92. </summary>
  93. <param name="e">A System.EventArgs that contains the event data.</param>
  94. </member>
  95. <member name="M:OpenTK.GLControl.SwapBuffers">
  96. <summary>
  97. Swaps the front and back buffers, presenting the rendered scene to the screen.
  98. This method will have no effect on a single-buffered <c>GraphicsMode</c>.
  99. </summary>
  100. </member>
  101. <member name="M:OpenTK.GLControl.MakeCurrent">
  102. <summary>
  103. <para>
  104. Makes <see cref="P:OpenTK.GLControl.Context"/> current in the calling thread.
  105. All OpenGL commands issued are hereafter interpreted by this context.
  106. </para>
  107. <para>
  108. When using multiple <c>GLControl</c>s, calling <c>MakeCurrent</c> on
  109. one control will make all other controls non-current in the calling thread.
  110. </para>
  111. <seealso cref="P:OpenTK.GLControl.Context"/>
  112. <para>
  113. A <c>GLControl</c> can only be current in one thread at a time.
  114. To make a control non-current, call <c>GLControl.Context.MakeCurrent(null)</c>.
  115. </para>
  116. </summary>
  117. </member>
  118. <member name="P:OpenTK.GLControl.IsIdle">
  119. <summary>
  120. Gets a value indicating whether the current thread contains pending system messages.
  121. </summary>
  122. </member>
  123. <member name="P:OpenTK.GLControl.Context">
  124. <summary>
  125. Gets the <c>IGraphicsContext</c> instance that is associated with the <c>GLControl</c>.
  126. The associated <c>IGraphicsContext</c> is updated whenever the <c>GLControl</c>
  127. handle is created or recreated.
  128. When using multiple <c>GLControl</c>s, ensure that <c>Context</c>
  129. is current before performing any OpenGL operations.
  130. <seealso cref="M:OpenTK.GLControl.MakeCurrent"/>
  131. </summary>
  132. </member>
  133. <member name="P:OpenTK.GLControl.AspectRatio">
  134. <summary>
  135. Gets the aspect ratio of this GLControl.
  136. </summary>
  137. </member>
  138. <member name="P:OpenTK.GLControl.VSync">
  139. <summary>
  140. Gets or sets a value indicating whether vsync is active for this <c>GLControl</c>.
  141. When using multiple <c>GLControl</c>s, ensure that <see cref="P:OpenTK.GLControl.Context"/>
  142. is current before accessing this property.
  143. <seealso cref="P:OpenTK.GLControl.Context"/>
  144. <seealso cref="M:OpenTK.GLControl.MakeCurrent"/>
  145. </summary>
  146. </member>
  147. <member name="P:OpenTK.GLControl.GraphicsMode">
  148. <summary>
  149. Gets the <c>GraphicsMode</c> of the <c>IGraphicsContext</c> associated with
  150. this <c>GLControl</c>. If you wish to change <c>GraphicsMode</c>, you must
  151. destroy and recreate the <c>GLControl</c>.
  152. </summary>
  153. </member>
  154. <member name="P:OpenTK.GLControl.WindowInfo">
  155. <summary>
  156. Gets the <see cref="T:OpenTK.Platform.IWindowInfo"/> for this instance.
  157. </summary>
  158. </member>
  159. <member name="M:OpenTK.GLControl.GrabScreenshot">
  160. <summary>
  161. Grabs a screenshot of the frontbuffer contents.
  162. When using multiple <c>GLControl</c>s, ensure that <see cref="P:OpenTK.GLControl.Context"/>
  163. is current before accessing this property.
  164. <seealso cref="P:OpenTK.GLControl.Context"/>
  165. <seealso cref="M:OpenTK.GLControl.MakeCurrent"/>
  166. </summary>
  167. <returns>A System.Drawing.Bitmap, containing the contents of the frontbuffer.</returns>
  168. <exception cref="T:OpenTK.Graphics.GraphicsContextException">
  169. Occurs when no OpenTK.Graphics.GraphicsContext is current in the calling thread.
  170. </exception>
  171. </member>
  172. <member name="M:OpenTK.Platform.MacOS.Agl.aglChoosePixelFormat(System.IntPtr,System.Int32,System.Int32[])">
  173. <summary>
  174. Use this overload only with IntPtr.Zero for the first argument.
  175. </summary>
  176. <param name="gdevs">
  177. </param>
  178. <param name="ndev">
  179. </param>
  180. <param name="attribs">
  181. </param>
  182. <returns>
  183. </returns>
  184. </member>
  185. <member name="T:OpenTK.Platform.MacOS.AglContext">
  186. <summary>
  187. AGL context implementation for WinForms compatibility.
  188. </summary>
  189. </member>
  190. </members>
  191. </doc>