[ES][GL] Added missing documentation comments

This commit is contained in:
thefiddler 2014-07-21 16:53:24 +02:00
parent 093dd1d1ca
commit ffd7682eeb
4 changed files with 126 additions and 6 deletions

View file

@ -458,12 +458,34 @@ namespace OpenTK.Graphics.ES20
#endregion #endregion
} }
/// <summary>
/// Defines the signature of a debug callback for
/// <see cref="GL.DebugMessageCallback"/>.
/// </summary>
/// <param name="source">The <see cref="DebugSource"/> for this debug message.</param>
/// <param name="type">The <see cref="DebugType"/> for this debug message.</param>
/// <param name="id">The id of this debug message.</param>
/// <param name="severity">The <see cref="DebugSeverity"/> for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)] [UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProc( public delegate void DebugProc(
DebugSource source, DebugType type, int id, DebugSource source, DebugType type, int id,
DebugSeverity severity, int length, IntPtr message, DebugSeverity severity, int length, IntPtr message,
IntPtr userParam); IntPtr userParam);
/// <summary>
/// Defines the signature of a debug callback for
/// <see cref="GL.Khr.DebugMessageCallback"/>.
/// </summary>
/// <param name="source">The <see cref="DebugSource"/> for this debug message.</param>
/// <param name="type">The <see cref="DebugType"/> for this debug message.</param>
/// <param name="id">The id of this debug message.</param>
/// <param name="severity">The <see cref="DebugSeverity"/> for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)] [UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProcKhr( public delegate void DebugProcKhr(
DebugSource source, DebugType type, int id, DebugSource source, DebugType type, int id,

View file

@ -449,12 +449,34 @@ namespace OpenTK.Graphics.ES30
#endregion #endregion
} }
/// <summary>
/// Defines the signature of a debug callback for
/// <see cref="GL.DebugMessageCallback"/>.
/// </summary>
/// <param name="source">The <see cref="DebugSource"/> for this debug message.</param>
/// <param name="type">The <see cref="DebugType"/> for this debug message.</param>
/// <param name="id">The id of this debug message.</param>
/// <param name="severity">The <see cref="DebugSeverity"/> for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)] [UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProc( public delegate void DebugProc(
DebugSource source, DebugType type, int id, DebugSource source, DebugType type, int id,
DebugSeverity severity, int length, IntPtr message, DebugSeverity severity, int length, IntPtr message,
IntPtr userParam); IntPtr userParam);
/// <summary>
/// Defines the signature of a debug callback for
/// <see cref="GL.Khr.DebugMessageCallback"/>.
/// </summary>
/// <param name="source">The <see cref="DebugSource"/> for this debug message.</param>
/// <param name="type">The <see cref="DebugType"/> for this debug message.</param>
/// <param name="id">The id of this debug message.</param>
/// <param name="severity">The <see cref="DebugSeverity"/> for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)] [UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProcKhr( public delegate void DebugProcKhr(
DebugSource source, DebugType type, int id, DebugSource source, DebugType type, int id,

View file

