Added more method and class comments.

This commit is contained in:
Jarl Gullberg 2017-06-13 22:49:49 +02:00
parent 5c69098f63
commit cb42feef20
No known key found for this signature in database
GPG key ID: 750FF6F6BDA72D23
3 changed files with 29 additions and 0 deletions

View file

@ -32,6 +32,10 @@ using OpenTK.Platform;
namespace OpenTK.OSX
{
/// <summary>
/// Handler class for initializing <see cref="IWindowInfo"/> objects under the OSX platform for both GTK2 and
/// GTK3.
/// </summary>
public static class OSXWindowInfoInitializer
{
#if GTK3
@ -40,6 +44,10 @@ namespace OpenTK.OSX
const string OSXLibGdkName = "libgdk-quartz-2.0.0.dylib";
#endif
/// <summary>
/// Initializes an <see cref="IWindowInfo"/> under the OSX platform.
/// </summary>
/// <param name="gdkWindowHandle"></param>
public static IWindowInfo Initialize(IntPtr gdkWindowHandle)
{
IntPtr windowHandle = gdk_quartz_window_get_nswindow(gdkWindowHandle);

View file

@ -32,6 +32,10 @@ using OpenTK.Platform;
namespace OpenTK.Win
{
/// <summary>
/// Handler class for initializing <see cref="IWindowInfo"/> objects under the Windows platform for both GTK2 and
/// GTK3.
/// </summary>
public static class WinWindowsInfoInitializer
{
#if GTK3
@ -39,6 +43,11 @@ namespace OpenTK.Win
#else
private const string WinLibGDKName = "libgdk-win32-2.0-0.dll";
#endif
/// <summary>
/// Initializes an <see cref="IWindowInfo"/> under the Windows platform.
/// </summary>
/// <param name="gdkWindowHandle"></param>
public static IWindowInfo Initialize(IntPtr gdkWindowHandle)
{
#if GTK3

View file

@ -34,6 +34,9 @@ using OpenTK.Platform;
namespace OpenTK.X11
{
/// <summary>
/// Handler class for initializing <see cref="IWindowInfo"/> objects under the X11 platform for both GTK2 and GTK3.
/// </summary>
public static class XWindowInfoInitializer
{
@ -45,6 +48,15 @@ namespace OpenTK.X11
private const string UnixLibX11Name = "libX11.so.6";
private const string UnixLibGLName = "libGL.so.1";
/// <summary>
/// Initializes an <see cref="IWindowInfo"/> under the X11 platform.
/// </summary>
/// <param name="mode"></param>
/// <param name="displayHandle"></param>
/// <param name="screenNumber"></param>
/// <param name="gdkWindowHandle"></param>
/// <param name="gdkRootWindowHandle"></param>
/// <returns></returns>
public static IWindowInfo Initialize(GraphicsMode mode, IntPtr displayHandle, int screenNumber, IntPtr gdkWindowHandle, IntPtr gdkRootWindowHandle)
{
IntPtr display = gdk_x11_display_get_xdisplay(displayHandle);