From ffd7682eebc99fe5d157eb86c19a5fd86bc413f2 Mon Sep 17 00:00:00 2001 From: thefiddler Date: Mon, 21 Jul 2014 16:53:24 +0200 Subject: [PATCH] [ES][GL] Added missing documentation comments --- Source/OpenTK/Graphics/ES20/Helper.cs | 22 +++++++++++ Source/OpenTK/Graphics/ES30/Helper.cs | 22 +++++++++++ Source/OpenTK/Graphics/OpenGL/GLHelper.cs | 43 ++++++++++++++++++++++ Source/OpenTK/Graphics/OpenGL4/Helper.cs | 45 ++++++++++++++++++++--- 4 files changed, 126 insertions(+), 6 deletions(-) diff --git a/Source/OpenTK/Graphics/ES20/Helper.cs b/Source/OpenTK/Graphics/ES20/Helper.cs index 1307d55d..3f51e4b8 100644 --- a/Source/OpenTK/Graphics/ES20/Helper.cs +++ b/Source/OpenTK/Graphics/ES20/Helper.cs @@ -458,12 +458,34 @@ namespace OpenTK.Graphics.ES20 #endregion } + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The for this debug message. + /// The for this debug message. + /// The id of this debug message. + /// The for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. [UnmanagedFunctionPointer(CallingConvention.Winapi)] public delegate void DebugProc( DebugSource source, DebugType type, int id, DebugSeverity severity, int length, IntPtr message, IntPtr userParam); + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The for this debug message. + /// The for this debug message. + /// The id of this debug message. + /// The for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. [UnmanagedFunctionPointer(CallingConvention.Winapi)] public delegate void DebugProcKhr( DebugSource source, DebugType type, int id, diff --git a/Source/OpenTK/Graphics/ES30/Helper.cs b/Source/OpenTK/Graphics/ES30/Helper.cs index 7fda7c64..52fe33a2 100644 --- a/Source/OpenTK/Graphics/ES30/Helper.cs +++ b/Source/OpenTK/Graphics/ES30/Helper.cs @@ -449,12 +449,34 @@ namespace OpenTK.Graphics.ES30 #endregion } + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The for this debug message. + /// The for this debug message. + /// The id of this debug message. + /// The for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. [UnmanagedFunctionPointer(CallingConvention.Winapi)] public delegate void DebugProc( DebugSource source, DebugType type, int id, DebugSeverity severity, int length, IntPtr message, IntPtr userParam); + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The for this debug message. + /// The for this debug message. + /// The id of this debug message. + /// The for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. [UnmanagedFunctionPointer(CallingConvention.Winapi)] public delegate void DebugProcKhr( DebugSource source, DebugType type, int id, diff --git a/Source/OpenTK/Graphics/OpenGL/GLHelper.cs b/Source/OpenTK/Graphics/OpenGL/GLHelper.cs index 120bc3a7..6d5bd871 100644 --- a/Source/OpenTK/Graphics/OpenGL/GLHelper.cs +++ b/Source/OpenTK/Graphics/OpenGL/GLHelper.cs @@ -1355,23 +1355,66 @@ namespace OpenTK.Graphics.OpenGL #endregion } + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The id of this debug message. + /// The category for this debug message. + /// The severity for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. [UnmanagedFunctionPointer(CallingConvention.Winapi)] public delegate void DebugProcAmd(int id, AmdDebugOutput category, AmdDebugOutput severity, int length, IntPtr message, IntPtr userParam); + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The for this debug message. + /// The for this debug message. + /// The id of this debug message. + /// The for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. [UnmanagedFunctionPointer(CallingConvention.Winapi)] public delegate void DebugProcArb( DebugSource source, DebugType type, int id, DebugSeverity severity, int length, IntPtr message, IntPtr userParam); + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The for this debug message. + /// The for this debug message. + /// The id of this debug message. + /// The for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. [UnmanagedFunctionPointer(CallingConvention.Winapi)] public delegate void DebugProc( DebugSource source, DebugType type, int id, DebugSeverity severity, int length, IntPtr message, IntPtr userParam); + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The for this debug message. + /// The for this debug message. + /// The id of this debug message. + /// The for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. [UnmanagedFunctionPointer(CallingConvention.Winapi)] public delegate void DebugProcKhr( DebugSource source, DebugType type, int id, diff --git a/Source/OpenTK/Graphics/OpenGL4/Helper.cs b/Source/OpenTK/Graphics/OpenGL4/Helper.cs index d8da0b54..55f23a36 100644 --- a/Source/OpenTK/Graphics/OpenGL4/Helper.cs +++ b/Source/OpenTK/Graphics/OpenGL4/Helper.cs @@ -458,18 +458,51 @@ namespace OpenTK.Graphics.OpenGL4 #endregion } - [UnmanagedFunctionPointer(CallingConvention.Winapi)] - public delegate void DebugProc( - DebugSource source, DebugType type, int id, - DebugSeverity severity, int length, IntPtr message, - IntPtr userParam); - + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The for this debug message. + /// The for this debug message. + /// The id of this debug message. + /// The for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. [UnmanagedFunctionPointer(CallingConvention.Winapi)] public delegate void DebugProcArb( DebugSource source, DebugType type, int id, DebugSeverity severity, int length, IntPtr message, IntPtr userParam); + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The for this debug message. + /// The for this debug message. + /// The id of this debug message. + /// The for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. + [UnmanagedFunctionPointer(CallingConvention.Winapi)] + public delegate void DebugProc( + DebugSource source, DebugType type, int id, + DebugSeverity severity, int length, IntPtr message, + IntPtr userParam); + + /// + /// Defines the signature of a debug callback for + /// . + /// + /// The for this debug message. + /// The for this debug message. + /// The id of this debug message. + /// The for this debug message. + /// The length of this debug message. + /// A pointer to a null-terminated ASCII C string, representing the content of this debug message. + /// A pointer to a user-specified parameter. [UnmanagedFunctionPointer(CallingConvention.Winapi)] public delegate void DebugProcKhr( DebugSource source, DebugType type, int id,