Documentation updates. Getting rid of all remaining warnings in debug build.

This commit is contained in:
the_fiddler 2008-01-20 19:29:42 +00:00
parent 5a66d44f19
commit 878af03601
14 changed files with 97 additions and 106 deletions

View file

@ -27,7 +27,7 @@ namespace Bind
// TODO: This code is too fragile. // TODO: This code is too fragile.
// Old enums code: // Old enums code:
public static string normalEnumsClassOverride; public static string normalEnumsClassOverride = null;
public static string NestedEnumsClass = "Enums"; public static string NestedEnumsClass = "Enums";
public static string NormalEnumsClass public static string NormalEnumsClass
{ {

View file

@ -386,7 +386,7 @@ namespace OpenTK.Build
//DirectoryInfo dir; //DirectoryInfo dir;
//FileInfo[] files; //FileInfo[] files;
//DirectoryInfo[] dirs; //DirectoryInfo[] dirs;
string tmppath; //string tmppath;
//determine if the destination directory exists, if not create it //determine if the destination directory exists, if not create it
if (!Directory.Exists(destdir)) if (!Directory.Exists(destdir))

View file

@ -160,7 +160,7 @@ namespace Examples
Debug.Print(expt.ToString()); Debug.Print(expt.ToString());
#if DEBUG #if DEBUG
throw; //throw;
#endif #endif
} }
catch (NullReferenceException expt) catch (NullReferenceException expt)

View file

@ -64,7 +64,7 @@ namespace OpenTK
double update_period, render_period; double update_period, render_period;
double target_update_period, target_render_period, target_render_period_doubled; double target_update_period, target_render_period, target_render_period_doubled;
// TODO: Implement these: // TODO: Implement these:
double update_time, render_time, event_time; double update_time, render_time;//, event_time;
//bool allow_sleep = true; // If true, GameWindow will call Timer.Sleep() if there is enough time. //bool allow_sleep = true; // If true, GameWindow will call Timer.Sleep() if there is enough time.
int width, height; int width, height;
VSyncMode vsync; VSyncMode vsync;

View file

@ -220,7 +220,7 @@ namespace OpenTK.Input
#endregion #endregion
} }
//public delegate void MouseMoveEvent(MouseDevice sender, MouseMoveData key); public delegate void MouseMoveEvent(MouseDevice sender);
public delegate void MouseButtonDownEvent(MouseDevice sender, MouseButton button); public delegate void MouseButtonDownEvent(MouseDevice sender, MouseButton button);
public delegate void MouseButtonUpEvent(MouseDevice sender, MouseButton button); public delegate void MouseButtonUpEvent(MouseDevice sender, MouseButton button);
@ -247,65 +247,4 @@ namespace OpenTK.Input
} }
#endregion #endregion
#region internal class MouseMoveData
/// <summary>
/// Not used yet.
/// </summary>
internal class MouseMoveData
{
private int x;
private int y;
private int deltaX;
private int deltaY;
private int wheel, deltaWheel;
/// <summary>
/// Gets the absolute X position of the mouse in screen pixel coordinates.
/// </summary>
public int X
{
get { return x; }
internal set { x = value; }
}
/// <summary>
/// Gets the absolute Y position of the mouse in screen pixel coordinates.
/// </summary>
public int Y
{
get { return y; }
internal set { y = value; }
}
/// <summary>
/// Gets the relative movement of the mouse in the X direction, in pixels.
/// </summary>
public int DeltaX
{
get { return deltaX; }
internal set { deltaX = value; }
}
/// <summary>
/// Gets the relative movement of the mouse in the Y direction, in pixels.
/// </summary>
public int DeltaY
{
get { return deltaY; }
internal set { deltaY = value; }
}
/// <summary>
/// Gets data relevant to the mouse wheel.
/// </summary>
//public MouseWheel Wheel
//{
// get { return wheel; }
// internal set { wheel = value; }
//}
}
#endregion
} }

View file

