ryujinx/Opentk
1
0
Fork 0
mirror of https://github.com/Ryujinx/Opentk.git synced 2024-12-23 07:15:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed a large number of recurring spelling mistakes in documentation (patch by iRBiS). Fixes issue [#1341]: "Vector4 constructor describes w component as z component + other spelling corrections".

Browse source
This commit is contained in:
the_fiddler 2009-11-09 08:15:38 +00:00
parent d4457c6ce1
commit 9eb504eb4e
26 changed files with 435 additions and 435 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
Source/Compatibility/Audio/OpenAL/AL/AL.cs
View file

@ -143,15 +143,15 @@ namespace OpenTK.Audio
public static extern int Get(ALGetInteger param);
// AL_API ALint AL_APIENTRY alGetInteger( ALenum param );
/// <summary>This function returns a floating point OpenAL state.</summary>
/// <summary>This function returns a floating-point OpenAL state.</summary>
/// <param name="param">the state to be queried: DopplerFactor, SpeedOfSound.</param>
/// <returns>The floating point state described by param will be returned.</returns>
/// <returns>The floating-point state described by param will be returned.</returns>
[DllImport(AL.Lib, EntryPoint = "alGetFloat", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern float Get(ALGetFloat param);
// AL_API ALfloat AL_APIENTRY alGetFloat( ALenum param );
/* disabled due to no token using it
/// <summary>This function returns a double precision floating point OpenAL state.</summary>
/// <summary>This function returns a double-precision floating-point OpenAL state.</summary>
/// <param name="param">the state to be queried: AL_DOPPLER_FACTOR, AL_SPEED_OF_SOUND, AL_DISTANCE_MODEL</param>
/// <returns>The double value described by param will be returned.</returns>
[DllImport( AL.Lib, EntryPoint = "alGetDouble", ExactSpelling = true, CallingConvention = AL.Style ), SuppressUnmanagedCodeSecurity( )]
@ -206,14 +206,14 @@ namespace OpenTK.Audio
#region Set Listener parameters
/// <summary>This function sets a floating point property for the listener.</summary>
/// <summary>This function sets a floating-point property for the listener.</summary>
/// <param name="param">The name of the attribute to be set: ALListenerf.Gain</param>
/// <param name="value">The float value to set the attribute to.</param>
[DllImport(AL.Lib, EntryPoint = "alListenerf", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void Listener(ALListenerf param, float value);
// AL_API void AL_APIENTRY alListenerf( ALenum param, ALfloat value );
/// <summary>This function sets a floating point property for the listener.</summary>
/// <summary>This function sets a floating-point property for the listener.</summary>
/// <param name="param">The name of the attribute to set: ALListener3f.Position, ALListener3f.Velocity</param>
/// <param name="value1">The value to set the attribute to.</param>
/// <param name="value2">The value to set the attribute to.</param>
@ -234,9 +234,9 @@ namespace OpenTK.Audio
unsafe private static extern void ListenerPrivate(ALListenerfv param, float* values);
// AL_API void AL_APIENTRY alListenerfv( ALenum param, const ALfloat* values );
/// <summary>This function sets a floating point-vector property of the listener.</summary>
/// <summary>This function sets a floating-point vector property of the listener.</summary>
/// <param name="param">The name of the attribute to be set: ALListener3f.Position, ALListener3f.Velocity, ALListenerfv.Orientation</param>
/// <param name="values">Pointer to floating point-vector values.</param>
/// <param name="values">Pointer to floating-point vector values.</param>
public static void Listener(ALListenerfv param, ref float[] values)
{
unsafe
@ -282,18 +282,18 @@ namespace OpenTK.Audio
#region Get Listener parameters
/// <summary>This function retrieves a floating point property of the listener.</summary>
/// <summary>This function retrieves a floating-point property of the listener.</summary>
/// <param name="param">the name of the attribute to be retrieved: ALListenerf.Gain</param>
/// <param name="value">a pointer to the floating point value being retrieved.</param>
/// <param name="value">a pointer to the floating-point value being retrieved.</param>
[DllImport(AL.Lib, EntryPoint = "alGetListenerf", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetListener(ALListenerf param, [Out] out float value);
// AL_API void AL_APIENTRY alGetListenerf( ALenum param, ALfloat* value );
/// <summary>This function retrieves a set of three floating point values from a property of the listener.</summary>
/// <summary>This function retrieves a set of three floating-point values from a property of the listener.</summary>
/// <param name="param">The name of the attribute to be retrieved: ALListener3f.Position, ALListener3f.Velocity</param>
/// <param name="value1">Pointers to the three floating point being retrieved.</param>
/// <param name="value2">Pointers to the three floating point being retrieved.</param>
/// <param name="value3">Pointers to the three floating point being retrieved.</param>
/// <param name="value1">Pointers to the three floating-point being retrieved.</param>
/// <param name="value2">Pointers to the three floating-point being retrieved.</param>
/// <param name="value3">Pointers to the three floating-point being retrieved.</param>
[DllImport(AL.Lib, EntryPoint = "alGetListener3f", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetListener(ALListener3f param, [Out] out float value1, [Out] out float value2, [Out] out float value3);
// AL_API void AL_APIENTRY alGetListener3f( ALenum param, ALfloat *value1, ALfloat *value2, ALfloat *value3 );
@ -306,9 +306,9 @@ namespace OpenTK.Audio
GetListener(param, out values.X, out values.Y, out values.Z);
}
/// <summary>This function retrieves a floating point-vector property of the listener. You must pin it manually.</summary>
/// <summary>This function retrieves a floating-point vector property of the listener. You must pin it manually.</summary>
/// <param name="param">the name of the attribute to be retrieved: ALListener3f.Position, ALListener3f.Velocity, ALListenerfv.Orientation</param>
/// <param name="values">A pointer to the floating point-vector value being retrieved.</param>
/// <param name="values">A pointer to the floating-point vector value being retrieved.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alGetListenerfv", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
unsafe public static extern void GetListener(ALListenerfv param, float* values);
// AL_API void AL_APIENTRY alGetListenerfv( ALenum param, ALfloat* values );
@ -540,7 +540,7 @@ namespace OpenTK.Audio
#region Sourcef
/// <summary>This function sets a floating point property of a source.</summary>
/// <summary>This function sets a floating-point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being set</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">The value to set the attribute to.</param>
@ -548,7 +548,7 @@ namespace OpenTK.Audio
public static extern void Source(uint sid, ALSourcef param, float value);
// AL_API void AL_APIENTRY alSourcef( ALuint sid, ALenum param, ALfloat value );
/// <summary>This function sets a floating point property of a source.</summary>
/// <summary>This function sets a floating-point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being set</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">The value to set the attribute to.</param>
@ -562,7 +562,7 @@ namespace OpenTK.Audio
#region Source3f
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <summary>This function sets a source property requiring three floating-point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">The three ALfloat values which the attribute will be set to.</param>
@ -572,7 +572,7 @@ namespace OpenTK.Audio
public static extern void Source(uint sid, ALSource3f param, float value1, float value2, float value3);
// AL_API void AL_APIENTRY alSource3f( ALuint sid, ALenum param, ALfloat value1, ALfloat value2, ALfloat value3 );
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <summary>This function sets a source property requiring three floating-point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">The three ALfloat values which the attribute will be set to.</param>
@ -584,7 +584,7 @@ namespace OpenTK.Audio
Source((uint)sid, param, value1, value2, value3);
}
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <summary>This function sets a source property requiring three floating-point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 which the attribute will be set to.</param>
@ -594,7 +594,7 @@ namespace OpenTK.Audio
Source(sid, param, values.X, values.Y, values.Z);
}
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <summary>This function sets a source property requiring three floating-point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 which the attribute will be set to.</param>
@ -702,18 +702,18 @@ namespace OpenTK.Audio
#region GetSourcef
/// <summary>This function retrieves a floating point property of a source.</summary>
/// <summary>This function retrieves a floating-point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">A pointer to the floating point value being retrieved</param>
/// <param name="value">A pointer to the floating-point value being retrieved</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alGetSourcef", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetSource(uint sid, ALSourcef param, [Out] out float value);
// AL_API void AL_APIENTRY alGetSourcef( ALuint sid, ALenum param, ALfloat* value );
/// <summary>This function retrieves a floating point property of a source.</summary>
/// <summary>This function retrieves a floating-point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">A pointer to the floating point value being retrieved</param>
/// <param name="value">A pointer to the floating-point value being retrieved</param>
[CLSCompliant(true)]
public static void GetSource(int sid, ALSourcef param, out float value)
{
@ -724,7 +724,7 @@ namespace OpenTK.Audio
#region GetSource3f
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <summary>This function retrieves three floating-point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">Pointer to the value to retrieve.</param>
@ -734,7 +734,7 @@ namespace OpenTK.Audio
public static extern void GetSource(uint sid, ALSource3f param, [Out] out float value1, [Out] out float value2, [Out] out float value3);
// AL_API void AL_APIENTRY alGetSource3f( ALuint sid, ALenum param, ALfloat* value1, ALfloat* value2, ALfloat* value3);
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <summary>This function retrieves three floating-point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">Pointer to the value to retrieve.</param>
@ -746,7 +746,7 @@ namespace OpenTK.Audio
GetSource((uint)sid, param, out value1, out value2, out value3);
}
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <summary>This function retrieves three floating-point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 to retrieve the values to.</param>
@ -756,7 +756,7 @@ namespace OpenTK.Audio
GetSource(sid, param, out values.X, out values.Y, out values.Z);
}
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <summary>This function retrieves three floating-point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 to retrieve the values to.</param>

48
Source/Compatibility/Audio/OpenAL/AL/ALEnums.cs
View file

@ -19,7 +19,7 @@ namespace OpenTK.Audio
Invalid = -1,
}
///<summary>A list of valid 32-Bits Float Listener/GetListener parameters</summary>
///<summary>A list of valid 32-bit Float Listener/GetListener parameters</summary>
public enum ALListenerf : int
{
///<summary>Indicate the gain (Volume amplification) applied. Type: float Range: [0.0f - ? ] A value of 1.0 means un-attenuated/unchanged. Each division by 2 equals an attenuation of -6dB. Each multiplicaton with 2 equals an amplification of +6dB. A value of 0.0f is interpreted as zero volume and the channel is effectively disabled.</summary>
@ -46,7 +46,7 @@ namespace OpenTK.Audio
Orientation = 0x100F,
}
///<summary>A list of valid 32-Bits Float Source/GetSource parameters</summary>
///<summary>A list of valid 32-bit Float Source/GetSource parameters</summary>
public enum ALSourcef : int
{
///<summary>Source specific reference distance. Type: float Range: [0.0f - float.PositiveInfinity] At 0.0f, no distance attenuation occurs. Type: float Default: 1.0f.</summary>
@ -106,7 +106,7 @@ namespace OpenTK.Audio
Direction = 0x1005,
}
///<summary>A list of valid 8-Bits boolean Source/GetSource parameters</summary>
///<summary>A list of valid 8-bit boolean Source/GetSource parameters</summary>
public enum ALSourceb : int
{
///<summary>Indicate that the Source has relative coordinates. Type: bool Range: [True, False]</summary>
@ -216,16 +216,16 @@ namespace OpenTK.Audio
///<summary>Sound samples: Format specifier.</summary>
public enum ALFormat : int
{
///<summary>1 Channel, 8 Bits per sample.</summary>
///<summary>1 Channel, 8 bits per sample.</summary>
Mono8 = 0x1100,
///<summary>1 Channel, 16 Bits per sample.</summary>
///<summary>1 Channel, 16 bits per sample.</summary>
Mono16 = 0x1101,
///<summary>2 Channels, 8 Bits per sample each.</summary>
///<summary>2 Channels, 8 bits per sample each.</summary>
Stereo8 = 0x1102,
///<summary>2 Channels, 16 Bits per sample each.</summary>
///<summary>2 Channels, 16 bits per sample each.</summary>
Stereo16 = 0x1103,
/// <summary>1 Channel, A-law encoded data. Requires Extension: AL_EXT_ALAW</summary>
@ -264,56 +264,56 @@ namespace OpenTK.Audio
/// <summary>2 Channels, double-precision floating-point data. Requires Extension: AL_EXT_double</summary>
StereoDoubleExt = 0x10013,
/// <summary>Multichannel 5.1, 16 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 5.1, 16-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi51Chn16Ext = 0x120B,
/// <summary>Multichannel 5.1, 32 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 5.1, 32-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi51Chn32Ext = 0x120C,
/// <summary>Multichannel 5.1, 8 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 5.1, 8-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi51Chn8Ext = 0x120A,
/// <summary>Multichannel 6.1, 16 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 6.1, 16-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi61Chn16Ext = 0x120E,
/// <summary>Multichannel 6.1, 32 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 6.1, 32-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi61Chn32Ext = 0x120F,
/// <summary>Multichannel 6.1, 8 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 6.1, 8-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi61Chn8Ext = 0x120D,
/// <summary>Multichannel 7.1, 16 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 7.1, 16-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi71Chn16Ext = 0x1211,
/// <summary>Multichannel 7.1, 32 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 7.1, 32-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi71Chn32Ext = 0x1212,
/// <summary>Multichannel 7.1, 8 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 7.1, 8-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi71Chn8Ext = 0x1210,
/// <summary>Multichannel 4.0, 16 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 4.0, 16-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiQuad16Ext = 0x1205,
/// <summary>Multichannel 4.0, 32 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 4.0, 32-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiQuad32Ext = 0x1206,
/// <summary>Multichannel 4.0, 8 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 4.0, 8-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiQuad8Ext = 0x1204,
/// <summary>1 Channel rear speaker, 16 Bits data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>1 Channel rear speaker, 16-bit data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiRear16Ext = 0x1208,
/// <summary>1 Channel rear speaker, 32 Bits data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>1 Channel rear speaker, 32-bit data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiRear32Ext = 0x1209,
/// <summary>1 Channel rear speaker, 8 Bits data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>1 Channel rear speaker, 8-bit data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiRear8Ext = 0x1207,
}
///<summary>A list of valid Int32 GetBuffer parameters</summary>
public enum ALGetBufferi : int
{
///<summary>Sound sample's frequency, in units of Hertz [Hz]. This is the number of samples per second. Half of the sample frequency marks the maximum significant frequency component.</summary>
///<summary>Sound sample's frequency, in units of hertz [Hz]. This is the number of samples per second. Half of the sample frequency marks the maximum significant frequency component.</summary>
Frequency = 0x2001,
/// <summary>Bit depth of the buffer. Should be 8 or 16.</summary>
@ -383,7 +383,7 @@ namespace OpenTK.Audio
Extensions = 0xB004,
}
///<summary>A list of valid 32-Bits Float AL.Get() parameters</summary>
///<summary>A list of valid 32-bit Float AL.Get() parameters</summary>
public enum ALGetFloat : int
{
///<summary>Doppler scale. Default 1.0f</summary>

52
Source/Compatibility/Audio/OpenAL/AL/EffectsExtension.cs
View file

@ -351,20 +351,20 @@ namespace OpenTK.Audio
//[CLSCompliant(false)]
private Delegate_alEffectf Imported_alEffectf;
/// <summary>This function is used to set floating point properties on Effect objects.</summary>
/// <summary>This function is used to set floating-point properties on Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
[CLSCompliant(false)]
public void Effect(uint eid, EfxEffectf param, float value)
{
Imported_alEffectf(eid, param, value);
}
/// <summary>This function is used to set floating point properties on Effect objects.</summary>
/// <summary>This function is used to set floating-point properties on Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
public void Effect(int eid, EfxEffectf param, float value)
{
@ -382,7 +382,7 @@ namespace OpenTK.Audio
//[CLSCompliant(false)]
private Delegate_alEffectfv Imported_alEffectfv;
/// <summary>This function is used to set 3 floating point properties on Effect objects.</summary>
/// <summary>This function is used to set 3 floating-point properties on Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="values">Pointer to Math.Vector3.</param>
@ -398,7 +398,7 @@ namespace OpenTK.Audio
}
}
/// <summary>This function is used to set 3 floating point properties on Effect objects.</summary>
/// <summary>This function is used to set 3 floating-point properties on Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="values">Pointer to Math.Vector3.</param>
@ -456,10 +456,10 @@ namespace OpenTK.Audio
//[CLSCompliant(false)]
private Delegate_alGetEffectf Imported_alGetEffectf;
/// <summary>This function is used to retrieve floating point properties from Effect objects.</summary>
/// <summary>This function is used to retrieve floating-point properties from Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="pname">Effect property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
[CLSCompliant(false)]
public void GetEffect(uint eid, EfxEffectf pname, out float value)
{
@ -472,10 +472,10 @@ namespace OpenTK.Audio
}
}
/// <summary>This function is used to retrieve floating point properties from Effect objects.</summary>
/// <summary>This function is used to retrieve floating-point properties from Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="pname">Effect property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
public void GetEffect(int eid, EfxEffectf pname, out float value)
{
@ -493,7 +493,7 @@ namespace OpenTK.Audio
//[CLSCompliant(false)]
private Delegate_alGetEffectfv Imported_alGetEffectfv;
/// <summary>This function is used to retrieve 3 floating point properties from Effect objects.</summary>
/// <summary>This function is used to retrieve 3 floating-point properties from Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to retrieve.</param>
/// <param name="values">A Math.Vector3 to hold the values.</param>
@ -512,7 +512,7 @@ namespace OpenTK.Audio
}
}
/// <summary>This function is used to retrieve 3 floating point properties from Effect objects.</summary>
/// <summary>This function is used to retrieve 3 floating-point properties from Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to retrieve.</param>
/// <param name="values">A Math.Vector3 to hold the values.</param>
@ -761,20 +761,20 @@ namespace OpenTK.Audio
//[CLSCompliant(false)]
private Delegate_alFilterf Imported_alFilterf;
/// <summary>This function is used to set floating point properties on Filter objects.</summary>
/// <summary>This function is used to set floating-point properties on Filter objects.</summary>
/// <param name="fid">Filter object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
[CLSCompliant(false)]
public void Filter(uint fid, EfxFilterf param, float value)
{
Imported_alFilterf(fid, param, value);
}
/// <summary>This function is used to set floating point properties on Filter objects.</summary>
/// <summary>This function is used to set floating-point properties on Filter objects.</summary>
/// <param name="fid">Filter object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
public void Filter(int fid, EfxFilterf param, float value)
{
@ -829,10 +829,10 @@ namespace OpenTK.Audio
//[CLSCompliant(false)]
private Delegate_alGetFilterf Imported_alGetFilterf;
/// <summary>This function is used to retrieve floating point properties from Filter objects.</summary>
/// <summary>This function is used to retrieve floating-point properties from Filter objects.</summary>
/// <param name="fid">Filter object identifier.</param>
/// <param name="pname">Effect property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
[CLSCompliant(false)]
public void GetFilter(uint fid, EfxFilterf pname, out float value)
{
@ -845,10 +845,10 @@ namespace OpenTK.Audio
}
}
/// <summary>This function is used to retrieve floating point properties from Filter objects.</summary>
/// <summary>This function is used to retrieve floating-point properties from Filter objects.</summary>
/// <param name="fid">Filter object identifier.</param>
/// <param name="pname">Effect property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
public void GetFilter(int fid, EfxFilterf pname, out float value)
{
@ -1092,20 +1092,20 @@ namespace OpenTK.Audio
//[CLSCompliant(false)]
private Delegate_alAuxiliaryEffectSlotf Imported_alAuxiliaryEffectSlotf;
/// <summary>This function is used to set floating point properties on Auxiliary Effect Slot objects.</summary>
/// <summary>This function is used to set floating-point properties on Auxiliary Effect Slot objects.</summary>
/// <param name="asid">Auxiliary Effect Slot object identifier.</param>
/// <param name="param">Auxiliary Effect Slot property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
[CLSCompliant(false)]
public void AuxiliaryEffectSlot(uint asid, EfxAuxiliaryf param, float value)
{
Imported_alAuxiliaryEffectSlotf(asid, param, value);
}
/// <summary>This function is used to set floating point properties on Auxiliary Effect Slot objects.</summary>
/// <summary>This function is used to set floating-point properties on Auxiliary Effect Slot objects.</summary>
/// <param name="asid">Auxiliary Effect Slot object identifier.</param>
/// <param name="param">Auxiliary Effect Slot property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
public void AuxiliaryEffectSlot(int asid, EfxAuxiliaryf param, float value)
{
@ -1163,7 +1163,7 @@ namespace OpenTK.Audio
/// <summary>This function is used to retrieve floating properties on Auxiliary Effect Slot objects.</summary>
/// <param name="asid">Auxiliary Effect Slot object identifier.</param>
/// <param name="pname">Auxiliary Effect Slot property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
[CLSCompliant(false)]
public void GetAuxiliaryEffectSlot(uint asid, EfxAuxiliaryf pname, out float value)
{
@ -1179,7 +1179,7 @@ namespace OpenTK.Audio
/// <summary>This function is used to retrieve floating properties on Auxiliary Effect Slot objects.</summary>
/// <param name="asid">Auxiliary Effect Slot object identifier.</param>
/// <param name="pname">Auxiliary Effect Slot property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
public void GetAuxiliaryEffectSlot(int asid, EfxAuxiliaryf pname, out float value)
{

6
Source/Compatibility/Audio/OpenAL/AL/EffectsExtensionEnums.cs
View file

@ -13,7 +13,7 @@ namespace OpenTK.Audio
{
#region Effect
///<summary>A list of valid 32-Bits Float Effect/GetEffect parameters</summary>
///<summary>A list of valid 32-bit Float Effect/GetEffect parameters</summary>
public enum EfxEffectf : int
{
///<summary>Reverb Modal Density controls the coloration of the late reverb. Lowering the value adds more coloration to the late reverb. Range [0.0f .. 1.0f] Default: 1.0f</summary>
@ -305,7 +305,7 @@ namespace OpenTK.Audio
EffectslotAuxiliarySendAuto = 0x0003,
}
///<summary>A list of valid 32-Bits Float AuxiliaryEffectSlot/GetAuxiliaryEffectSlot parameters</summary>
///<summary>A list of valid 32-bits Float AuxiliaryEffectSlot/GetAuxiliaryEffectSlot parameters</summary>
public enum EfxAuxiliaryf : int
{
/// <summary>This property is used to specify an output level for the Auxiliary Effect Slot. Setting the gain to 0.0f mutes the output. Range [0.0f .. 1.0f] Default: 1.0f</summary>
@ -316,7 +316,7 @@ namespace OpenTK.Audio
#region Filter Object
///<summary>A list of valid 32-Bits Float Filter/GetFilter parameters</summary>
///<summary>A list of valid 32-bits Float Filter/GetFilter parameters</summary>
public enum EfxFilterf : int
{
///<summary>Range [0.0f .. 1.0f] Default: 1.0f</summary>

4
Source/Compatibility/Audio/OpenAL/Alut/Alut.cs
View file

@ -111,9 +111,9 @@ namespace OpenTK.Audio
public static extern uint CreateBufferHelloWorld();
//ALUT_API ALuint ALUT_APIENTRY alutCreateBufferHelloWorld (void);
/// <summary>Alut.CreateBufferWaveform returns a handle to an OpenAL buffer containing a snippet of audio with the specified waveshape at the specified frequency (in Hertz), phase (in degrees: -180 to +180) and duration (in seconds).</summary>
/// <summary>Alut.CreateBufferWaveform returns a handle to an OpenAL buffer containing a snippet of audio with the specified waveshape at the specified frequency (in hertz), phase (in degrees: -180 to +180) and duration (in seconds).</summary>
/// <param name="waveshape"></param>
/// <param name="frequency">Frequency in Hertz [Hz].</param>
/// <param name="frequency">Frequency in hertz [Hz].</param>
/// <param name="phase">Phase (in degrees: -180 to +180)</param>
/// <param name="duration">Duration (in seconds)</param>
/// <returns>OpenAL Buffer, 0 on failure.</returns>

8
Source/Compatibility/Audio/WaveReader.cs
View file

@ -69,14 +69,14 @@ namespace OpenTK.Audio
{
if (BitsPerSample == 16)
{
Console.Write("Uploading 16 bit mono data to OpenAL...");
Console.Write("Uploading 16-bit mono data to OpenAL...");
AL.BufferData(bid, ALFormat.Mono16, (IntPtr)p_Data, _Data.Length, SampleRate);
}
else
{
if (BitsPerSample == 8)
{
Console.Write("Uploading 8 bit mono data to OpenAL...");
Console.Write("Uploading 8-bit mono data to OpenAL...");
AL.BufferData(bid, ALFormat.Mono8, (IntPtr)p_Data, _Data.Length, SampleRate);
}
}
@ -88,14 +88,14 @@ namespace OpenTK.Audio
{
if (BitsPerSample == 16)
{
Console.Write("Uploading 16 bit stereo data to OpenAL...");
Console.Write("Uploading 16-bit stereo data to OpenAL...");
AL.BufferData(bid, ALFormat.Stereo16, (IntPtr)p_Data, _Data.Length, SampleRate);
}
else
{
if (BitsPerSample == 8)
{
Console.Write("Uploading 8 bit stereo data to OpenAL...");
Console.Write("Uploading 8-bit stereo data to OpenAL...");
AL.BufferData(bid, ALFormat.Stereo8, (IntPtr)p_Data, _Data.Length, SampleRate);
}
}

48
Source/Compatibility/Math/Half.cs
View file

@ -66,7 +66,7 @@ namespace OpenTK.Math
/// <summary>
/// The name Half is derived from half-precision floating-point number.
/// It occupies only 16 Bits, which are split into 1 Sign bit, 5 Exponent bits and 10 Mantissa bits.
/// It occupies only 16 bits, which are split into 1 Sign bit, 5 Exponent bits and 10 Mantissa bits.
/// </summary>
/// <remarks>
/// Quote from ARB_half_float_pixel specification:
@ -104,9 +104,9 @@ namespace OpenTK.Math
#region Constructors
/// <summary>
/// The new Half instance will convert the parameter into 16-Bit Half precision floating point.
/// The new Half instance will convert the parameter into 16-bit half-precision floating-point.
/// </summary>
/// <param name="f">32-Bit Single precision floating point number.</param>
/// <param name="f">32-bit single-precision floating-point number.</param>
public Half(Single f)
: this()
{
@ -117,9 +117,9 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half instance will convert the parameter into 16-Bit Half precision floating point.
/// The new Half instance will convert the parameter into 16-bit half-precision floating-point.
/// </summary>
/// <param name="f">32-Bit Single precision floating point number.</param>
/// <param name="f">32-bit single-precision floating-point number.</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
public Half(Single f, bool throwOnError)
: this(f)
@ -131,22 +131,22 @@ namespace OpenTK.Math
if (f < -Half.MaxValue) throw new ArithmeticException("Half: Negative minimum value exceeded.");
// handle cases that make no sense
if (Single.IsNaN(f)) throw new ArithmeticException("Half: input is Not a Number (NaN).");
if (Single.IsPositiveInfinity(f)) throw new ArithmeticException("Half: input is +infinity.");
if (Single.IsNegativeInfinity(f)) throw new ArithmeticException("Half: input is -infinity.");
if (Single.IsNaN(f)) throw new ArithmeticException("Half: Input is not a number (NaN).");
if (Single.IsPositiveInfinity(f)) throw new ArithmeticException("Half: Input is positive infinity.");
if (Single.IsNegativeInfinity(f)) throw new ArithmeticException("Half: Input is negative infinity.");
}
}
/// <summary>
/// The new Half instance will convert the parameter into 16-Bit Half precision floating point.
/// The new Half instance will convert the parameter into 16-bit half-precision floating-point.
/// </summary>
/// <param name="d">64-Bit Double precision floating point number.</param>
/// <param name="d">64-bit double-precision floating-point number.</param>
public Half(Double d) : this((Single)d) { }
/// <summary>
/// The new Half instance will convert the parameter into 16-Bit Half precision floating point.
/// The new Half instance will convert the parameter into 16-bit half-precision floating-point.
/// </summary>
/// <param name="d">64-Bit Double precision floating point number.</param>
/// <param name="d">64-bit double-precision floating-point number.</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
public Half(Double d, bool throwOnError) : this((Single)d, throwOnError) { }
@ -236,7 +236,7 @@ namespace OpenTK.Math
}
// exponent overflow
if (exponent > 30) throw new ArithmeticException("Half: hardware floating point overflow.");
if (exponent > 30) throw new ArithmeticException("Half: Hardware floating-point overflow.");
// Assemble the half from S, E and M.
@ -248,8 +248,8 @@ namespace OpenTK.Math
#region Half -> Single
/// <summary>Converts the 16-Bit half to 32-Bit floating point.</summary>
/// <returns>A Single precision floating point Number.</returns>
/// <summary>Converts the 16-bit half to 32-bit floating-point.</summary>
/// <returns>A single-precision floating-point number.</returns>
public Single ToSingle()
{
int i = HalfToFloat(bits);
@ -505,7 +505,7 @@ namespace OpenTK.Math
}
/// <summary>Converts this Half into a human-legible string representation.</summary>
/// <param name="format">formatting for the output string.</param>
/// <param name="format">Formatting for the output string.</param>
/// <param name="formatProvider">Culture-specific formatting information.</param>
/// <returns>The string representation of this instance.</returns>
public string ToString(string format, IFormatProvider formatProvider)
@ -517,17 +517,17 @@ namespace OpenTK.Math
#region String -> Half
/// <summary>Converts the string representation of a number to a Half precision floating point equivalent.</summary>
/// <param name="s">string representation of the number to convert.</param>
/// <summary>Converts the string representation of a number to a half-precision floating-point equivalent.</summary>
/// <param name="s">String representation of the number to convert.</param>
/// <returns>A new Half instance.</returns>
public static Half Parse(string s)
{
return (Half)Single.Parse(s);
}
/// <summary>Converts the string representation of a number to a Half precision floating point equivalent.</summary>
/// <param name="s">string representation of the number to convert.</param>
/// <param name="style">specifies the format of s.</param>
/// <summary>Converts the string representation of a number to a half-precision floating-point equivalent.</summary>
/// <param name="s">String representation of the number to convert.</param>
/// <param name="style">Specifies the format of s.</param>
/// <param name="provider">Culture-specific formatting information.</param>
/// <returns>A new Half instance.</returns>
public static Half Parse(string s, System.Globalization.NumberStyles style, IFormatProvider provider)
@ -535,8 +535,8 @@ namespace OpenTK.Math
return (Half)Single.Parse(s, style, provider);
}
/// <summary>Converts the string representation of a number to a Half precision floating point equivalent. Returns success.</summary>
/// <param name="s">string representation of the number to convert.</param>
/// <summary>Converts the string representation of a number to a half-precision floating-point equivalent. Returns success.</summary>
/// <param name="s">String representation of the number to convert.</param>
/// <param name="result">The Half instance to write to.</param>
/// <returns>Success.</returns>
public static bool TryParse(string s, out Half result)
@ -547,7 +547,7 @@ namespace OpenTK.Math
return b;
}
/// <summary>Converts the string representation of a number to a Half precision floating point equivalent. Returns success.</summary>
/// <summary>Converts the string representation of a number to a half-precision floating-point equivalent. Returns success.</summary>
/// <param name="s">string representation of the number to convert.</param>
/// <param name="style">specifies the format of s.</param>
/// <param name="provider">Culture-specific formatting information.</param>

2
Source/Compatibility/Math/Matrix3d.cs
View file

@ -271,7 +271,7 @@ namespace OpenTK.Math
this.R2C2 = r2c2;
}
/// <summary>Constructs left matrix from the given array of double-precision floating point numbers.</summary>
/// <summary>Constructs left matrix from the given array of double-precision floating-point numbers.</summary>
/// <param name="doubleArray">The array of doubles for the components of the matrix.</param>
public Matrix3d(double[] doubleArray)
{

2
Source/Compatibility/Math/Quaterniond.cs
View file

@ -629,7 +629,7 @@ namespace OpenTK.Math
this.Z = z;
}
/// <summary>Constructs left Quaterniond from the given array of double-precision floating point numbers.</summary>
/// <summary>Constructs left Quaterniond from the given array of double-precision floating-point numbers.</summary>
/// <param name="doubleArray">The array of doubles for the components of the Quaterniond.</param>
public Quaterniond(double[] doubleArray)
{

32
Source/Compatibility/Math/Vector2h.cs
View file

@ -50,8 +50,8 @@ namespace OpenTK.Math
/// <summary>
/// The new Half2 instance will avoid conversion and copy directly from the Half parameters.
/// </summary>
/// <param name="x">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="y">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="x">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="y">An Half instance of a 16-bit half-precision floating-point number.</param>
public Vector2h(Half x, Half y)
{
X = x;
@ -59,10 +59,10 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half2 instance will convert the 2 parameters into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the 2 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
public Vector2h(Single x, Single y)
{
X = new Half(x);
@ -70,10 +70,10 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half2 instance will convert the 2 parameters into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the 2 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
public Vector2h(Single x, Single y, bool throwOnError)
{
@ -82,7 +82,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half2 instance will convert the Vector2 into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2</param>
[CLSCompliant(false)]
@ -93,7 +93,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half2 instance will convert the Vector2 into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -105,7 +105,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half2 instance will convert the Vector2 into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2 into 16-bit half-precision floating-point.
/// This is the fastest constructor.
/// </summary>
/// <param name="v">OpenTK.Vector2</param>
@ -116,7 +116,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half2 instance will convert the Vector2 into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -127,7 +127,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half2 instance will convert the Vector2d into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2d</param>
public Vector2h(Vector2d v)
@ -137,7 +137,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half2 instance will convert the Vector2d into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -148,7 +148,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half2 instance will convert the Vector2d into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2d into 16-bit half-precision floating-point.
/// This is the faster constructor.
/// </summary>
/// <param name="v">OpenTK.Vector2d</param>
@ -160,7 +160,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half2 instance will convert the Vector2d into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>

38
Source/Compatibility/Math/Vector3h.cs
View file

@ -55,9 +55,9 @@ namespace OpenTK.Math
/// <summary>
/// The new Half3 instance will avoid conversion and copy directly from the Half parameters.
/// </summary>
/// <param name="x">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="y">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="z">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="x">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="y">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="z">An Half instance of a 16-bit half-precision floating-point number.</param>
public Vector3h(Half x, Half y, Half z)
{
this.X = x;
@ -66,11 +66,11 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half3 instance will convert the 3 parameters into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the 3 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="z">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
/// <param name="z">32-bit single-precision floating-point number.</param>
public Vector3h(Single x, Single y, Single z)
{
X = new Half(x);
@ -79,11 +79,11 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half3 instance will convert the 3 parameters into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the 3 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="z">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
/// <param name="z">32-bit single-precision floating-point number.</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
public Vector3h(Single x, Single y, Single z, bool throwOnError)
{
@ -93,7 +93,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half3 instance will convert the Vector3 into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3</param>
[CLSCompliant(false)]
@ -105,7 +105,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half3 instance will convert the Vector3 into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -118,7 +118,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half3 instance will convert the Vector3 into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3 into 16-bit half-precision floating-point.
/// This is the fastest constructor.
/// </summary>
/// <param name="v">OpenTK.Vector3</param>
@ -130,7 +130,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half3 instance will convert the Vector3 into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -142,7 +142,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half3 instance will convert the Vector3d into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3d</param>
public Vector3h(Vector3d v)
@ -153,7 +153,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half3 instance will convert the Vector3d into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -165,7 +165,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half3 instance will convert the Vector3d into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3d into 16-bit half-precision floating-point.
/// This is the faster constructor.
/// </summary>
/// <param name="v">OpenTK.Vector3d</param>
@ -178,7 +178,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half3 instance will convert the Vector3d into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>

44
Source/Compatibility/Math/Vector4h.cs
View file

@ -58,10 +58,10 @@ namespace OpenTK.Math
/// <summary>
/// The new Half4 instance will avoid conversion and copy directly from the Half parameters.
/// </summary>
/// <param name="x">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="y">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="z">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="w">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="x">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="y">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="z">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="w">An Half instance of a 16-bit half-precision floating-point number.</param>
public Vector4h(Half x, Half y, Half z, Half w)
{
this.X = x;
@ -71,12 +71,12 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half4 instance will convert the 4 parameters into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the 4 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="z">32-Bit Single precision floating point number.</param>
/// <param name="w">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
/// <param name="z">32-bit single-precision floating-point number.</param>
/// <param name="w">32-bit single-precision floating-point number.</param>
public Vector4h(Single x, Single y, Single z, Single w)
{
X = new Half(x);
@ -86,12 +86,12 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half4 instance will convert the 4 parameters into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the 4 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="z">32-Bit Single precision floating point number.</param>
/// <param name="w">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
/// <param name="z">32-bit single-precision floating-point number.</param>
/// <param name="w">32-bit single-precision floating-point number.</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
public Vector4h(Single x, Single y, Single z, Single w, bool throwOnError)
{
@ -102,7 +102,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half4 instance will convert the Vector4 into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4</param>
[CLSCompliant(false)]
@ -115,7 +115,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half4 instance will convert the Vector4 into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -129,7 +129,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half4 instance will convert the Vector4 into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4 into 16-bit half-precision floating-point.
/// This is the fastest constructor.
/// </summary>
/// <param name="v">OpenTK.Vector4</param>
@ -142,7 +142,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half4 instance will convert the Vector4 into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -155,7 +155,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half4 instance will convert the Vector4d into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4d</param>
public Vector4h(Vector4d v)
@ -167,7 +167,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half4 instance will convert the Vector4d into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -180,7 +180,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half4 instance will convert the Vector4d into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4d into 16-bit half-precision floating-point.
/// This is the faster constructor.
/// </summary>
/// <param name="v">OpenTK.Vector4d</param>
@ -194,7 +194,7 @@ namespace OpenTK.Math
}
/// <summary>
/// The new Half4 instance will convert the Vector4d into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>

170
Source/Compatibility/Tao/OpenAl/Al.cs
View file

@ -1922,7 +1922,7 @@ namespace Tao.OpenAl
#region alGetBufferf(int buffer, int attribute, out int val)
/// <summary>
/// Retrieves a floating point property of a buffer.
/// Retrieves a floating-point property of a buffer.
/// </summary>
/// <param name="buffer">
/// Buffer name whose attribute is being retrieved.
@ -1943,7 +1943,7 @@ namespace Tao.OpenAl
#region alGetBufferf(int buffer, int attribute, [Out] int[] val)
/// <summary>
/// Retrieves a floating point property of a buffer.
/// Retrieves a floating-point property of a buffer.
/// </summary>
/// <param name="buffer">
/// Buffer name whose attribute is being retrieved.
@ -1964,7 +1964,7 @@ namespace Tao.OpenAl
#region alGetBufferf(int buffer, int attribute, [Out] IntPtr val)
/// <summary>
/// Retrieves a floating point property of a buffer.
/// Retrieves a floating-point property of a buffer.
/// </summary>
/// <param name="buffer">
/// Buffer name whose attribute is being retrieved.
@ -1985,7 +1985,7 @@ namespace Tao.OpenAl
#region alGetBufferf(int buffer, int attribute, [Out] float *val)
/// <summary>
/// Retrieves a floating point property of a buffer.
/// Retrieves a floating-point property of a buffer.
/// </summary>
/// <param name="buffer">
/// Buffer name whose attribute is being retrieved.
@ -2006,7 +2006,7 @@ namespace Tao.OpenAl
#region void alGetBuffer3f(int buffer, int attribute, out float value1, out float value2, out float value3)
/// <summary>
/// Retrieves a floating point property of a buffer.
/// Retrieves a floating-point property of a buffer.
/// </summary>
/// <param name="buffer">
/// Buffer name whose attribute is being retrieved.
@ -2033,7 +2033,7 @@ namespace Tao.OpenAl
#region alGetBufferfv(int buffer, int attribute, out float val)
/// <summary>
/// Retrieves a floating point property of a buffer.
/// Retrieves a floating-point property of a buffer.
/// </summary>
/// <param name="buffer">
/// Buffer name whose attribute is being retrieved.
@ -2054,7 +2054,7 @@ namespace Tao.OpenAl
#region alGetBufferfv(int buffer, int attribute, [Out] float[] val)
/// <summary>
/// Retrieves a floating point property of a buffer.
/// Retrieves a floating-point property of a buffer.
/// </summary>
/// <param name="buffer">
/// Buffer name whose attribute is being retrieved.
@ -2075,7 +2075,7 @@ namespace Tao.OpenAl
#region alGetBufferfv(int buffer, int attribute, [Out] IntPtr val)
/// <summary>
/// Retrieves a floating point property of a buffer.
/// Retrieves a floating-point property of a buffer.
/// </summary>
/// <param name="buffer">
/// Buffer name whose attribute is being retrieved.
@ -2096,7 +2096,7 @@ namespace Tao.OpenAl
#region alGetBufferfv(int buffer, int attribute, [Out] float *val)
/// <summary>
/// Retrieves a floating point property of a buffer.
/// Retrieves a floating-point property of a buffer.
/// </summary>
/// <param name="buffer">
/// Buffer name whose attribute is being retrieved.
@ -2376,7 +2376,7 @@ namespace Tao.OpenAl
#region double alGetDouble(int state)
/// <summary>
/// Returns a double precision floating point OpenAL state.
/// Returns a double-precision floating-point OpenAL state.
/// </summary>
/// <param name="state">
/// The state to be queried.
@ -2385,7 +2385,7 @@ namespace Tao.OpenAl
/// The double value described by <i>state</i> will be returned.
/// </returns>
/// <remarks>
/// There aren’t any double precision floating point states defined at the time of
/// There aren’t any double-precision floating-point states defined at the time of
/// this writing, so this function will always generate the error
/// <see cref="AL_INVALID_ENUM" />.
/// </remarks>
@ -2396,7 +2396,7 @@ namespace Tao.OpenAl
#region alGetDoublev(int state, out double output)
/// <summary>
/// Retrieves a double precision floating point OpenAL state.
/// Retrieves a double-precision floating-point OpenAL state.
/// </summary>
/// <param name="state">
/// The state to be queried.
@ -2405,7 +2405,7 @@ namespace Tao.OpenAl
/// A pointer to the location where the state will be stored.
/// </param>
/// <remarks>
/// There aren’t any double precision floating point states defined at the time of
/// There aren’t any double-precision floating-point states defined at the time of
/// this writing, so this function will always generate the error
/// <see cref="AL_INVALID_ENUM" />.
/// </remarks>
@ -2416,7 +2416,7 @@ namespace Tao.OpenAl
#region alGetDoublev(int state, [Out] double[] output)
/// <summary>
/// Retrieves a double precision floating point OpenAL state.
/// Retrieves a double-precision floating-point OpenAL state.
/// </summary>
/// <param name="state">
/// The state to be queried.
@ -2425,7 +2425,7 @@ namespace Tao.OpenAl
/// A pointer to the location where the state will be stored.
/// </param>
/// <remarks>
/// There aren’t any double precision floating point states defined at the time of
/// There aren’t any double-precision floating-point states defined at the time of
/// this writing, so this function will always generate the error
/// <see cref="AL_INVALID_ENUM" />.
/// </remarks>
@ -2436,7 +2436,7 @@ namespace Tao.OpenAl
#region alGetDoublev(int state, [Out] IntPtr output)
/// <summary>
/// Retrieves a double precision floating point OpenAL state.
/// Retrieves a double-precision floating-point OpenAL state.
/// </summary>
/// <param name="state">
/// The state to be queried.
@ -2445,7 +2445,7 @@ namespace Tao.OpenAl
/// A pointer to the location where the state will be stored.
/// </param>
/// <remarks>
/// There aren’t any double precision floating point states defined at the time of
/// There aren’t any double-precision floating-point states defined at the time of
/// this writing, so this function will always generate the error
/// <see cref="AL_INVALID_ENUM" />.
/// </remarks>
@ -2456,7 +2456,7 @@ namespace Tao.OpenAl
#region alGetDoublev(int state, [Out] double *output)
/// <summary>
/// Retrieves a double precision floating point OpenAL state.
/// Retrieves a double-precision floating-point OpenAL state.
/// </summary>
/// <param name="state">
/// The state to be queried.
@ -2465,7 +2465,7 @@ namespace Tao.OpenAl
/// A pointer to the location where the state will be stored.
/// </param>
/// <remarks>
/// There aren’t any double precision floating point states defined at the time of
/// There aren’t any double-precision floating-point states defined at the time of
/// this writing, so this function will always generate the error
/// <see cref="AL_INVALID_ENUM" />.
/// </remarks>
@ -2511,7 +2511,7 @@ namespace Tao.OpenAl
#region float alGetFloat(int state)
/// <summary>
/// Returns a floating point OpenAL state.
/// Returns a floating-point OpenAL state.
/// </summary>
/// <param name="state">
/// <para>
@ -2525,7 +2525,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <returns>
/// The floating point value described by <i>state</i> will be returned.
/// The floating-point value described by <i>state</i> will be returned.
/// </returns>
// ALAPI ALfloat ALAPIENTRY alGetFloat(ALenum param);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -2534,7 +2534,7 @@ namespace Tao.OpenAl
#region alGetFloatv(int state, out float output)
/// <summary>
/// Retrieves a floating point OpenAL state.
/// Retrieves a floating-point OpenAL state.
/// </summary>
/// <param name="state">
/// <para>
@ -2557,7 +2557,7 @@ namespace Tao.OpenAl
#region alGetFloatv(int state, [Out] float[] output)
/// <summary>
/// Retrieves a floating point OpenAL state.
/// Retrieves a floating-point OpenAL state.
/// </summary>
/// <param name="state">
/// <para>
@ -2580,7 +2580,7 @@ namespace Tao.OpenAl
#region alGetFloatv(int state, [Out] IntPtr output)
/// <summary>
/// Retrieves a floating point OpenAL state.
/// Retrieves a floating-point OpenAL state.
/// </summary>
/// <param name="state">
/// <para>
@ -2603,7 +2603,7 @@ namespace Tao.OpenAl
#region alGetFloatv(int state, [Out] float *output)
/// <summary>
/// Retrieves a floating point OpenAL state.
/// Retrieves a floating-point OpenAL state.
/// </summary>
/// <param name="state">
/// <para>
@ -2736,7 +2736,7 @@ namespace Tao.OpenAl
#region alGetListener3f(int attribute, out float output1, out float output2, out float output3)
/// <summary>
/// Retrieves a set of three floating point values from a property of the listener.
/// Retrieves a set of three floating-point values from a property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -2750,13 +2750,13 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output1">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
/// <param name="output2">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
/// <param name="output3">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListener3f(ALenum param, ALfloat* v1, ALfloat* v2, ALfloat* v3);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -2765,7 +2765,7 @@ namespace Tao.OpenAl
#region alGetListener3f(int attribute, [Out] float[] output1, [Out] float[] output2, [Out] float[] output3)
/// <summary>
/// Retrieves a set of three floating point values from a property of the listener.
/// Retrieves a set of three floating-point values from a property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -2779,13 +2779,13 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output1">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
/// <param name="output2">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
/// <param name="output3">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListener3f(ALenum param, ALfloat* v1, ALfloat* v2, ALfloat* v3);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -2794,7 +2794,7 @@ namespace Tao.OpenAl
#region alGetListener3f(int attribute, [Out] IntPtr output1, [Out] IntPtr output2, [Out] IntPtr output3)
/// <summary>
/// Retrieves a set of three floating point values from a property of the listener.
/// Retrieves a set of three floating-point values from a property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -2808,13 +2808,13 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output1">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
/// <param name="output2">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
/// <param name="output3">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListener3f(ALenum param, ALfloat* v1, ALfloat* v2, ALfloat* v3);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -2823,7 +2823,7 @@ namespace Tao.OpenAl
#region alGetListener3f(int attribute, [Out] float *output1, [Out] float *output2, [Out] float *output3)
/// <summary>
/// Retrieves a set of three floating point values from a property of the listener.
/// Retrieves a set of three floating-point values from a property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -2837,13 +2837,13 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output1">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
/// <param name="output2">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
/// <param name="output3">
/// Pointer to the the floating point being retrieved.
/// Pointer to the the floating-point being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListener3f(ALenum param, ALfloat* v1, ALfloat* v2, ALfloat* v3);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), CLSCompliant(false), SuppressUnmanagedCodeSecurity]
@ -2852,7 +2852,7 @@ namespace Tao.OpenAl
#region alGetListenerf(int attribute, out float output)
/// <summary>
/// Retrieves a floating point property of the listener.
/// Retrieves a floating-point property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -2865,7 +2865,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output">
/// A pointer to the floating point value being retrieved.
/// A pointer to the floating-point value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListenerf(ALenum param, ALfloat* value);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -2874,7 +2874,7 @@ namespace Tao.OpenAl
#region alGetListenerf(int attribute, [Out] float[] output)
/// <summary>
/// Retrieves a floating point property of the listener.
/// Retrieves a floating-point property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -2887,7 +2887,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output">
/// A pointer to the floating point value being retrieved.
/// A pointer to the floating-point value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListenerf(ALenum param, ALfloat* value);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -2896,7 +2896,7 @@ namespace Tao.OpenAl
#region alGetListenerf(int attribute, [Out] IntPtr output)
/// <summary>
/// Retrieves a floating point property of the listener.
/// Retrieves a floating-point property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -2909,7 +2909,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output">
/// A pointer to the floating point value being retrieved.
/// A pointer to the floating-point value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListenerf(ALenum param, ALfloat* value);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -2918,7 +2918,7 @@ namespace Tao.OpenAl
#region alGetListenerf(int attribute, [Out] float *output)
/// <summary>
/// Retrieves a floating point property of the listener.
/// Retrieves a floating-point property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -2931,7 +2931,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output">
/// A pointer to the floating point value being retrieved.
/// A pointer to the floating-point value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListenerf(ALenum param, ALfloat* value);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), CLSCompliant(false), SuppressUnmanagedCodeSecurity]
@ -2940,7 +2940,7 @@ namespace Tao.OpenAl
#region alGetListenerfv(int attribute, out float output)
/// <summary>
/// Retrieves a floating point-vector property of the listener.
/// Retrieves a floating-point vector property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -2955,7 +2955,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output">
/// A pointer to the floating point-vector value being retrieved.
/// A pointer to the floating-point vector value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListenerfv(ALenum param, ALfloat* values);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -2964,7 +2964,7 @@ namespace Tao.OpenAl
#region alGetListenerfv(int attribute, [Out] float[] output)
/// <summary>
/// Retrieves a floating point-vector property of the listener.
/// Retrieves a floating-point vector property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -2979,7 +2979,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output">
/// A pointer to the floating point-vector value being retrieved.
/// A pointer to the floating-point vector value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListenerfv(ALenum param, ALfloat* values);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -2988,7 +2988,7 @@ namespace Tao.OpenAl
#region alGetListenerfv(int attribute, [Out] IntPtr output)
/// <summary>
/// Retrieves a floating point-vector property of the listener.
/// Retrieves a floating-point vector property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -3003,7 +3003,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output">
/// A pointer to the floating point-vector value being retrieved.
/// A pointer to the floating-point vector value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListenerfv(ALenum param, ALfloat* values);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -3012,7 +3012,7 @@ namespace Tao.OpenAl
#region alGetListenerfv(int attribute, [Out] float *output)
/// <summary>
/// Retrieves a floating point-vector property of the listener.
/// Retrieves a floating-point vector property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -3027,7 +3027,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="output">
/// A pointer to the floating point-vector value being retrieved.
/// A pointer to the floating-point vector value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetListenerfv(ALenum param, ALfloat* values);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), CLSCompliant(false), SuppressUnmanagedCodeSecurity]
@ -3359,7 +3359,7 @@ namespace Tao.OpenAl
#region alGetSourcef(int source, int attribute, out float val)
/// <summary>
/// Retrieves a floating point property of a source.
/// Retrieves a floating-point property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being retrieved.
@ -3384,7 +3384,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="val">
/// A pointer to the floating point value being retrieved.
/// A pointer to the floating-point value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetSourcef(ALuint source, ALenum param, ALfloat* value);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -3393,7 +3393,7 @@ namespace Tao.OpenAl
#region alGetSourcef(int source, int attribute, [Out] float[] val)
/// <summary>
/// Retrieves a floating point property of a source.
/// Retrieves a floating-point property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being retrieved.
@ -3418,7 +3418,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="val">
/// A pointer to the floating point value being retrieved.
/// A pointer to the floating-point value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetSourcef(ALuint source, ALenum param, ALfloat* value);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -3427,7 +3427,7 @@ namespace Tao.OpenAl
#region alGetSourcef(int source, int attribute, [Out] IntPtr val)
/// <summary>
/// Retrieves a floating point property of a source.
/// Retrieves a floating-point property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being retrieved.
@ -3452,7 +3452,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="val">
/// A pointer to the floating point value being retrieved.
/// A pointer to the floating-point value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetSourcef(ALuint source, ALenum param, ALfloat* value);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -3461,7 +3461,7 @@ namespace Tao.OpenAl
#region alGetSourcef(int source, int attribute, [Out] float *val)
/// <summary>
/// Retrieves a floating point property of a source.
/// Retrieves a floating-point property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being retrieved.
@ -3486,7 +3486,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="val">
/// A pointer to the floating point value being retrieved.
/// A pointer to the floating-point value being retrieved.
/// </param>
// ALAPI ALvoid ALAPIENTRY alGetSourcef(ALuint source, ALenum param, ALfloat* value);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), CLSCompliant(false), SuppressUnmanagedCodeSecurity]
@ -3495,7 +3495,7 @@ namespace Tao.OpenAl
#region alGetSourcefv(int source, int attribute, out float val)
/// <summary>
/// Retrieves a floating point-vector property of a source.
/// Retrieves a floating-point vector property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being retrieved.
@ -3522,7 +3522,7 @@ namespace Tao.OpenAl
#region alGetSourcefv(int source, int attribute, [Out] float[] values)
/// <summary>
/// Retrieves a floating point-vector property of a source.
/// Retrieves a floating-point vector property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being retrieved.
@ -3549,7 +3549,7 @@ namespace Tao.OpenAl
#region alGetSourcefv(int source, int attribute, [Out] IntPtr values)
/// <summary>
/// Retrieves a floating point-vector property of a source.
/// Retrieves a floating-point vector property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being retrieved.
@ -3576,7 +3576,7 @@ namespace Tao.OpenAl
#region alGetSourcefv(int source, int attribute, [Out] float *values)
/// <summary>
/// Retrieves a floating point-vector property of a source.
/// Retrieves a floating-point vector property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being retrieved.
@ -3988,7 +3988,7 @@ namespace Tao.OpenAl
#region alListener3f(int attribute, float value1, float value2, float value3)
/// <summary>
/// Sets a floating point property for the listener.
/// Sets a floating-point property for the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -4017,7 +4017,7 @@ namespace Tao.OpenAl
#region alListenerf(int attribute, float val)
/// <summary>
/// Sets a floating point property for the listener.
/// Sets a floating-point property for the listener.
/// </summary>
/// <param name="attribute">
/// The name of the attribute to be set.
@ -4032,7 +4032,7 @@ namespace Tao.OpenAl
#region alListenerfv(int attribute, [In] ref float values)
/// <summary>
/// Sets a floating point-vector property of the listener.
/// Sets a floating-point vector property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -4047,7 +4047,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="values">
/// Pointer to floating point-vector values.
/// Pointer to floating-point vector values.
/// </param>
// ALAPI ALvoid ALAPIENTRY alListenerfv(ALenum param, ALfloat* values);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -4056,7 +4056,7 @@ namespace Tao.OpenAl
#region alListenerfv(int attribute, [In] float[] values)
/// <summary>
/// Sets a floating point-vector property of the listener.
/// Sets a floating-point vector property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -4071,7 +4071,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="values">
/// Pointer to floating point-vector values.
/// Pointer to floating-point vector values.
/// </param>
// ALAPI ALvoid ALAPIENTRY alListenerfv(ALenum param, ALfloat* values);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -4080,7 +4080,7 @@ namespace Tao.OpenAl
#region alListenerfv(int attribute, [In] IntPtr values)
/// <summary>
/// Sets a floating point-vector property of the listener.
/// Sets a floating-point vector property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -4095,7 +4095,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="values">
/// Pointer to floating point-vector values.
/// Pointer to floating-point vector values.
/// </param>
// ALAPI ALvoid ALAPIENTRY alListenerfv(ALenum param, ALfloat* values);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), SuppressUnmanagedCodeSecurity]
@ -4104,7 +4104,7 @@ namespace Tao.OpenAl
#region alListenerfv(int attribute, [In] float *values)
/// <summary>
/// Sets a floating point-vector property of the listener.
/// Sets a floating-point vector property of the listener.
/// </summary>
/// <param name="attribute">
/// <para>
@ -4119,7 +4119,7 @@ namespace Tao.OpenAl
/// </para>
/// </param>
/// <param name="values">
/// Pointer to floating point-vector values.
/// Pointer to floating-point vector values.
/// </param>
// ALAPI ALvoid ALAPIENTRY alListenerfv(ALenum param, ALfloat* values);
[DllImport(AL_NATIVE_LIBRARY, CallingConvention = CALLING_CONVENTION), CLSCompliant(false), SuppressUnmanagedCodeSecurity]
@ -4217,7 +4217,7 @@ namespace Tao.OpenAl
#region alSource3f(int source, int attribute, float value1, float value2, float value3)
/// <summary>
/// Sets a source property requiring three floating point values.
/// Sets a source property requiring three floating-point values.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being set.
@ -4253,7 +4253,7 @@ namespace Tao.OpenAl
#region alSourcef(int source, int attribute, float val)
/// <summary>
/// Sets a floating point property of a source.
/// Sets a floating-point property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being set.
@ -4285,7 +4285,7 @@ namespace Tao.OpenAl
#region alSourcefv(int source, int attribute, [In] ref float values)
/// <summary>
/// Sets a floating point-vector property of a source.
/// Sets a floating-point vector property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being set.
@ -4312,7 +4312,7 @@ namespace Tao.OpenAl
#region alSourcefv(int source, int attribute, [In] float[] values)
/// <summary>
/// Sets a floating point-vector property of a source.
/// Sets a floating-point vector property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being set.
@ -4339,7 +4339,7 @@ namespace Tao.OpenAl
#region alSourcefv(int source, int attribute, [In] IntPtr values)
/// <summary>
/// Sets a floating point-vector property of a source.
/// Sets a floating-point vector property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being set.
@ -4366,7 +4366,7 @@ namespace Tao.OpenAl
#region alSourcefv(int source, int attribute, [In] float *values)
/// <summary>
/// Sets a floating point-vector property of a source.
/// Sets a floating-point vector property of a source.
/// </summary>
/// <param name="source">
/// Source name whose attribute is being set.

20
Source/Compatibility/Tao/OpenGl/Glu.cs
View file

@ -37713,7 +37713,7 @@ namespace Tao.OpenGl
/// An array of <i>knotCount</i> nondecreasing knot values.
/// </param>
/// <param name="stride">
/// The offset (as a number of single precision–floating-point values) between
/// The offset (as a number of single-precision floating-point values) between
/// successive curve control points.
/// </param>
/// <param name="control">
@ -37807,7 +37807,7 @@ namespace Tao.OpenGl
/// An array of <i>knotCount</i> nondecreasing knot values.
/// </param>
/// <param name="stride">
/// The offset (as a number of single precision–floating-point values) between
/// The offset (as a number of single-precision floating-point values) between
/// successive curve control points.
/// </param>
/// <param name="control">
@ -38164,11 +38164,11 @@ namespace Tao.OpenGl
/// v direction.
/// </param>
/// <param name="sStride">
/// The offset (as a number of single precision–floating-point values) between
/// The offset (as a number of single-precision floating-point values) between
/// successive control points in the parametric u direction in <i>control</i>.
/// </param>
/// <param name="tStride">
/// The offset (in single precision–floating-point values) between successive
/// The offset (in single-precision floating-point values) between successive
/// control points in the parametric v direction in <i>control</i>.
/// </param>
/// <param name="control">
@ -38268,11 +38268,11 @@ namespace Tao.OpenGl
/// v direction.
/// </param>
/// <param name="sStride">
/// The offset (as a number of single precision–floating-point values) between
/// The offset (as a number of single-precision floating-point values) between
/// successive control points in the parametric u direction in <i>control</i>.
/// </param>
/// <param name="tStride">
/// The offset (in single precision–floating-point values) between successive
/// The offset (in single-precision floating-point values) between successive
/// control points in the parametric v direction in <i>control</i>.
/// </param>
/// <param name="control">
@ -38372,11 +38372,11 @@ namespace Tao.OpenGl
/// v direction.
/// </param>
/// <param name="sStride">
/// The offset (as a number of single precision–floating-point values) between
/// The offset (as a number of single-precision floating-point values) between
/// successive control points in the parametric u direction in <i>control</i>.
/// </param>
/// <param name="tStride">
/// The offset (in single precision–floating-point values) between successive
/// The offset (in single-precision floating-point values) between successive
/// control points in the parametric v direction in <i>control</i>.
/// </param>
/// <param name="control">
@ -38801,7 +38801,7 @@ namespace Tao.OpenGl
/// An array containing the curve points.
/// </param>
/// <param name="stride">
/// The offset (a number of single precision–floating-point values) between
/// The offset (a number of single-precision floating-point values) between
/// points on the curve.
/// </param>
/// <param name="type">
@ -38857,7 +38857,7 @@ namespace Tao.OpenGl
/// An array containing the curve points.
/// </param>
/// <param name="stride">
/// The offset (a number of single precision–floating-point values) between
/// The offset (a number of single-precision floating-point values) between
/// points on the curve.
/// </param>
/// <param name="type">

2
Source/Examples/OpenAL/1.1/Parrot.Designer.cs generated
View file

@ -131,7 +131,7 @@
this.label_MONO16BIT.Name = "label_MONO16BIT";
this.label_MONO16BIT.Size = new System.Drawing.Size(64, 13);
this.label_MONO16BIT.TabIndex = 102;
this.label_MONO16BIT.Text = "Mono 16 Bit";
this.label_MONO16BIT.Text = "Mono 16-bit";
//
// label_RINGBUFFER
//

2
Source/Examples/Utilities/LoaderGDI.cs
View file

@ -6,7 +6,7 @@
*/
#endregion
// TODO: Find paint program that can properly export 8/16 Bit Textures and make sure they are loaded correctly.
// TODO: Find paint program that can properly export 8/16-bit Textures and make sure they are loaded correctly.
using System;
using System.Diagnostics;

58
Source/OpenTK/Audio/OpenAL/AL/AL.cs
View file

@ -146,15 +146,15 @@ namespace OpenTK.Audio.OpenAL
public static extern int Get(ALGetInteger param);
// AL_API ALint AL_APIENTRY alGetInteger( ALenum param );
/// <summary>This function returns a floating point OpenAL state.</summary>
/// <summary>This function returns a floating-point OpenAL state.</summary>
/// <param name="param">the state to be queried: DopplerFactor, SpeedOfSound.</param>
/// <returns>The floating point state described by param will be returned.</returns>
/// <returns>The floating-point state described by param will be returned.</returns>
[DllImport(AL.Lib, EntryPoint = "alGetFloat", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern float Get(ALGetFloat param);
// AL_API ALfloat AL_APIENTRY alGetFloat( ALenum param );
/* disabled due to no token using it
/// <summary>This function returns a double precision floating point OpenAL state.</summary>
/// <summary>This function returns a double-precision floating-point OpenAL state.</summary>
/// <param name="param">the state to be queried: AL_DOPPLER_FACTOR, AL_SPEED_OF_SOUND, AL_DISTANCE_MODEL</param>
/// <returns>The double value described by param will be returned.</returns>
[DllImport( AL.Lib, EntryPoint = "alGetDouble", ExactSpelling = true, CallingConvention = AL.Style ), SuppressUnmanagedCodeSecurity( )]
@ -209,14 +209,14 @@ namespace OpenTK.Audio.OpenAL
#region Set Listener parameters
/// <summary>This function sets a floating point property for the listener.</summary>
/// <summary>This function sets a floating-point property for the listener.</summary>
/// <param name="param">The name of the attribute to be set: ALListenerf.Gain</param>
/// <param name="value">The float value to set the attribute to.</param>
[DllImport(AL.Lib, EntryPoint = "alListenerf", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void Listener(ALListenerf param, float value);
// AL_API void AL_APIENTRY alListenerf( ALenum param, ALfloat value );
/// <summary>This function sets a floating point property for the listener.</summary>
/// <summary>This function sets a floating-point property for the listener.</summary>
/// <param name="param">The name of the attribute to set: ALListener3f.Position, ALListener3f.Velocity</param>
/// <param name="value1">The value to set the attribute to.</param>
/// <param name="value2">The value to set the attribute to.</param>
@ -237,9 +237,9 @@ namespace OpenTK.Audio.OpenAL
unsafe private static extern void ListenerPrivate(ALListenerfv param, float* values);
// AL_API void AL_APIENTRY alListenerfv( ALenum param, const ALfloat* values );
/// <summary>This function sets a floating point-vector property of the listener.</summary>
/// <summary>This function sets a floating-point vector property of the listener.</summary>
/// <param name="param">The name of the attribute to be set: ALListener3f.Position, ALListener3f.Velocity, ALListenerfv.Orientation</param>
/// <param name="values">Pointer to floating point-vector values.</param>
/// <param name="values">Pointer to floating-point vector values.</param>
public static void Listener(ALListenerfv param, ref float[] values)
{
unsafe
@ -285,18 +285,18 @@ namespace OpenTK.Audio.OpenAL
#region Get Listener parameters
/// <summary>This function retrieves a floating point property of the listener.</summary>
/// <summary>This function retrieves a floating-point property of the listener.</summary>
/// <param name="param">the name of the attribute to be retrieved: ALListenerf.Gain</param>
/// <param name="value">a pointer to the floating point value being retrieved.</param>
/// <param name="value">a pointer to the floating-point value being retrieved.</param>
[DllImport(AL.Lib, EntryPoint = "alGetListenerf", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetListener(ALListenerf param, [Out] out float value);
// AL_API void AL_APIENTRY alGetListenerf( ALenum param, ALfloat* value );
/// <summary>This function retrieves a set of three floating point values from a property of the listener.</summary>
/// <summary>This function retrieves a set of three floating-point values from a property of the listener.</summary>
/// <param name="param">The name of the attribute to be retrieved: ALListener3f.Position, ALListener3f.Velocity</param>
/// <param name="value1">Pointers to the three floating point being retrieved.</param>
/// <param name="value2">Pointers to the three floating point being retrieved.</param>
/// <param name="value3">Pointers to the three floating point being retrieved.</param>
/// <param name="value1">Pointers to the three floating-point being retrieved.</param>
/// <param name="value2">Pointers to the three floating-point being retrieved.</param>
/// <param name="value3">Pointers to the three floating-point being retrieved.</param>
[DllImport(AL.Lib, EntryPoint = "alGetListener3f", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetListener(ALListener3f param, [Out] out float value1, [Out] out float value2, [Out] out float value3);
// AL_API void AL_APIENTRY alGetListener3f( ALenum param, ALfloat *value1, ALfloat *value2, ALfloat *value3 );
@ -309,9 +309,9 @@ namespace OpenTK.Audio.OpenAL
GetListener(param, out values.X, out values.Y, out values.Z);
}
/// <summary>This function retrieves a floating point-vector property of the listener. You must pin it manually.</summary>
/// <summary>This function retrieves a floating-point vector property of the listener. You must pin it manually.</summary>
/// <param name="param">the name of the attribute to be retrieved: ALListener3f.Position, ALListener3f.Velocity, ALListenerfv.Orientation</param>
/// <param name="values">A pointer to the floating point-vector value being retrieved.</param>
/// <param name="values">A pointer to the floating-point vector value being retrieved.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alGetListenerfv", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
unsafe public static extern void GetListener(ALListenerfv param, float* values);
// AL_API void AL_APIENTRY alGetListenerfv( ALenum param, ALfloat* values );
@ -551,7 +551,7 @@ namespace OpenTK.Audio.OpenAL
#region Sourcef
/// <summary>This function sets a floating point property of a source.</summary>
/// <summary>This function sets a floating-point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being set</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">The value to set the attribute to.</param>
@ -559,7 +559,7 @@ namespace OpenTK.Audio.OpenAL
public static extern void Source(uint sid, ALSourcef param, float value);
// AL_API void AL_APIENTRY alSourcef( ALuint sid, ALenum param, ALfloat value );
/// <summary>This function sets a floating point property of a source.</summary>
/// <summary>This function sets a floating-point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being set</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">The value to set the attribute to.</param>
@ -572,7 +572,7 @@ namespace OpenTK.Audio.OpenAL
#region Source3f
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <summary>This function sets a source property requiring three floating-point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">The three ALfloat values which the attribute will be set to.</param>
@ -582,7 +582,7 @@ namespace OpenTK.Audio.OpenAL
public static extern void Source(uint sid, ALSource3f param, float value1, float value2, float value3);
// AL_API void AL_APIENTRY alSource3f( ALuint sid, ALenum param, ALfloat value1, ALfloat value2, ALfloat value3 );
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <summary>This function sets a source property requiring three floating-point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">The three ALfloat values which the attribute will be set to.</param>
@ -593,7 +593,7 @@ namespace OpenTK.Audio.OpenAL
Source((uint)sid, param, value1, value2, value3);
}
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <summary>This function sets a source property requiring three floating-point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 which the attribute will be set to.</param>
@ -603,7 +603,7 @@ namespace OpenTK.Audio.OpenAL
Source(sid, param, values.X, values.Y, values.Z);
}
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <summary>This function sets a source property requiring three floating-point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 which the attribute will be set to.</param>
@ -706,18 +706,18 @@ namespace OpenTK.Audio.OpenAL
#region GetSourcef
/// <summary>This function retrieves a floating point property of a source.</summary>
/// <summary>This function retrieves a floating-point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">A pointer to the floating point value being retrieved</param>
/// <param name="value">A pointer to the floating-point value being retrieved</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alGetSourcef", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetSource(uint sid, ALSourcef param, [Out] out float value);
// AL_API void AL_APIENTRY alGetSourcef( ALuint sid, ALenum param, ALfloat* value );
/// <summary>This function retrieves a floating point property of a source.</summary>
/// <summary>This function retrieves a floating-point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">A pointer to the floating point value being retrieved</param>
/// <param name="value">A pointer to the floating-point value being retrieved</param>
public static void GetSource(int sid, ALSourcef param, out float value)
{
GetSource((uint)sid, param, out value);
@ -727,7 +727,7 @@ namespace OpenTK.Audio.OpenAL
#region GetSource3f
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <summary>This function retrieves three floating-point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">Pointer to the value to retrieve.</param>
@ -737,7 +737,7 @@ namespace OpenTK.Audio.OpenAL
public static extern void GetSource(uint sid, ALSource3f param, [Out] out float value1, [Out] out float value2, [Out] out float value3);
// AL_API void AL_APIENTRY alGetSource3f( ALuint sid, ALenum param, ALfloat* value1, ALfloat* value2, ALfloat* value3);
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <summary>This function retrieves three floating-point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">Pointer to the value to retrieve.</param>
@ -748,7 +748,7 @@ namespace OpenTK.Audio.OpenAL
GetSource((uint)sid, param, out value1, out value2, out value3);
}
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <summary>This function retrieves three floating-point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 to retrieve the values to.</param>
@ -758,7 +758,7 @@ namespace OpenTK.Audio.OpenAL
GetSource(sid, param, out values.X, out values.Y, out values.Z);
}
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <summary>This function retrieves three floating-point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 to retrieve the values to.</param>

48
Source/OpenTK/Audio/OpenAL/AL/ALEnums.cs
View file

@ -19,7 +19,7 @@ namespace OpenTK.Audio.OpenAL
Invalid = -1,
}
///<summary>A list of valid 32-Bits Float Listener/GetListener parameters</summary>
///<summary>A list of valid 32-bit Float Listener/GetListener parameters</summary>
public enum ALListenerf : int
{
///<summary>Indicate the gain (Volume amplification) applied. Type: float Range: [0.0f - ? ] A value of 1.0 means un-attenuated/unchanged. Each division by 2 equals an attenuation of -6dB. Each multiplicaton with 2 equals an amplification of +6dB. A value of 0.0f is interpreted as zero volume and the channel is effectively disabled.</summary>
@ -46,7 +46,7 @@ namespace OpenTK.Audio.OpenAL
Orientation = 0x100F,
}
///<summary>A list of valid 32-Bits Float Source/GetSource parameters</summary>
///<summary>A list of valid 32-bit Float Source/GetSource parameters</summary>
public enum ALSourcef : int
{
///<summary>Source specific reference distance. Type: float Range: [0.0f - float.PositiveInfinity] At 0.0f, no distance attenuation occurs. Type: float Default: 1.0f.</summary>
@ -106,7 +106,7 @@ namespace OpenTK.Audio.OpenAL
Direction = 0x1005,
}
///<summary>A list of valid 8-Bits boolean Source/GetSource parameters</summary>
///<summary>A list of valid 8-bit boolean Source/GetSource parameters</summary>
public enum ALSourceb : int
{
///<summary>Indicate that the Source has relative coordinates. Type: bool Range: [True, False]</summary>
@ -216,16 +216,16 @@ namespace OpenTK.Audio.OpenAL
///<summary>Sound samples: Format specifier.</summary>
public enum ALFormat : int
{
///<summary>1 Channel, 8 Bits per sample.</summary>
///<summary>1 Channel, 8 bits per sample.</summary>
Mono8 = 0x1100,
///<summary>1 Channel, 16 Bits per sample.</summary>
///<summary>1 Channel, 16 bits per sample.</summary>
Mono16 = 0x1101,
///<summary>2 Channels, 8 Bits per sample each.</summary>
///<summary>2 Channels, 8 bits per sample each.</summary>
Stereo8 = 0x1102,
///<summary>2 Channels, 16 Bits per sample each.</summary>
///<summary>2 Channels, 16 bits per sample each.</summary>
Stereo16 = 0x1103,
/// <summary>1 Channel, A-law encoded data. Requires Extension: AL_EXT_ALAW</summary>
@ -264,56 +264,56 @@ namespace OpenTK.Audio.OpenAL
/// <summary>2 Channels, double-precision floating-point data. Requires Extension: AL_EXT_double</summary>
StereoDoubleExt = 0x10013,
/// <summary>Multichannel 5.1, 16 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 5.1, 16-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi51Chn16Ext = 0x120B,
/// <summary>Multichannel 5.1, 32 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 5.1, 32-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi51Chn32Ext = 0x120C,
/// <summary>Multichannel 5.1, 8 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 5.1, 8-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi51Chn8Ext = 0x120A,
/// <summary>Multichannel 6.1, 16 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 6.1, 16-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi61Chn16Ext = 0x120E,
/// <summary>Multichannel 6.1, 32 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 6.1, 32-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi61Chn32Ext = 0x120F,
/// <summary>Multichannel 6.1, 8 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 6.1, 8-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi61Chn8Ext = 0x120D,
/// <summary>Multichannel 7.1, 16 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 7.1, 16-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi71Chn16Ext = 0x1211,
/// <summary>Multichannel 7.1, 32 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 7.1, 32-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi71Chn32Ext = 0x1212,
/// <summary>Multichannel 7.1, 8 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 7.1, 8-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
Multi71Chn8Ext = 0x1210,
/// <summary>Multichannel 4.0, 16 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 4.0, 16-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiQuad16Ext = 0x1205,
/// <summary>Multichannel 4.0, 32 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 4.0, 32-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiQuad32Ext = 0x1206,
/// <summary>Multichannel 4.0, 8 Bits data. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>Multichannel 4.0, 8-bit data. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiQuad8Ext = 0x1204,
/// <summary>1 Channel rear speaker, 16 Bits data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>1 Channel rear speaker, 16-bit data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiRear16Ext = 0x1208,
/// <summary>1 Channel rear speaker, 32 Bits data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>1 Channel rear speaker, 32-bit data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiRear32Ext = 0x1209,
/// <summary>1 Channel rear speaker, 8 Bits data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
/// <summary>1 Channel rear speaker, 8-bit data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS</summary>
MultiRear8Ext = 0x1207,
}
///<summary>A list of valid Int32 GetBuffer parameters</summary>
public enum ALGetBufferi : int
{
///<summary>Sound sample's frequency, in units of Hertz [Hz]. This is the number of samples per second. Half of the sample frequency marks the maximum significant frequency component.</summary>
///<summary>Sound sample's frequency, in units of hertz [Hz]. This is the number of samples per second. Half of the sample frequency marks the maximum significant frequency component.</summary>
Frequency = 0x2001,
/// <summary>Bit depth of the buffer. Should be 8 or 16.</summary>
@ -383,7 +383,7 @@ namespace OpenTK.Audio.OpenAL
Extensions = 0xB004,
}
///<summary>A list of valid 32-Bits Float AL.Get() parameters</summary>
///<summary>A list of valid 32-bit Float AL.Get() parameters</summary>
public enum ALGetFloat : int
{
///<summary>Doppler scale. Default 1.0f</summary>

52
Source/OpenTK/Audio/OpenAL/AL/EffectsExtension.cs
View file

@ -351,20 +351,20 @@ namespace OpenTK.Audio.OpenAL
//[CLSCompliant(false)]
private Delegate_alEffectf Imported_alEffectf;
/// <summary>This function is used to set floating point properties on Effect objects.</summary>
/// <summary>This function is used to set floating-point properties on Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
[CLSCompliant(false)]
public void Effect(uint eid, EfxEffectf param, float value)
{
Imported_alEffectf(eid, param, value);
}
/// <summary>This function is used to set floating point properties on Effect objects.</summary>
/// <summary>This function is used to set floating-point properties on Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
public void Effect(int eid, EfxEffectf param, float value)
{
@ -382,7 +382,7 @@ namespace OpenTK.Audio.OpenAL
//[CLSCompliant(false)]
private Delegate_alEffectfv Imported_alEffectfv;
/// <summary>This function is used to set 3 floating point properties on Effect objects.</summary>
/// <summary>This function is used to set 3 floating-point properties on Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="values">Pointer to Math.Vector3.</param>
@ -398,7 +398,7 @@ namespace OpenTK.Audio.OpenAL
}
}
/// <summary>This function is used to set 3 floating point properties on Effect objects.</summary>
/// <summary>This function is used to set 3 floating-point properties on Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="values">Pointer to Math.Vector3.</param>
@ -456,10 +456,10 @@ namespace OpenTK.Audio.OpenAL
//[CLSCompliant(false)]
private Delegate_alGetEffectf Imported_alGetEffectf;
/// <summary>This function is used to retrieve floating point properties from Effect objects.</summary>
/// <summary>This function is used to retrieve floating-point properties from Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="pname">Effect property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
[CLSCompliant(false)]
public void GetEffect(uint eid, EfxEffectf pname, out float value)
{
@ -472,10 +472,10 @@ namespace OpenTK.Audio.OpenAL
}
}
/// <summary>This function is used to retrieve floating point properties from Effect objects.</summary>
/// <summary>This function is used to retrieve floating-point properties from Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="pname">Effect property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
public void GetEffect(int eid, EfxEffectf pname, out float value)
{
@ -493,7 +493,7 @@ namespace OpenTK.Audio.OpenAL
//[CLSCompliant(false)]
private Delegate_alGetEffectfv Imported_alGetEffectfv;
/// <summary>This function is used to retrieve 3 floating point properties from Effect objects.</summary>
/// <summary>This function is used to retrieve 3 floating-point properties from Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to retrieve.</param>
/// <param name="values">A Math.Vector3 to hold the values.</param>
@ -512,7 +512,7 @@ namespace OpenTK.Audio.OpenAL
}
}
/// <summary>This function is used to retrieve 3 floating point properties from Effect objects.</summary>
/// <summary>This function is used to retrieve 3 floating-point properties from Effect objects.</summary>
/// <param name="eid">Effect object identifier.</param>
/// <param name="param">Effect property to retrieve.</param>
/// <param name="values">A Math.Vector3 to hold the values.</param>
@ -761,20 +761,20 @@ namespace OpenTK.Audio.OpenAL
//[CLSCompliant(false)]
private Delegate_alFilterf Imported_alFilterf;
/// <summary>This function is used to set floating point properties on Filter objects.</summary>
/// <summary>This function is used to set floating-point properties on Filter objects.</summary>
/// <param name="fid">Filter object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
[CLSCompliant(false)]
public void Filter(uint fid, EfxFilterf param, float value)
{
Imported_alFilterf(fid, param, value);
}
/// <summary>This function is used to set floating point properties on Filter objects.</summary>
/// <summary>This function is used to set floating-point properties on Filter objects.</summary>
/// <param name="fid">Filter object identifier.</param>
/// <param name="param">Effect property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
public void Filter(int fid, EfxFilterf param, float value)
{
@ -829,10 +829,10 @@ namespace OpenTK.Audio.OpenAL
//[CLSCompliant(false)]
private Delegate_alGetFilterf Imported_alGetFilterf;
/// <summary>This function is used to retrieve floating point properties from Filter objects.</summary>
/// <summary>This function is used to retrieve floating-point properties from Filter objects.</summary>
/// <param name="fid">Filter object identifier.</param>
/// <param name="pname">Effect property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
[CLSCompliant(false)]
public void GetFilter(uint fid, EfxFilterf pname, out float value)
{
@ -845,10 +845,10 @@ namespace OpenTK.Audio.OpenAL
}
}
/// <summary>This function is used to retrieve floating point properties from Filter objects.</summary>
/// <summary>This function is used to retrieve floating-point properties from Filter objects.</summary>
/// <param name="fid">Filter object identifier.</param>
/// <param name="pname">Effect property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
public void GetFilter(int fid, EfxFilterf pname, out float value)
{
@ -1092,20 +1092,20 @@ namespace OpenTK.Audio.OpenAL
//[CLSCompliant(false)]
private Delegate_alAuxiliaryEffectSlotf Imported_alAuxiliaryEffectSlotf;
/// <summary>This function is used to set floating point properties on Auxiliary Effect Slot objects.</summary>
/// <summary>This function is used to set floating-point properties on Auxiliary Effect Slot objects.</summary>
/// <param name="asid">Auxiliary Effect Slot object identifier.</param>
/// <param name="param">Auxiliary Effect Slot property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
[CLSCompliant(false)]
public void AuxiliaryEffectSlot(uint asid, EfxAuxiliaryf param, float value)
{
Imported_alAuxiliaryEffectSlotf(asid, param, value);
}
/// <summary>This function is used to set floating point properties on Auxiliary Effect Slot objects.</summary>
/// <summary>This function is used to set floating-point properties on Auxiliary Effect Slot objects.</summary>
/// <param name="asid">Auxiliary Effect Slot object identifier.</param>
/// <param name="param">Auxiliary Effect Slot property to set.</param>
/// <param name="value">Floating point value.</param>
/// <param name="value">Floating-point value.</param>
public void AuxiliaryEffectSlot(int asid, EfxAuxiliaryf param, float value)
{
@ -1163,7 +1163,7 @@ namespace OpenTK.Audio.OpenAL
/// <summary>This function is used to retrieve floating properties on Auxiliary Effect Slot objects.</summary>
/// <param name="asid">Auxiliary Effect Slot object identifier.</param>
/// <param name="pname">Auxiliary Effect Slot property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
[CLSCompliant(false)]
public void GetAuxiliaryEffectSlot(uint asid, EfxAuxiliaryf pname, out float value)
{
@ -1179,7 +1179,7 @@ namespace OpenTK.Audio.OpenAL
/// <summary>This function is used to retrieve floating properties on Auxiliary Effect Slot objects.</summary>
/// <param name="asid">Auxiliary Effect Slot object identifier.</param>
/// <param name="pname">Auxiliary Effect Slot property to retrieve.</param>
/// <param name="value">Address where floating point value will be stored.</param>
/// <param name="value">Address where floating-point value will be stored.</param>
public void GetAuxiliaryEffectSlot(int asid, EfxAuxiliaryf pname, out float value)
{

6
Source/OpenTK/Audio/OpenAL/AL/EffectsExtensionEnums.cs
View file

@ -13,7 +13,7 @@ namespace OpenTK.Audio.OpenAL
{
#region Effect
///<summary>A list of valid 32-Bits Float Effect/GetEffect parameters</summary>
///<summary>A list of valid 32-bit Float Effect/GetEffect parameters</summary>
public enum EfxEffectf : int
{
///<summary>Reverb Modal Density controls the coloration of the late reverb. Lowering the value adds more coloration to the late reverb. Range [0.0f .. 1.0f] Default: 1.0f</summary>
@ -424,7 +424,7 @@ namespace OpenTK.Audio.OpenAL
EffectslotAuxiliarySendAuto = 0x0003,
}
///<summary>A list of valid 32-Bits Float AuxiliaryEffectSlot/GetAuxiliaryEffectSlot parameters</summary>
///<summary>A list of valid 32-bits Float AuxiliaryEffectSlot/GetAuxiliaryEffectSlot parameters</summary>
public enum EfxAuxiliaryf : int
{
/// <summary>This property is used to specify an output level for the Auxiliary Effect Slot. Setting the gain to 0.0f mutes the output. Range [0.0f .. 1.0f] Default: 1.0f</summary>
@ -435,7 +435,7 @@ namespace OpenTK.Audio.OpenAL
#region Filter Object
///<summary>A list of valid 32-Bits Float Filter/GetFilter parameters</summary>
///<summary>A list of valid 32-bits Float Filter/GetFilter parameters</summary>
public enum EfxFilterf : int
{
///<summary>Range [0.0f .. 1.0f] Default: 1.0f</summary>

52
Source/OpenTK/Math/Half.cs
View file

@ -66,7 +66,7 @@ namespace OpenTK
/// <summary>
/// The name Half is derived from half-precision floating-point number.
/// It occupies only 16 Bits, which are split into 1 Sign bit, 5 Exponent bits and 10 Mantissa bits.
/// It occupies only 16 bits, which are split into 1 Sign bit, 5 Exponent bits and 10 Mantissa bits.
/// </summary>
/// <remarks>
/// Quote from ARB_half_float_pixel specification:
@ -103,9 +103,9 @@ namespace OpenTK
#region Constructors
/// <summary>
/// The new Half instance will convert the parameter into 16-Bit Half precision floating point.
/// The new Half instance will convert the parameter into 16-bit half-precision floating-point.
/// </summary>
/// <param name="f">32-Bit Single precision floating point number.</param>
/// <param name="f">32-bit single-precision floating-point number.</param>
public Half(Single f)
: this()
{
@ -116,9 +116,9 @@ namespace OpenTK
}
/// <summary>
/// The new Half instance will convert the parameter into 16-Bit Half precision floating point.
/// The new Half instance will convert the parameter into 16-bit half-precision floating-point.
/// </summary>
/// <param name="f">32-Bit Single precision floating point number.</param>
/// <param name="f">32-bit single-precision floating-point number.</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
public Half(Single f, bool throwOnError)
: this(f)
@ -130,22 +130,22 @@ namespace OpenTK
if (f < -Half.MaxValue) throw new ArithmeticException("Half: Negative minimum value exceeded.");
// handle cases that make no sense
if (Single.IsNaN(f)) throw new ArithmeticException("Half: input is Not a Number (NaN).");
if (Single.IsPositiveInfinity(f)) throw new ArithmeticException("Half: input is +infinity.");
if (Single.IsNegativeInfinity(f)) throw new ArithmeticException("Half: input is -infinity.");
if (Single.IsNaN(f)) throw new ArithmeticException("Half: Input is not a number (NaN).");
if (Single.IsPositiveInfinity(f)) throw new ArithmeticException("Half: Input is positive infinity.");
if (Single.IsNegativeInfinity(f)) throw new ArithmeticException("Half: Input is negative infinity.");
}
}
/// <summary>
/// The new Half instance will convert the parameter into 16-Bit Half precision floating point.
/// The new Half instance will convert the parameter into 16-bit half-precision floating-point.
/// </summary>
/// <param name="d">64-Bit Double precision floating point number.</param>
/// <param name="d">64-bit double-precision floating-point number.</param>
public Half(Double d) : this((Single)d) { }
/// <summary>
/// The new Half instance will convert the parameter into 16-Bit Half precision floating point.
/// The new Half instance will convert the parameter into 16-bit half-precision floating-point.
/// </summary>
/// <param name="d">64-Bit Double precision floating point number.</param>
/// <param name="d">64-bit double-precision floating-point number.</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
public Half(Double d, bool throwOnError) : this((Single)d, throwOnError) { }
@ -235,7 +235,7 @@ namespace OpenTK
}
// exponent overflow
if (exponent > 30) throw new ArithmeticException("Half: hardware floating point overflow.");
if (exponent > 30) throw new ArithmeticException("Half: Hardware floating-point overflow.");
// Assemble the half from S, E and M.
@ -247,8 +247,8 @@ namespace OpenTK
#region Half -> Single
/// <summary>Converts the 16-Bit half to 32-Bit floating point.</summary>
/// <returns>A Single precision floating point Number.</returns>
/// <summary>Converts the 16-bit half to 32-bit floating-point.</summary>
/// <returns>A single-precision floating-point number.</returns>
public Single ToSingle()
{
int i = HalfToFloat(bits);
@ -504,7 +504,7 @@ namespace OpenTK
}
/// <summary>Converts this Half into a human-legible string representation.</summary>
/// <param name="format">formatting for the output string.</param>
/// <param name="format">Formatting for the output string.</param>
/// <param name="formatProvider">Culture-specific formatting information.</param>
/// <returns>The string representation of this instance.</returns>
public string ToString(string format, IFormatProvider formatProvider)
@ -516,17 +516,17 @@ namespace OpenTK
#region String -> Half
/// <summary>Converts the string representation of a number to a Half precision floating point equivalent.</summary>
/// <param name="s">string representation of the number to convert.</param>
/// <summary>Converts the string representation of a number to a half-precision floating-point equivalent.</summary>
/// <param name="s">String representation of the number to convert.</param>
/// <returns>A new Half instance.</returns>
public static Half Parse(string s)
{
return (Half)Single.Parse(s);
}
/// <summary>Converts the string representation of a number to a Half precision floating point equivalent.</summary>
/// <param name="s">string representation of the number to convert.</param>
/// <param name="style">specifies the format of s.</param>
/// <summary>Converts the string representation of a number to a half-precision floating-point equivalent.</summary>
/// <param name="s">String representation of the number to convert.</param>
/// <param name="style">Specifies the format of s.</param>
/// <param name="provider">Culture-specific formatting information.</param>
/// <returns>A new Half instance.</returns>
public static Half Parse(string s, System.Globalization.NumberStyles style, IFormatProvider provider)
@ -534,8 +534,8 @@ namespace OpenTK
return (Half)Single.Parse(s, style, provider);
}
/// <summary>Converts the string representation of a number to a Half precision floating point equivalent. Returns success.</summary>
/// <param name="s">string representation of the number to convert.</param>
/// <summary>Converts the string representation of a number to a half-precision floating-point equivalent. Returns success.</summary>
/// <param name="s">String representation of the number to convert.</param>
/// <param name="result">The Half instance to write to.</param>
/// <returns>Success.</returns>
public static bool TryParse(string s, out Half result)
@ -546,9 +546,9 @@ namespace OpenTK
return b;
}
/// <summary>Converts the string representation of a number to a Half precision floating point equivalent. Returns success.</summary>
/// <param name="s">string representation of the number to convert.</param>
/// <param name="style">specifies the format of s.</param>
/// <summary>Converts the string representation of a number to a half-precision floating-point equivalent. Returns success.</summary>
/// <param name="s">String representation of the number to convert.</param>
/// <param name="style">Specifies the format of s.</param>
/// <param name="provider">Culture-specific formatting information.</param>
/// <param name="result">The Half instance to write to.</param>
/// <returns>Success.</returns>

2
Source/OpenTK/Math/Matrix3d.cs
View file

@ -270,7 +270,7 @@ namespace OpenTK
this.R2C2 = r2c2;
}
/// <summary>Constructs left matrix from the given array of double-precision floating point numbers.</summary>
/// <summary>Constructs left matrix from the given array of double-precision floating-point numbers.</summary>
/// <param name="doubleArray">The array of doubles for the components of the matrix.</param>
public Matrix3d(double[] doubleArray)
{

2
Source/OpenTK/Math/Quaterniond.cs
View file

@ -741,7 +741,7 @@ namespace OpenTK
this.Z = z;
}
/// <summary>Constructs left Quaterniond from the given array of double-precision floating point numbers.</summary>
/// <summary>Constructs left Quaterniond from the given array of double-precision floating-point numbers.</summary>
/// <param name="doubleArray">The array of doubles for the components of the Quaterniond.</param>
public Quaterniond(double[] doubleArray)
{

32
Source/OpenTK/Math/Vector2h.cs
View file

@ -49,8 +49,8 @@ namespace OpenTK
/// <summary>
/// The new Half2 instance will avoid conversion and copy directly from the Half parameters.
/// </summary>
/// <param name="x">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="y">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="x">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="y">An Half instance of a 16-bit half-precision floating-point number.</param>
public Vector2h(Half x, Half y)
{
X = x;
@ -58,10 +58,10 @@ namespace OpenTK
}
/// <summary>
/// The new Half2 instance will convert the 2 parameters into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the 2 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
public Vector2h(Single x, Single y)
{
X = new Half(x);
@ -69,10 +69,10 @@ namespace OpenTK
}
/// <summary>
/// The new Half2 instance will convert the 2 parameters into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the 2 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
public Vector2h(Single x, Single y, bool throwOnError)
{
@ -81,7 +81,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half2 instance will convert the Vector2 into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2</param>
[CLSCompliant(false)]
@ -92,7 +92,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half2 instance will convert the Vector2 into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -104,7 +104,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half2 instance will convert the Vector2 into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2 into 16-bit half-precision floating-point.
/// This is the fastest constructor.
/// </summary>
/// <param name="v">OpenTK.Vector2</param>
@ -115,7 +115,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half2 instance will convert the Vector2 into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -126,7 +126,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half2 instance will convert the Vector2d into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2d</param>
public Vector2h(Vector2d v)
@ -136,7 +136,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half2 instance will convert the Vector2d into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -147,7 +147,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half2 instance will convert the Vector2d into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2d into 16-bit half-precision floating-point.
/// This is the faster constructor.
/// </summary>
/// <param name="v">OpenTK.Vector2d</param>
@ -159,7 +159,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half2 instance will convert the Vector2d into 16-Bit Half precision floating point.
/// The new Half2 instance will convert the Vector2d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector2d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>

38
Source/OpenTK/Math/Vector3h.cs
View file

@ -54,9 +54,9 @@ namespace OpenTK
/// <summary>
/// The new Half3 instance will avoid conversion and copy directly from the Half parameters.
/// </summary>
/// <param name="x">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="y">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="z">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="x">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="y">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="z">An Half instance of a 16-bit half-precision floating-point number.</param>
public Vector3h(Half x, Half y, Half z)
{
this.X = x;
@ -65,11 +65,11 @@ namespace OpenTK
}
/// <summary>
/// The new Half3 instance will convert the 3 parameters into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the 3 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="z">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
/// <param name="z">32-bit single-precision floating-point number.</param>
public Vector3h(Single x, Single y, Single z)
{
X = new Half(x);
@ -78,11 +78,11 @@ namespace OpenTK
}
/// <summary>
/// The new Half3 instance will convert the 3 parameters into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the 3 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="z">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
/// <param name="z">32-bit single-precision floating-point number.</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
public Vector3h(Single x, Single y, Single z, bool throwOnError)
{
@ -92,7 +92,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half3 instance will convert the Vector3 into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3</param>
[CLSCompliant(false)]
@ -104,7 +104,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half3 instance will convert the Vector3 into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -117,7 +117,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half3 instance will convert the Vector3 into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3 into 16-bit half-precision floating-point.
/// This is the fastest constructor.
/// </summary>
/// <param name="v">OpenTK.Vector3</param>
@ -129,7 +129,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half3 instance will convert the Vector3 into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -141,7 +141,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half3 instance will convert the Vector3d into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3d</param>
public Vector3h(Vector3d v)
@ -152,7 +152,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half3 instance will convert the Vector3d into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -164,7 +164,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half3 instance will convert the Vector3d into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3d into 16-bit half-precision floating-point.
/// This is the faster constructor.
/// </summary>
/// <param name="v">OpenTK.Vector3d</param>
@ -177,7 +177,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half3 instance will convert the Vector3d into 16-Bit Half precision floating point.
/// The new Half3 instance will convert the Vector3d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector3d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>

44
Source/OpenTK/Math/Vector4h.cs
View file

@ -57,10 +57,10 @@ namespace OpenTK
/// <summary>
/// The new Half4 instance will avoid conversion and copy directly from the Half parameters.
/// </summary>
/// <param name="x">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="y">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="z">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="w">An Half instance of a 16-Bit half precision floating point number.</param>
/// <param name="x">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="y">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="z">An Half instance of a 16-bit half-precision floating-point number.</param>
/// <param name="w">An Half instance of a 16-bit half-precision floating-point number.</param>
public Vector4h(Half x, Half y, Half z, Half w)
{
this.X = x;
@ -70,12 +70,12 @@ namespace OpenTK
}
/// <summary>
/// The new Half4 instance will convert the 4 parameters into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the 4 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="z">32-Bit Single precision floating point number.</param>
/// <param name="w">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
/// <param name="z">32-bit single-precision floating-point number.</param>
/// <param name="w">32-bit single-precision floating-point number.</param>
public Vector4h(Single x, Single y, Single z, Single w)
{
X = new Half(x);
@ -85,12 +85,12 @@ namespace OpenTK
}
/// <summary>
/// The new Half4 instance will convert the 4 parameters into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the 4 parameters into 16-bit half-precision floating-point.
/// </summary>
/// <param name="x">32-Bit Single precision floating point number.</param>
/// <param name="y">32-Bit Single precision floating point number.</param>
/// <param name="z">32-Bit Single precision floating point number.</param>
/// <param name="w">32-Bit Single precision floating point number.</param>
/// <param name="x">32-bit single-precision floating-point number.</param>
/// <param name="y">32-bit single-precision floating-point number.</param>
/// <param name="z">32-bit single-precision floating-point number.</param>
/// <param name="w">32-bit single-precision floating-point number.</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
public Vector4h(Single x, Single y, Single z, Single w, bool throwOnError)
{
@ -101,7 +101,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half4 instance will convert the Vector4 into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4</param>
[CLSCompliant(false)]
@ -114,7 +114,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half4 instance will convert the Vector4 into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -128,7 +128,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half4 instance will convert the Vector4 into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4 into 16-bit half-precision floating-point.
/// This is the fastest constructor.
/// </summary>
/// <param name="v">OpenTK.Vector4</param>
@ -141,7 +141,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half4 instance will convert the Vector4 into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4 into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -154,7 +154,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half4 instance will convert the Vector4d into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4d</param>
public Vector4h(Vector4d v)
@ -166,7 +166,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half4 instance will convert the Vector4d into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>
@ -179,7 +179,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half4 instance will convert the Vector4d into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4d into 16-bit half-precision floating-point.
/// This is the faster constructor.
/// </summary>
/// <param name="v">OpenTK.Vector4d</param>
@ -193,7 +193,7 @@ namespace OpenTK
}
/// <summary>
/// The new Half4 instance will convert the Vector4d into 16-Bit Half precision floating point.
/// The new Half4 instance will convert the Vector4d into 16-bit half-precision floating-point.
/// </summary>
/// <param name="v">OpenTK.Vector4d</param>
/// <param name="throwOnError">Enable checks that will throw if the conversion result is not meaningful.</param>