@ -1355,23 +1355,66 @@ namespace OpenTK.Graphics.OpenGL
#endregion #endregion
} }
/// <summary>
/// Defines the signature of a debug callback for
/// <see cref="GL.Amd.DebugMessageCallback"/>.
/// </summary>
/// <param name="id">The id of this debug message.</param>
/// <param name="category">The <see cref="AmdDebugOutput"/> category for this debug message.</param>
/// <param name="severity">The <see cref="AmdDebugOutput"/> severity for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)] [UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProcAmd(int id, public delegate void DebugProcAmd(int id,
AmdDebugOutput category, AmdDebugOutput severity, AmdDebugOutput category, AmdDebugOutput severity,
int length, IntPtr message, IntPtr userParam); int length, IntPtr message, IntPtr userParam);
/// <summary>
/// Defines the signature of a debug callback for
/// <see cref="GL.Arb.DebugMessageCallback"/>.
/// </summary>
/// <param name="source">The <see cref="DebugSource"/> for this debug message.</param>
/// <param name="type">The <see cref="DebugType"/> for this debug message.</param>
/// <param name="id">The id of this debug message.</param>
/// <param name="severity">The <see cref="DebugSeverity"/> for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)] [UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProcArb( public delegate void DebugProcArb(
DebugSource source, DebugType type, int id, DebugSource source, DebugType type, int id,
DebugSeverity severity, int length, IntPtr message, DebugSeverity severity, int length, IntPtr message,
IntPtr userParam); IntPtr userParam);
/// <summary>
/// Defines the signature of a debug callback for
/// <see cref="GL.DebugMessageCallback"/>.
/// </summary>
/// <param name="source">The <see cref="DebugSource"/> for this debug message.</param>
/// <param name="type">The <see cref="DebugType"/> for this debug message.</param>
/// <param name="id">The id of this debug message.</param>
/// <param name="severity">The <see cref="DebugSeverity"/> for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)] [UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProc( public delegate void DebugProc(
DebugSource source, DebugType type, int id, DebugSource source, DebugType type, int id,
DebugSeverity severity, int length, IntPtr message, DebugSeverity severity, int length, IntPtr message,
IntPtr userParam); IntPtr userParam);
/// <summary>
/// Defines the signature of a debug callback for
/// <see cref="GL.Khr.DebugMessageCallback"/>.
/// </summary>
/// <param name="source">The <see cref="DebugSource"/> for this debug message.</param>
/// <param name="type">The <see cref="DebugType"/> for this debug message.</param>
/// <param name="id">The id of this debug message.</param>
/// <param name="severity">The <see cref="DebugSeverity"/> for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)] [UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProcKhr( public delegate void DebugProcKhr(
DebugSource source, DebugType type, int id, DebugSource source, DebugType type, int id,

View file

@ -458,18 +458,51 @@ namespace OpenTK.Graphics.OpenGL4
#endregion #endregion
} }
[UnmanagedFunctionPointer(CallingConvention.Winapi)] /// <summary>
public delegate void DebugProc( /// Defines the signature of a debug callback for
DebugSource source, DebugType type, int id, /// <see cref="GL.Arb.DebugMessageCallback"/>.
DebugSeverity severity, int length, IntPtr message, /// </summary>
IntPtr userParam); /// <param name="source">The <see cref="DebugSource"/> for this debug message.</param>
/// <param name="type">The <see cref="DebugType"/> for this debug message.</param>
/// <param name="id">The id of this debug message.</param>
/// <param name="severity">The <see cref="DebugSeverity"/> for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)] [UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProcArb( public delegate void DebugProcArb(
DebugSource source, DebugType type, int id, DebugSource source, DebugType type, int id,
DebugSeverity severity, int length, IntPtr message, DebugSeverity severity, int length, IntPtr message,
IntPtr userParam); IntPtr userParam);
/// <summary>
/// Defines the signature of a debug callback for
/// <see cref="GL.DebugMessageCallback"/>.
/// </summary>
/// <param name="source">The <see cref="DebugSource"/> for this debug message.</param>
/// <param name="type">The <see cref="DebugType"/> for this debug message.</param>
/// <param name="id">The id of this debug message.</param>
/// <param name="severity">The <see cref="DebugSeverity"/> for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProc(
DebugSource source, DebugType type, int id,
DebugSeverity severity, int length, IntPtr message,
IntPtr userParam);
/// <summary>
/// Defines the signature of a debug callback for
/// <see cref="GL.Khr.DebugMessageCallback"/>.
/// </summary>
/// <param name="source">The <see cref="DebugSource"/> for this debug message.</param>
/// <param name="type">The <see cref="DebugType"/> for this debug message.</param>
/// <param name="id">The id of this debug message.</param>
/// <param name="severity">The <see cref="DebugSeverity"/> for this debug message.</param>
/// <param name="length">The length of this debug message.</param>
/// <param name="message">A pointer to a null-terminated ASCII C string, representing the content of this debug message.</param>
/// <param name="userParam">A pointer to a user-specified parameter.</param>
[UnmanagedFunctionPointer(CallingConvention.Winapi)] [UnmanagedFunctionPointer(CallingConvention.Winapi)]
public delegate void DebugProcKhr( public delegate void DebugProcKhr(
DebugSource source, DebugType type, int id, DebugSource source, DebugType type, int id,