@ -63,21 +63,21 @@ namespace OpenTK.Math
/// <summary>Converts the vector into left double-precision floating point number pointer.</summary> /// <summary>Converts the vector into left double-precision floating point number pointer.</summary>
/// <param name="vector">The vector being converted.</param> /// <param name="vector">The vector being converted.</param>
/// <returns>A double-precision floating point number pointer to the vector coordinates.</returns> /// <returns>A double-precision floating point number pointer to the vector coordinates.</returns>
unsafe public static explicit operator double*(Vector2d vector) //unsafe public static explicit operator double*(Vector2d vector)
{ //{
return &vector.X; // return &vector.X;
} //}
/// <summary>Converts the vector into an IntPtr.</summary> /// <summary>Converts the vector into an IntPtr.</summary>
/// <param name="vector">The vector being converted.</param> /// <param name="vector">The vector being converted.</param>
/// <returns>An IntPtr to the vector coordinates.</returns> /// <returns>An IntPtr to the vector coordinates.</returns>
public static explicit operator IntPtr(Vector2d vector) //public static explicit operator IntPtr(Vector2d vector)
{ //{
unsafe // unsafe
{ // {
return (IntPtr)(&vector.X); // return (IntPtr)(&vector.X);
} // }
} //}
#endregion #endregion
@ -119,6 +119,7 @@ namespace OpenTK.Math
/// <summary>Indicates whether the current vector is equal to another vector.</summary> /// <summary>Indicates whether the current vector is equal to another vector.</summary>
/// <param name="vector">An vector to compare with this vector.</param> /// <param name="vector">An vector to compare with this vector.</param>
/// <returns>true if the current vector is equal to the vector parameter; otherwise, false.</returns> /// <returns>true if the current vector is equal to the vector parameter; otherwise, false.</returns>
[CLSCompliant(false)]
public bool Equals(Vector2d vector) public bool Equals(Vector2d vector)
{ {
return return

View file

@ -391,7 +391,7 @@ namespace OpenTK.OpenAL
#region Create Source objects #region Create Source objects
[CLSCompliant(false),DllImport(AL.Lib,EntryPoint = "alGenSources",ExactSpelling = true,CallingConvention = AL.Style),SuppressUnmanagedCodeSecurity( )] [DllImport(AL.Lib,EntryPoint = "alGenSources",ExactSpelling = true,CallingConvention = AL.Style),SuppressUnmanagedCodeSecurity( )]
unsafe private static extern void GenSourcesPrivate( int n,[Out] uint* sources ); unsafe private static extern void GenSourcesPrivate( int n,[Out] uint* sources );
// AL_API void AL_APIENTRY alGenSources( ALsizei n, ALuint* Sources ); // AL_API void AL_APIENTRY alGenSources( ALsizei n, ALuint* Sources );

View file

@ -21,7 +21,7 @@ namespace OpenTK.OpenAL
#region alGenEffects #region alGenEffects
// typedef void (__cdecl *LPALGENEFFECTS)( ALsizei n, ALuint* effects ); // typedef void (__cdecl *LPALGENEFFECTS)( ALsizei n, ALuint* effects );
[CLSCompliant(false)] //[CLSCompliant(false)]
unsafe private delegate void Delegate_alGenEffects( int n,[Out] uint* effects ); unsafe private delegate void Delegate_alGenEffects( int n,[Out] uint* effects );
//[CLSCompliant(false)] //[CLSCompliant(false)]
@ -63,7 +63,7 @@ namespace OpenTK.OpenAL
#region alDeleteEffects #region alDeleteEffects
// typedef void (__cdecl *LPALDELETEEFFECTS)( ALsizei n, ALuint* effects ); // typedef void (__cdecl *LPALDELETEEFFECTS)( ALsizei n, ALuint* effects );
[CLSCompliant(false)] //[CLSCompliant(false)]
unsafe private delegate void Delegate_alDeleteEffects( int n,[In] uint* effects ); unsafe private delegate void Delegate_alDeleteEffects( int n,[In] uint* effects );
//[CLSCompliant(false)] //[CLSCompliant(false)]
@ -173,11 +173,11 @@ namespace OpenTK.OpenAL
#region alEffectfv #region alEffectfv
[CLSCompliant(false)] //[CLSCompliant(false)]
unsafe private delegate void Delegate_alEffectfv(uint eid, Enums.EfxEffect3f param, [In] float* values); unsafe private delegate void Delegate_alEffectfv(uint eid, Enums.EfxEffect3f param, [In] float* values);
// typedef void (__cdecl *LPALEFFECTFV)( ALuint eid, ALenum param, ALfloat* values ); // typedef void (__cdecl *LPALEFFECTFV)( ALuint eid, ALenum param, ALfloat* values );
[CLSCompliant(false)] //[CLSCompliant(false)]
private Delegate_alEffectfv Imported_alEffectfv; private Delegate_alEffectfv Imported_alEffectfv;
[CLSCompliant(false)] [CLSCompliant(false)]
@ -665,10 +665,10 @@ namespace OpenTK.OpenAL
#region alGetAuxiliaryEffectSlotf #region alGetAuxiliaryEffectSlotf
// typedef void (__cdecl *LPALGETAUXILIARYEFFECTSLOTF)( ALuint asid, ALenum pname, ALfloat* value ); // typedef void (__cdecl *LPALGETAUXILIARYEFFECTSLOTF)( ALuint asid, ALenum pname, ALfloat* value );
[CLSCompliant(false)] //[CLSCompliant(false)]
unsafe private delegate void Delegate_alGetAuxiliaryEffectSlotf( uint asid,Enums.EfxAuxiliaryf pname,[Out] float* value ); unsafe private delegate void Delegate_alGetAuxiliaryEffectSlotf( uint asid,Enums.EfxAuxiliaryf pname,[Out] float* value );
[CLSCompliant(false)] //[CLSCompliant(false)]
private Delegate_alGetAuxiliaryEffectSlotf Imported_alGetAuxiliaryEffectSlotf; private Delegate_alGetAuxiliaryEffectSlotf Imported_alGetAuxiliaryEffectSlotf;
/// <summary>This function is used to retrieve floating properties on Auxiliary Effect Slot objects.</summary> /// <summary>This function is used to retrieve floating properties on Auxiliary Effect Slot objects.</summary>

View file

@ -16,21 +16,23 @@ namespace OpenTK.OpenAL
public partial class EfxExtension public partial class EfxExtension
{ {
// TODO: CLS compliance.
[CLSCompliant(false)]
public struct EaxReverb public struct EaxReverb
{ {
public uint _Environment; public uint Environment; // TODO: EAX-EFX conversion
public float _EnvironmentSize; public float EnvironmentSize; // TODO: EAX-EFX conversion
public float _EnvironmentDiffusion; public float EnvironmentDiffusion; // TODO: EAX-EFX conversion
public int _Room; public int Room; // TODO: EAX-EFX conversion
public int _RoomHF; public int RoomHF; // TODO: EAX-EFX conversion
public int _RoomLF; public int RoomLF; // TODO: EAX-EFX conversion
public float DecayTime; public float DecayTime;
public float DecayHFRatio; public float DecayHFRatio;
public float DecayLFRatio; public float DecayLFRatio;
public int _Reflections; public int Reflections; // TODO: EAX-EFX conversion
public float ReflectionsDelay; public float ReflectionsDelay;
public Vector3 ReflectionsPan; public Vector3 ReflectionsPan;
public int _Reverb; public int Reverb; // TODO: EAX-EFX conversion
public float ReverbDelay; public float ReverbDelay;
public Vector3 ReverbPan; public Vector3 ReverbPan;
public float EchoTime; public float EchoTime;
@ -41,7 +43,7 @@ namespace OpenTK.OpenAL
public float HFReference; public float HFReference;
public float LFReference; public float LFReference;
public float RoomRolloffFactor; public float RoomRolloffFactor;
public uint _Flags; public uint Flags; // TODO: EAX-EFX conversion
public EaxReverb( uint environment, public EaxReverb( uint environment,
float environmentSize, float environmentSize,
@ -72,19 +74,19 @@ namespace OpenTK.OpenAL
float roomRolloffFactor, float roomRolloffFactor,
uint flags ) uint flags )
{ {
_Environment = environment; Environment = environment;
_EnvironmentSize = environmentSize; EnvironmentSize = environmentSize;
_EnvironmentDiffusion = environmentDiffusion; EnvironmentDiffusion = environmentDiffusion;
_Room = room; Room = room;
_RoomHF = roomHF; RoomHF = roomHF;
_RoomLF = roomLF; RoomLF = roomLF;
DecayTime = decayTime; DecayTime = decayTime;
DecayHFRatio = decayHFRatio; DecayHFRatio = decayHFRatio;
DecayLFRatio = decayLFRatio; DecayLFRatio = decayLFRatio;
_Reflections = reflections; Reflections = reflections;
ReflectionsDelay = reflectionsDelay; ReflectionsDelay = reflectionsDelay;
ReflectionsPan = new Vector3(reflectionsPanX,reflectionsPanY,reflectionsPanZ); ReflectionsPan = new Vector3(reflectionsPanX,reflectionsPanY,reflectionsPanZ);
_Reverb = reverb; Reverb = reverb;
ReverbDelay = reverbDelay; ReverbDelay = reverbDelay;
ReverbPan = new Vector3(reverbPanX,reverbPanY,reverbPanZ); ReverbPan = new Vector3(reverbPanX,reverbPanY,reverbPanZ);
EchoTime = echoTime; EchoTime = echoTime;
@ -95,11 +97,13 @@ namespace OpenTK.OpenAL
HFReference = hfReference; HFReference = hfReference;
LFReference = lfReference; LFReference = lfReference;
RoomRolloffFactor = roomRolloffFactor; RoomRolloffFactor = roomRolloffFactor;
_Flags = flags; Flags = flags;
} }
} }
// TODO: CLS compliance.
[CLSCompliant(false)]
public static void GetEaxFromEfxEax( ref EaxReverb input,out EfxEaxReverb output ) public static void GetEaxFromEfxEax( ref EaxReverb input,out EfxEaxReverb output )
{ {
output.AirAbsorptionGainHF = 0.995f; // input.AirAbsorptionHF * somegain? output.AirAbsorptionGainHF = 0.995f; // input.AirAbsorptionHF * somegain?
@ -200,8 +204,9 @@ namespace OpenTK.OpenAL
void ConvertOcclusionParameters(EAXOCCLUSIONPROPERTIES *pOcProp, EFXLOWPASSFILTER *pDirectLowPassFilter, EFXLOWPASSFILTER *pSendLowPassFilter); void ConvertOcclusionParameters(EAXOCCLUSIONPROPERTIES *pOcProp, EFXLOWPASSFILTER *pDirectLowPassFilter, EFXLOWPASSFILTER *pSendLowPassFilter);
*/ */
// TODO: CLS compliance.
///<summary>EAX Reverb Presets in legacy format - use ConvertReverbParameters() to convert to EFX EAX Reverb Presets for use with the OpenAL Effects Extension.</summary> ///<summary>EAX Reverb Presets in legacy format - use ConvertReverbParameters() to convert to EFX EAX Reverb Presets for use with the OpenAL Effects Extension.</summary>
[CLSCompliant(false)]
public static class ReverbPresets public static class ReverbPresets
{ {
// CASTLE PRESETS // CASTLE PRESETS

View file

@ -42,6 +42,7 @@ namespace OpenTK.Platform
public IntPtr GetCurrentContext() { return IntPtr.Zero; } public IntPtr GetCurrentContext() { return IntPtr.Zero; }
public event DestroyEvent<IGLContext> Destroy; public event DestroyEvent<IGLContext> Destroy;
void OnDestroy() { if (Destroy != null) Destroy(this, EventArgs.Empty); }
public void RegisterForDisposal(IDisposable resource) public void RegisterForDisposal(IDisposable resource)
{ {

View file

@ -186,6 +186,7 @@ namespace OpenTK.Platform.Windows
#endif #endif
#endregion #endregion
/// <summary>Contains ARB extensions for WGL.</summary>
public static partial class Arb public static partial class Arb
{ {
private static string[] extensions; private static string[] extensions;
@ -211,5 +212,32 @@ namespace OpenTK.Platform.Windows
return false; return false;
} }
} }
/// <summary>Contains EXT extensions for WGL.</summary>
public static partial class Ext
{
private static string[] extensions;
/// <summary>
/// Checks if a Wgl extension is supported by the given context.
/// </summary>
/// <param name="deviceContext">The device context.</param>
/// <param name="ext">The extension to check.</param>
/// <returns>True if the extension is supported by the given context, false otherwise</returns>
public static bool SupportsExtension(IntPtr deviceContext, string ext)
{
if (Wgl.Delegates.wglGetExtensionsStringEXT != null)
{
if (extensions == null || reload_ext_extension_strings)
{
extensions = Wgl.Ext.GetExtensionsString().Split(" ".ToCharArray(), StringSplitOptions.RemoveEmptyEntries);
Array.Sort(extensions);
reload_ext_extension_strings = false;
}
return Array.BinarySearch(extensions, ext) != -1;
}
return false;
}
}
} }
} }

View file

@ -254,16 +254,23 @@ namespace OpenTK.Platform.Windows
#endregion #endregion
#region void IGLContextInternal.RegisterForDisposal(IDisposable resource)
void IGLContextInternal.RegisterForDisposal(IDisposable resource) void IGLContextInternal.RegisterForDisposal(IDisposable resource)
{ {
throw new NotImplementedException("Use the general GLContext class instead."); throw new NotSupportedException("Use OpenTK.GLContext instead.");
} }
#endregion
#region void IGLContextInternal.DisposeResources()
void IGLContextInternal.DisposeResources() void IGLContextInternal.DisposeResources()
{ {
throw new NotImplementedException("Use the general GLContext class instead."); throw new NotSupportedException("Use OpenTK.GLContext instead.");
} }
#endregion
#endregion #endregion

View file

@ -308,6 +308,16 @@ namespace OpenTK.Platform.X11
#endregion #endregion
#region --- Public Methods ---
void OnDestroy()
{
if (Destroy != null)
Destroy(this, EventArgs.Empty);
}
#endregion
#region --- IDisposable Members --- #region --- IDisposable Members ---
public void Dispose() public void Dispose()

View file

@ -400,7 +400,7 @@ namespace OpenTK.Platform.X11
// Register for window destroy notification // Register for window destroy notification
IntPtr wm_destroy_atom = Functions.XInternAtom(window.Display, IntPtr wm_destroy_atom = Functions.XInternAtom(window.Display,
"WM_DELETE_WINDOW", true); "WM_DELETE_WINDOW", true);
XWMHints hint = new XWMHints(); //XWMHints hint = new XWMHints();
Functions.XSetWMProtocols(window.Display, window.Handle, new IntPtr[] { wm_destroy_atom }, 1); Functions.XSetWMProtocols(window.Display, window.Handle, new IntPtr[] { wm_destroy_atom }, 1);
Top = Left = 0; Top = Left = 0;