ryujinx-backup/Opentk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Bind* added, docu improved.

Browse source
This commit is contained in:
chrisbrandtner 2008-01-25 22:14:16 +00:00
parent a4c481fe30
commit 23b449b709
5 changed files with 303 additions and 261 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
Source/OpenTK/OpenAL/AlFunctions.cs
View file

@ -515,19 +515,7 @@ namespace OpenTK.OpenAL
///<param name="value3">The value to set the attribute to. (EFX Extension) optional Filter ID.</param>
[CLSCompliant(false),DllImport(AL.Lib,EntryPoint = "alSource3i",ExactSpelling = true,CallingConvention = AL.Style),SuppressUnmanagedCodeSecurity( )]
public static extern void Source( uint sid,Enums.ALSource3i param,int value1,int value2,int value3 );
// AL_API void AL_APIENTRY alSource3i( ALuint sid, ALenum param, ALint value1, ALint value2, ALint value3 );
/// <summary>(Helper) Reroutes a Source's output into an Auxiliary Effect Slot.</summary>
/// <param name="source">The Source handle who's output is forwarded.</param>
/// <param name="slot">The Auxiliary Effect Slot handle that receives input from the Source.</param>
/// <param name="slotnumber">Every Source has only a limited number of slots it can feed data to. The number must stay below AlcContextAttributes.EfxMaxAuxiliarySends</param>
/// <param name="filter">Filter handle to be attached between Source ouput and Auxiliary Slot input. Use 0 or EfxFilterType.FilterNull for no filter. </param>
[CLSCompliant(false)]
public static void BindSourceToAuxiliarySlot( uint source,uint slot,int slotnumber, uint filter )
{
AL.Source(source,Enums.ALSource3i.EfxAuxiliarySendFilter,(int) slot,slotnumber,(int) filter);
}
// AL_API void AL_APIENTRY alSource3i( ALuint sid, ALenum param, ALint value1, ALint value2, ALint value3 );
// Not used by any Enum:
// AL_API void AL_APIENTRY alSourcefv( ALuint sid, ALenum param, const ALfloat* values );

32
Source/OpenTK/OpenAL/AlTokens.cs
View file

@ -12,12 +12,14 @@ using System;
namespace OpenTK.OpenAL.Enums
{
///<summary>A list of valid Enable/Disable/IsEnabled parameters</summary>
public enum ALCapability : int
{
///<summary>Currently no state toggles exist for vanilla OpenAL and no Extension uses it.</summary>
Invalid = -1,
}
///<summary>A list of valid 32-Bits 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>
@ -27,6 +29,7 @@ namespace OpenTK.OpenAL.Enums
EfxMetersPerUnit = 0x20004,
}
///<summary>A list of valid Math.Vector3 Listener/GetListener parameters</summary>
public enum ALListener3f : int
{
///<summary>Specify the current location in three dimensional space. OpenAL, like OpenGL, uses a right handed coordinate system, where in a frontal default view X (thumb) points right, Y points up (index finger), and Z points towards the viewer/camera (middle finger). To switch from a left handed coordinate system, flip the sign on the Z coordinate. Listener position is always in the world coordinate system.</summary>
@ -36,12 +39,14 @@ namespace OpenTK.OpenAL.Enums
Velocity = 0x1006,
}
///<summary>A list of valid float[] Listener/GetListener parameters</summary>
public enum ALListenerfv : int
{
///<summary>Indicate Listener orientation. Expects two Vector3, At followed by Up.</summary>
Orientation = 0x100F,
}
///<summary>A list of valid 32-Bits 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>
@ -88,6 +93,7 @@ namespace OpenTK.OpenAL.Enums
}
///<summary>A list of valid Math.Vector3 Source/GetSource parameters</summary>
public enum ALSource3f : int
{
///<summary>Specify the current location in three dimensional space. OpenAL, like OpenGL, uses a right handed coordinate system, where in a frontal default view X (thumb) points right, Y points up (index finger), and Z points towards the viewer/camera (middle finger). To switch from a left handed coordinate system, flip the sign on the Z coordinate. Listener position is always in the world coordinate system.</summary>
@ -100,6 +106,7 @@ namespace OpenTK.OpenAL.Enums
Direction = 0x1005,
}
///<summary>A list of valid 8-Bits boolean Source/GetSource parameters</summary>
public enum ALSourceb : int
{
///<summary>Indicate that the Source has relative coordinates. Type: bool Range: [True, False]</summary>
@ -118,6 +125,7 @@ namespace OpenTK.OpenAL.Enums
EfxAuxiliarySendFilterGainHighFrequencyAuto = 0x2000C,
}
///<summary>A list of valid Int32 Source parameters</summary>
public enum ALSourcei : int
{
///<summary>The playback position, expressed in bytes.</summary>
@ -136,19 +144,21 @@ namespace OpenTK.OpenAL.Enums
EfxDirectFilter = 0x20005,
}
///<summary>A list of valid 3x Int32 Source/GetSource parameters</summary>
public enum ALSource3i : int
{
///<summary>(EFX Extension) This Source property is used to establish connections between Sources and Auxiliary Effect Slots. For a Source to feed an Effect that has been loaded into an Auxiliary Effect Slot the application must configure one of the Source’s auxiliary sends. This process involves setting 3 variables – the destination Auxiliary Effect Slot ID, the Auxiliary Send number, and an optional Filter ID. Type: uint Range: any valid Filter Handle.</summary>
EfxAuxiliarySendFilter = 0x20006,
}
///<summary>A list of valid Int32 GetSource parameters</summary>
public enum ALGetSourcei : int
{
///<summary>The playback position, expressed in bytes.</summary>
ByteOffset = 0x1026, // AL_EXT_OFFSET extension.
///<summary>The playback position, expressed in bytes. AL_EXT_OFFSET Extension.</summary>
ByteOffset = 0x1026,
///<summary>The playback position, expressed in samples.</summary>
SampleOffset = 0x1025, // AL_EXT_OFFSET extension.
///<summary>The playback position, expressed in samples. AL_EXT_OFFSET Extension.</summary>
SampleOffset = 0x1025,
///<summary>Indicate the Buffer to provide sound samples. Type: uint Range: any valid Buffer Handle.</summary>
Buffer = 0x1009,
@ -166,13 +176,15 @@ namespace OpenTK.OpenAL.Enums
SourceType = 0x1027,
}
/*
public enum ALDeprecated : int
{
///<summary>Deprecated. Specify the channel mask. (Creative) Type: uint Range: [0 - 255]</summary>
ChannelMask = 0x3000,
}
*/
///<summary>Source state information.</summary>
///<summary>Source state information, can be retrieved by AL.Source() with ALSourcei.SourceState.</summary>
public enum ALSourceState : int
{
///<summary>Default State when loaded, can be manually set with AL.SourceRewind().</summary>
@ -188,7 +200,7 @@ namespace OpenTK.OpenAL.Enums
Stopped = 0x1014,
}
///<summary>Source type (Static, Streaming or undetermined)</summary>
///<summary>Source type information, can be retrieved by AL.Source() with ALSourcei.SourceType.</summary>
public enum ALSourceType : int
{
///<summary>Source is Static if a Buffer has been attached using AL.Source with the parameter Sourcei.Buffer.</summary>
@ -217,6 +229,7 @@ namespace OpenTK.OpenAL.Enums
Stereo16 = 0x1103,
}
///<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>
@ -247,6 +260,7 @@ namespace OpenTK.OpenAL.Enums
Processed = 0x2012,
}
/// <summary>Returned by AL.GetError</summary>
public enum ALError : int
{
///<summary>No OpenAL Error.</summary>
@ -272,6 +286,7 @@ namespace OpenTK.OpenAL.Enums
OutOfMemory = 0xA005,
}
///<summary>A list of valid string AL.Get() parameters</summary>
public enum ALGetString : int
{
/// <summary>Gets the Vendor name.</summary>
@ -287,6 +302,7 @@ namespace OpenTK.OpenAL.Enums
Extensions = 0xB004,
}
///<summary>A list of valid 32-Bits Float AL.Get() parameters</summary>
public enum ALGetFloat : int
{
///<summary>Doppler scale. Default 1.0f</summary>
@ -299,12 +315,14 @@ namespace OpenTK.OpenAL.Enums
SpeedOfSound = 0xC003,
}
///<summary>A list of valid Int32 AL.Get() parameters</summary>
public enum ALGetInteger : int
{
///<summary>See enum ALDistanceModel.</summary><see cref="ALDistanceModel"/>
DistanceModel = 0xD000,
}
/// <summary>Used by AL.DistanceModel(), the distance model can be retrieved by AL.Get() with ALGetInteger.DistanceModel</summary>
public enum ALDistanceModel : int
{
///<summary>Bypasses all distance attenuation calculation for all Sources.</summary>
@ -321,7 +339,7 @@ namespace OpenTK.OpenAL.Enums
///<summary>AL_EXT_LINEAR_DISTANCE extension.</summary>
LinearDistanceClamped = 0xD004,
///<summary>AL_EXT_EXPONENT_DISTANCE extension.</summary>
ExponentDistance = 0xD005,

169
Source/OpenTK/OpenAL/EfxFunctions.cs
View file

@ -8,27 +8,87 @@
#endregion
using System;
using System.Diagnostics;
using System.Runtime.InteropServices;
using OpenTK.Math;
namespace OpenTK.OpenAL
{
public partial class EfxExtension
{
#region Helpers
#region BindEffect
/// <summary>(Helper) Selects the Effect type used by this Effect handle.</summary>
/// <param name="eid">Effect id returned from a successful call to GenEffects.</param>
/// <param name="type">Effect type.</param>
[CLSCompliant(false)]
public void BindEffect( uint eid,Enums.EfxEffectType type )
{
Imported_alEffecti(eid,Enums.EfxEffecti.EffectType,(int) type);
}
#endregion BindEffect
#region BindFilterToSource
/// <summary>(Helper) reroutes the output of a Source through a Filter.</summary>
/// <param name="source">A valid Source handle.</param>
/// <param name="filter">A valid Filter handle.</param>
[CLSCompliant(false)]
public void BindFilterToSource( uint source,uint filter )
{
AL.Source(source,Enums.ALSourcei.EfxDirectFilter,(int) filter);
}
#endregion BindFilterToSource
#region BindEffectToAuxiliarySlot
/// <summary>(Helper) Attaches an Effect to an Auxiliary Effect Slot.</summary>
/// <param name="auxiliaryeffectslot">The slot handle to attach the Effect to.</param>
/// <param name="effect">The Effect handle that is being attached.</param>
[CLSCompliant(false)]
public void BindEffectToAuxiliarySlot( uint auxiliaryeffectslot,uint effect )
{
AuxiliaryEffectSlot(auxiliaryeffectslot,Enums.EfxAuxiliaryi.EffectslotEffect,(int) effect);
}
#endregion BindEffectToAuxiliarySlot
#region BindSourceToAuxiliarySlot
/// <summary>(Helper) Reroutes a Source's output into an Auxiliary Effect Slot.</summary>
/// <param name="source">The Source handle who's output is forwarded.</param>
/// <param name="slot">The Auxiliary Effect Slot handle that receives input from the Source.</param>
/// <param name="slotnumber">Every Source has only a limited number of slots it can feed data to. The number must stay below AlcContextAttributes.EfxMaxAuxiliarySends</param>
/// <param name="filter">Filter handle to be attached between Source ouput and Auxiliary Slot input. Use 0 or EfxFilterType.FilterNull for no filter. </param>
[CLSCompliant(false)]
public void BindSourceToAuxiliarySlot( uint source,uint slot,int slotnumber,uint filter )
{
AL.Source(source,Enums.ALSource3i.EfxAuxiliarySendFilter,(int) slot,slotnumber,(int) filter);
}
#endregion BindSourceToAuxiliarySlot
#endregion Helpers
#region Effect Object
#region alGenEffects
// typedef void (__cdecl *LPALGENEFFECTS)( ALsizei n, ALuint* effects );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alGenEffects( int n,[Out] uint* effects );
// typedef void (__cdecl *LPALGENEFFECTS)( ALsizei n, ALuint* effects );
//[CLSCompliant(false)]
private Delegate_alGenEffects Imported_alGenEffects;
/// <summary>The alGenEffects function is used to create one or more Effect objects. An Effect object stores an effect type and a set of parameter values to control that Effect. In order to use an Effect it must be attached to an Auxiliary Effect Slot object</summary>
/// <remarks>After creation an Effect has no type (AL_EFFECT_NULL), so before it can be used to store a set of parameters, the application must specify what type of effect should be stored in the object, using alEffecti.</remarks>
/// <summary>The GenEffects function is used to create one or more Effect objects. An Effect object stores an effect type and a set of parameter values to control that Effect. In order to use an Effect it must be attached to an Auxiliary Effect Slot object</summary>
/// <remarks>After creation an Effect has no type (EfxEffectType.Null), so before it can be used to store a set of parameters, the application must specify what type of effect should be stored in the object, using Effect() with EfxEffecti.</remarks>
/// <param name="n">Number of Effects to be created.</param>
/// <param name="effects">Pointer addressing sufficient memory to store n Effect object identifiers.</param>
[CLSCompliant(false)]
@ -62,14 +122,14 @@ namespace OpenTK.OpenAL
#region alDeleteEffects
// typedef void (__cdecl *LPALDELETEEFFECTS)( ALsizei n, ALuint* effects );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alDeleteEffects( int n,[In] uint* effects );
// typedef void (__cdecl *LPALDELETEEFFECTS)( ALsizei n, ALuint* effects );
//[CLSCompliant(false)]
private Delegate_alDeleteEffects Imported_alDeleteEffects;
/// <summary>The alDeleteEffects function is used to delete and free resources for Effect objects previously created with alGenEffects.</summary>
/// <summary>The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects.</summary>
/// <param name="n">Number of Effects to be deleted.</param>
/// <param name="effects">Pointer to n Effect object identifiers.</param>
[CLSCompliant(false)]
@ -102,14 +162,14 @@ namespace OpenTK.OpenAL
#region alIsEffect
// typedef ALboolean (__cdecl *LPALISEFFECT)( ALuint eid );
//[CLSCompliant(false)]
private delegate bool Delegate_alIsEffect( uint eid );
// typedef ALboolean (__cdecl *LPALISEFFECT)( ALuint eid );
//[CLSCompliant(false)]
private Delegate_alIsEffect Imported_alIsEffect;
/// <summary>The alIsEffect function is used to determine if an object identifier is a valid Effect object.</summary>
/// <summary>The IsEffect function is used to determine if an object identifier is a valid Effect object.</summary>
/// <param name="eid">Effect identifier to validate.</param>
/// <returns>True if the identifier is a valid Effect, False otherwise.</returns>
[CLSCompliant(false)]
@ -122,9 +182,9 @@ namespace OpenTK.OpenAL
#region alEffecti
// typedef void (__cdecl *LPALEFFECTI)( ALuint eid, ALenum param, ALint value);
//[CLSCompliant(false)]
private delegate void Delegate_alEffecti( uint eid,Enums.EfxEffecti param,int value );
// typedef void (__cdecl *LPALEFFECTI)( ALuint eid, ALenum param, ALint value);
//[CLSCompliant(false)]
private Delegate_alEffecti Imported_alEffecti;
@ -139,22 +199,13 @@ namespace OpenTK.OpenAL
Imported_alEffecti(eid,param,value);
}
/// <summary>(Helper) Selects the Effect type used by this Effect handle.</summary>
/// <param name="eid">Effect id returned from a successful call to Efx.GenEffects.</param>
/// <param name="type">Effect type.</param>
[CLSCompliant(false)]
public void BindEffect( uint eid,Enums.EfxEffectType type )
{
Imported_alEffecti(eid,Enums.EfxEffecti.EffectType,(int) type);
}
#endregion alEffecti
#region alEffectf
// typedef void (__cdecl *LPALEFFECTF)( ALuint eid, ALenum param, ALfloat value);
//[CLSCompliant(false)]
private delegate void Delegate_alEffectf( uint eid,Enums.EfxEffectf param,float value );
// typedef void (__cdecl *LPALEFFECTF)( ALuint eid, ALenum param, ALfloat value);
//[CLSCompliant(false)]
private Delegate_alEffectf Imported_alEffectf;
@ -174,8 +225,8 @@ namespace OpenTK.OpenAL
#region alEffectfv
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alEffectfv(uint eid, Enums.EfxEffect3f param, [In] float* values);
// typedef void (__cdecl *LPALEFFECTFV)( ALuint eid, ALenum param, ALfloat* values );
unsafe private delegate void Delegate_alEffectfv( uint eid,Enums.EfxEffect3f param,[In] float* values );
// typedef void (__cdecl *LPALEFFECTFV)( ALuint eid, ALenum param, ALfloat* values );
//[CLSCompliant(false)]
private Delegate_alEffectfv Imported_alEffectfv;
@ -196,9 +247,9 @@ namespace OpenTK.OpenAL
#region alGetEffecti
// typedef void (__cdecl *LPALGETEFFECTI)( ALuint eid, ALenum pname, ALint* value );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alGetEffecti( uint eid,Enums.EfxEffecti pname,[Out] int* value );
// typedef void (__cdecl *LPALGETEFFECTI)( ALuint eid, ALenum pname, ALint* value );
//[CLSCompliant(false)]
private Delegate_alGetEffecti Imported_alGetEffecti;
@ -223,9 +274,9 @@ namespace OpenTK.OpenAL
#region alGetEffectf
// typedef void (__cdecl *LPALGETEFFECTF)( ALuint eid, ALenum pname, ALfloat* value );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alGetEffectf( uint eid,Enums.EfxEffectf pname,[Out]float* value );
// typedef void (__cdecl *LPALGETEFFECTF)( ALuint eid, ALenum pname, ALfloat* value );
//[CLSCompliant(false)]
private Delegate_alGetEffectf Imported_alGetEffectf;
@ -249,8 +300,7 @@ namespace OpenTK.OpenAL
#endregion alGetEffectf
#region alGetEffectfv
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alGetEffectfv( uint eid,Enums.EfxEffect3f param,[Out] float* values );
// typedef void (__cdecl *LPALGETEFFECTFV)( ALuint eid, ALenum pname, ALfloat* values );
@ -285,15 +335,15 @@ namespace OpenTK.OpenAL
#region alGenFilters
// typedef void (__cdecl *LPALGENFILTERS)( ALsizei n, ALuint* filters );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alGenFilters( int n,[Out] uint* filters );
// typedef void (__cdecl *LPALGENFILTERS)( ALsizei n, ALuint* filters );
//[CLSCompliant(false)]
private Delegate_alGenFilters Imported_alGenFilters;
/// <summary>The alGenFilters function is used to create one or more Filter objects. A Filter object stores a filter type and a set of parameter values to control that Filter. Filter objects can be attached to Sources as Direct Filters or Auxiliary Send Filters.</summary>
/// <remarks>After creation a Filter has no type (AL_FILTER_NULL), so before it can be used to store a set of parameters, the application must specify what type of filter should be stored in the object, using alFilteri.</remarks>
/// <summary>The GenFilters function is used to create one or more Filter objects. A Filter object stores a filter type and a set of parameter values to control that Filter. Filter objects can be attached to Sources as Direct Filters or Auxiliary Send Filters.</summary>
/// <remarks>After creation a Filter has no type (EfxFilterType.Null), so before it can be used to store a set of parameters, the application must specify what type of filter should be stored in the object, using Filter() with EfxFilteri.</remarks>
/// <param name="n">Number of Filters to be created.</param>
/// <param name="filters">Pointer addressing sufficient memory to store n Filter object identifiers.</param>
[CLSCompliant(false)]
@ -327,14 +377,14 @@ namespace OpenTK.OpenAL
#region alDeleteFilters
// typedef void (__cdecl *LPALDELETEFILTERS)( ALsizei n, ALuint* filters );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alDeleteFilters( int n,[In] uint* filters );
// typedef void (__cdecl *LPALDELETEFILTERS)( ALsizei n, ALuint* filters );
//[CLSCompliant(false)]
private Delegate_alDeleteFilters Imported_alDeleteFilters;
/// <summary>The alDeleteFilters function is used to delete and free resources for Filter objects previously created with alGenFilters.</summary>
/// <summary>The DeleteFilters function is used to delete and free resources for Filter objects previously created with GenFilters.</summary>
/// <param name="n">Number of Filters to be deleted.</param>
/// <param name="filters">Pointer to n Filter object identifiers.</param>
[CLSCompliant(false)]
@ -367,14 +417,14 @@ namespace OpenTK.OpenAL
#region alIsFilter
// typedef ALboolean (__cdecl *LPALISFILTER)( ALuint fid );
//[CLSCompliant(false)]
private delegate bool Delegate_alIsFilter( uint fid );
// typedef ALboolean (__cdecl *LPALISFILTER)( ALuint fid );
//[CLSCompliant(false)]
private Delegate_alIsFilter Imported_alIsFilter;
/// <summary>The alIsFilter function is used to determine if an object identifier is a valid Filter object.</summary>
/// <summary>The IsFilter function is used to determine if an object identifier is a valid Filter object.</summary>
/// <param name="fid">Effect identifier to validate.</param>
/// <returns>True if the identifier is a valid Filter, False otherwise.</returns>
[CLSCompliant(false)]
@ -387,9 +437,9 @@ namespace OpenTK.OpenAL
#region alFilteri
// typedef void (__cdecl *LPALFILTERI)( ALuint fid, ALenum param, ALint value );
//[CLSCompliant(false)]
private delegate void Delegate_alFilteri( uint fid,Enums.EfxFilteri param,int value );
// typedef void (__cdecl *LPALFILTERI)( ALuint fid, ALenum param, ALint value );
//[CLSCompliant(false)]
private Delegate_alFilteri Imported_alFilteri;
@ -404,13 +454,13 @@ namespace OpenTK.OpenAL
Imported_alFilteri(fid,param,value);
}
#endregion alFilteri( uint fid,Enums.EfxFilteri param,int value )
#endregion alFilteri
#region alFilterf
// typedef void (__cdecl *LPALFILTERF)( ALuint fid, ALenum param, ALfloat value);
//[CLSCompliant(false)]
private delegate void Delegate_alFilterf( uint fid,Enums.EfxFilterf param,float value );
// typedef void (__cdecl *LPALFILTERF)( ALuint fid, ALenum param, ALfloat value);
//[CLSCompliant(false)]
private Delegate_alFilterf Imported_alFilterf;
@ -429,9 +479,9 @@ namespace OpenTK.OpenAL
#region alGetFilteri
// typedef void (__cdecl *LPALGETFILTERI)( ALuint fid, ALenum pname, ALint* value );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alGetFilteri( uint fid,Enums.EfxFilteri pname,[Out] int* value );
// typedef void (__cdecl *LPALGETFILTERI)( ALuint fid, ALenum pname, ALint* value );
//[CLSCompliant(false)]
private Delegate_alGetFilteri Imported_alGetFilteri;
@ -456,9 +506,9 @@ namespace OpenTK.OpenAL
#region alGetFilterf
// typedef void (__cdecl *LPALGETFILTERF)( ALuint fid, ALenum pname, ALfloat* value );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alGetFilterf( uint fid,Enums.EfxFilterf pname,[Out] float* value );
// typedef void (__cdecl *LPALGETFILTERF)( ALuint fid, ALenum pname, ALfloat* value );
//[CLSCompliant(false)]
private Delegate_alGetFilterf Imported_alGetFilterf;
@ -491,16 +541,18 @@ namespace OpenTK.OpenAL
#region Auxiliary Effect Slot Object
#region alGenAuxiliaryEffectSlots
// typedef void (__cdecl *LPALGENAUXILIARYEFFECTSLOTS)( ALsizei n, ALuint* slots );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alGenAuxiliaryEffectSlots( int n,[Out] uint* slots );
// typedef void (__cdecl *LPALGENAUXILIARYEFFECTSLOTS)( ALsizei n, ALuint* slots );
//[CLSCompliant(false)]
private Delegate_alGenAuxiliaryEffectSlots Imported_alGenAuxiliaryEffectSlots;
/// <summary>The alGenAuxiliaryEffectSlots function is used to create one or more Auxiliary Effect Slots. The number of slots that can be created will be dependant upon the Open AL device used.</summary>
/// <summary>The GenAuxiliaryEffectSlots function is used to create one or more Auxiliary Effect Slots. The number of slots that can be created will be dependant upon the Open AL device used.</summary>
/// <remarks>An application should check the OpenAL error state after making this call to determine if the Effect Slot was successfully created. If the function call fails then none of the requested Effect Slots are created. A good strategy for creating any OpenAL object is to use a for-loop and generate one object each loop iteration and then check for an error condition. If an error is set then the loop can be broken and the application can determine if sufficient resources are available.</remarks>
/// <param name="n">Number of Auxiliary Effect Slots to be created.</param>
/// <param name="slots">Pointer addressing sufficient memory to store n Effect Slot object identifiers.</param>
@ -535,14 +587,14 @@ namespace OpenTK.OpenAL
#region alDeleteAuxiliaryEffectSlots
// typedef void (__cdecl *LPALDELETEAUXILIARYEFFECTSLOTS)( ALsizei n, ALuint* slots );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alDeleteAuxiliaryEffectSlots( int n,[In] uint* slots );
// typedef void (__cdecl *LPALDELETEAUXILIARYEFFECTSLOTS)( ALsizei n, ALuint* slots );
//[CLSCompliant(false)]
private Delegate_alDeleteAuxiliaryEffectSlots Imported_alDeleteAuxiliaryEffectSlots;
/// <summary>The alDeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with alGenAuxiliaryEffectSlots.</summary>
/// <summary>The DeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with GenAuxiliaryEffectSlots.</summary>
/// <param name="n">Number of Auxiliary Effect Slots to be deleted.</param>
/// <param name="slots">Pointer to n Effect Slot object identifiers.</param>
[CLSCompliant(false)]
@ -575,14 +627,14 @@ namespace OpenTK.OpenAL
#region alIsAuxiliaryEffectSlot
// typedef ALboolean (__cdecl *LPALISAUXILIARYEFFECTSLOT)( ALuint slot );
//[CLSCompliant(false)]
private delegate bool Delegate_alIsAuxiliaryEffectSlot( uint slot );
// typedef ALboolean (__cdecl *LPALISAUXILIARYEFFECTSLOT)( ALuint slot );
//[CLSCompliant(false)]
private Delegate_alIsAuxiliaryEffectSlot Imported_alIsAuxiliaryEffectSlot;
/// <summary>The alIsAuxiliaryEffectSlot function is used to determine if an object identifier is a valid Auxiliary Effect Slot object.</summary>
/// <summary>The IsAuxiliaryEffectSlot function is used to determine if an object identifier is a valid Auxiliary Effect Slot object.</summary>
/// <param name="slot">Effect Slot object identifier to validate.</param>
/// <returns>True if the identifier is a valid Auxiliary Effect Slot, False otherwise.</returns>
[CLSCompliant(false)]
@ -595,9 +647,9 @@ namespace OpenTK.OpenAL
#region alAuxiliaryEffectSloti
// typedef void (__cdecl *LPALAUXILIARYEFFECTSLOTI)( ALuint asid, ALenum param, ALint value );
//[CLSCompliant(false)]
private delegate void Delegate_alAuxiliaryEffectSloti( uint asid,Enums.EfxAuxiliaryi param,int value );
// typedef void (__cdecl *LPALAUXILIARYEFFECTSLOTI)( ALuint asid, ALenum param, ALint value );
//[CLSCompliant(false)]
private Delegate_alAuxiliaryEffectSloti Imported_alAuxiliaryEffectSloti;
@ -612,22 +664,13 @@ namespace OpenTK.OpenAL
Imported_alAuxiliaryEffectSloti(asid,param,value);
}
/// <summary>(Helper) Attaches an Effect to an Auxiliary Effect Slot.</summary>
/// <param name="auxiliaryeffectslot">The slot handle to attach the Effect to.</param>
/// <param name="effect">The Effect handle that is being attached.</param>
[CLSCompliant(false)]
public void BindEffectToAuxiliarySlot( uint auxiliaryeffectslot,uint effect )
{
AuxiliaryEffectSlot(auxiliaryeffectslot,Enums.EfxAuxiliaryi.EffectslotEffect,(int) effect);
}
#endregion alAuxiliaryEffectSloti
#region alAuxiliaryEffectSlotf
// typedef void (__cdecl *LPALAUXILIARYEFFECTSLOTF)( ALuint asid, ALenum param, ALfloat value );
//[CLSCompliant(false)]
private delegate void Delegate_alAuxiliaryEffectSlotf( uint asid,Enums.EfxAuxiliaryf param,float value );
// typedef void (__cdecl *LPALAUXILIARYEFFECTSLOTF)( ALuint asid, ALenum param, ALfloat value );
//[CLSCompliant(false)]
private Delegate_alAuxiliaryEffectSlotf Imported_alAuxiliaryEffectSlotf;
@ -646,9 +689,9 @@ namespace OpenTK.OpenAL
#region alGetAuxiliaryEffectSloti
// typedef void (__cdecl *LPALGETAUXILIARYEFFECTSLOTI)( ALuint asid, ALenum pname, ALint* value );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alGetAuxiliaryEffectSloti( uint asid,Enums.EfxAuxiliaryi pname,[Out] int* value );
// typedef void (__cdecl *LPALGETAUXILIARYEFFECTSLOTI)( ALuint asid, ALenum pname, ALint* value );
//[CLSCompliant(false)]
private Delegate_alGetAuxiliaryEffectSloti Imported_alGetAuxiliaryEffectSloti;
@ -673,9 +716,9 @@ namespace OpenTK.OpenAL
#region alGetAuxiliaryEffectSlotf
// typedef void (__cdecl *LPALGETAUXILIARYEFFECTSLOTF)( ALuint asid, ALenum pname, ALfloat* value );
//[CLSCompliant(false)]
unsafe private delegate void Delegate_alGetAuxiliaryEffectSlotf( uint asid,Enums.EfxAuxiliaryf pname,[Out] float* value );
// typedef void (__cdecl *LPALGETAUXILIARYEFFECTSLOTF)( ALuint asid, ALenum pname, ALfloat* value );
//[CLSCompliant(false)]
private Delegate_alGetAuxiliaryEffectSlotf Imported_alGetAuxiliaryEffectSlotf;
@ -720,10 +763,10 @@ namespace OpenTK.OpenAL
if ( Alc.IsExtensionPresent(Alc.GetContextsDevice(Alc.GetCurrentContext( )),"ALC_EXT_EFX") == false )
{
Console.WriteLine("Extension unknown.");
Trace.WriteLine("Efx Extension ALC_EXT_EFX is unknown to the Device.");
return;
}
Console.WriteLine("ALC_EXT_EFX found.");
// Console.WriteLine("ALC_EXT_EFX found. Efx can be used.");
try
{
@ -738,10 +781,10 @@ namespace OpenTK.OpenAL
Imported_alGetEffectfv = (Delegate_alGetEffectfv) Marshal.GetDelegateForFunctionPointer(AL.GetProcAddress("alGetEffectfv"),typeof(Delegate_alGetEffectfv));
} catch ( Exception e )
{
Console.WriteLine("Failed to marshal Effect functions. " + e.ToString( ));
Trace.WriteLine("Failed to marshal Effect functions. " + e.ToString( ));
return;
}
Console.WriteLine("Effect functions appear to be ok.");
// Console.WriteLine("Effect functions appear to be ok.");
try
{
@ -754,10 +797,10 @@ namespace OpenTK.OpenAL
Imported_alGetFilterf = (Delegate_alGetFilterf) Marshal.GetDelegateForFunctionPointer(AL.GetProcAddress("alGetFilterf"),typeof(Delegate_alGetFilterf));
} catch ( Exception e )
{
Console.WriteLine("Failed to marshal Filter functions. " + e.ToString( ));
Trace.WriteLine("Failed to marshal Filter functions. " + e.ToString( ));
return;
}
Console.WriteLine("Filter functions appear to be ok.");
// Console.WriteLine("Filter functions appear to be ok.");
try
{
@ -770,10 +813,10 @@ namespace OpenTK.OpenAL
Imported_alGetAuxiliaryEffectSlotf = (Delegate_alGetAuxiliaryEffectSlotf) Marshal.GetDelegateForFunctionPointer(AL.GetProcAddress("alGetAuxiliaryEffectSlotf"),typeof(Delegate_alGetAuxiliaryEffectSlotf));
} catch ( Exception e )
{
Console.WriteLine("Failed to marshal AuxiliaryEffectSlot functions. " + e.ToString( ));
Trace.WriteLine("Failed to marshal AuxiliaryEffectSlot functions. " + e.ToString( ));
return;
}
Console.WriteLine("Auxiliary Effect Slot functions appear to be ok.");
// Console.WriteLine("Auxiliary Effect Slot functions appear to be ok.");
// didn't return so far, everything went fine.
_valid = true;

332
Source/OpenTK/OpenAL/EfxTokens.cs
View file

@ -11,232 +11,213 @@ using System;
namespace OpenTK.OpenAL.Enums
{
// Constants, might be removed if inline docu is sufficiently describing it
// AL chorus effect parameter ranges and defaults
// AL_CHORUS_WAVEFORM_SINUSOID 0
// AL_CHORUS_WAVEFORM_TRIANGLE 1
// AL flanger effect parameter ranges and defaults
// AL_FLANGER_WAVEFORM_SINUSOID 0
// AL_FLANGER_WAVEFORM_TRIANGLE 1
// AL ring modulator effect parameter ranges and defaults
// AL_RING_MODULATOR_SINUSOID 0
// AL_RING_MODULATOR_SAWTOOTH 1
// AL_RING_MODULATOR_SQUARE 2
// AL vocal morpher effect parameter ranges and defaults
// AL_VOCAL_MORPHER_WAVEFORM_SINUSOID 0
// AL_VOCAL_MORPHER_WAVEFORM_TRIANGLE 1
// AL_VOCAL_MORPHER_WAVEFORM_SAWTOOTH 2
// AL frequency shifter effect parameter ranges and defaults
// AL_FREQUENCY_SHIFTER_DIRECTION_DOWN 0
// AL_FREQUENCY_SHIFTER_DIRECTION_UP 1
// AL_FREQUENCY_SHIFTER_DIRECTION_OFF 2
#region Effect
///<summary>A list of valid 32-Bits Float Effect/GetEffect parameters</summary>
public enum EfxEffectf : int
{
///<summary>Reverb Parameter. Range [0.0f .. 1.0f] Default: 0.1f</summary>
///<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>
ReverbDensity = 0x0001,
///<summary>Reverb Parameter. Range [0.0f .. 1.0f] Default: 0.1f</summary>
///<summary>The Reverb Diffusion property controls the echo density in the reverberation decay. The default 1.0f provides the highest density. Reducing diffusion gives the reverberation a more "grainy" character that is especially noticeable with percussive sound sources. If you set a diffusion value of 0.0f, the later reverberation sounds like a succession of distinct echoes. Range [0.0f .. 1.0f] Default: 1.0f</summary>
ReverbDiffusion = 0x0002,
///<summary>Reverb Parameter. Range [0.0f .. 1.0f] Default: 0.32f</summary>
///<summary>The Reverb Gain property is the master volume control for the reflected sound - both early reflections and reverberation - that the reverb effect adds to all sound sources. Ranges from 1.0 (0db) (the maximum amount) to 0.0 (-100db) (no reflected sound at all) are accepted. Units: Linear gain Range [0.0f .. 1.0f] Default: 0.32f</summary>
ReverbGain = 0x0003,
///<summary>Reverb Parameter. Range [0.0f .. 1.0f] Default: 0.89f</summary>
///<summary>The Reverb Gain HF property further tweaks reflected sound by attenuating it at high frequencies. It controls a low-pass filter that applies globally to the reflected sound of all sound sources feeding the particular instance of the reverb effect. Ranges from 1.0f (0db) (no filter) to 0.0f (-100db) (virtually no reflected sound) are accepted. Units: Linear gain Range [0.0f .. 1.0f] Default: 0.89f</summary>
ReverbGainHF = 0x0004,
///<summary>Reverb Parameter. Unit: Seconds Range [0.1f .. 20.0f] Default: 1.49f</summary>
///<summary>The Decay Time property sets the reverberation decay time. It ranges from 0.1f (typically a small room with very dead surfaces) to 20.0 (typically a large room with very live surfaces). Unit: Seconds Range [0.1f .. 20.0f] Default: 1.49f</summary>
ReverbDecayTime = 0x0005,
///<summary>Reverb Parameter. Range [0.1f .. 2.0f] Default: 0.83f</summary>
///<summary>The Decay HF Ratio property sets the spectral quality of the Decay Time parameter. It is the ratio of high-frequency decay time relative to the time set by Decay Time.. Unit: linear multiplier Range [0.1f .. 2.0f] Default: 0.83f</summary>
ReverbDecayHFRatio = 0x0006,
///<summary>Reverb Parameter. Range [0.0f .. 3.16f] Default: 0.05f</summary>
///<summary>The Reflections Gain property controls the overall amount of initial reflections relative to the Gain property. The value of Reflections Gain ranges from a maximum of 3.16f (+10 dB) to a minimum of 0.0f (-100 dB) (no initial reflections at all), and is corrected by the value of the Gain property. Unit: Linear gain Range [0.0f .. 3.16f] Default: 0.05f</summary>
ReverbReflectionsGain = 0x0007,
///<summary>Reverb Parameter. Unit: Seconds Range [0.0f .. 0.3f] Default: 0.007f</summary>
///<summary>The Reflections Delay property is the amount of delay between the arrival time of the direct path from the source to the first reflection from the source. It ranges from 0 to 300 milliseconds. Unit: Seconds Range [0.0f .. 0.3f] Default: 0.007f</summary>
ReverbReflectionsDelay = 0x0008,
///<summary>Reverb Parameter. Range [0.0f .. 10.0f] Default: 1.26f</summary>
///<summary>The Late Reverb Gain property controls the overall amount of later reverberation relative to the Gain property. The value of Late Reverb Gain ranges from a maximum of 10.0f (+20 dB) to a minimum of 0.0f (-100 dB) (no late reverberation at all). Unit: Linear gain Range [0.0f .. 10.0f] Default: 1.26f</summary>
ReverbLateReverbGain = 0x0009,
///<summary>Reverb Parameter. Unit: Seconds Range [0.0f .. 0.1f] Default: 0.011f</summary>
///<summary>The Late Reverb Delay property defines the begin time of the late reverberation relative to the time of the initial reflection (the first of the early reflections). It ranges from 0 to 100 milliseconds. Unit: Seconds Range [0.0f .. 0.1f] Default: 0.011f</summary>
ReverbLateReverbDelay = 0x000A,
///<summary>Reverb Parameter. Range [0.892f .. 1.0f] Default: 0.994f</summary>
///<summary>The Air Absorption Gain HF property controls the distance-dependent attenuation at high frequencies caused by the propagation medium and applies to reflected sound only. Unit: Linear gain per meter Range [0.892f .. 1.0f] Default: 0.994f</summary>
ReverbAirAbsorptionGainHF = 0x000B,
///<summary>Reverb Parameter. Range [0.0f .. 10.0f] Default: 0.0f</summary>
///<summary>The Room Rolloff Factor property is one of two methods available to attenuate the reflected sound (containing both reflections and reverberation) according to source-listener distance. It's defined the same way as OpenAL's Rolloff Factor, but operates on reverb sound instead of direct-path sound. Unit: Linear multiplier Range [0.0f .. 10.0f] Default: 0.0f</summary>
ReverbRoomRolloffFactor = 0x000C,
///<summary>Chorus Parameter. Unit: Hz Range [0.0f .. 10.0f] Default: 1.1f</summary>
///<summary>This property sets the modulation rate of the low-frequency oscillator that controls the delay time of the delayed signals. Unit: Hz Range [0.0f .. 10.0f] Default: 1.1f</summary>
ChorusRate = 0x0003,
///<summary>Chorus Parameter. Range [0.0f .. 1.0f] Default: 0.1f</summary>
///<summary>This property controls the amount by which the delay time is modulated by the low-frequency oscillator. Range [0.0f .. 1.0f] Default: 0.1f</summary>
ChorusDepth = 0x0004,
///<summary>Chorus Parameter. Range [-1.0f .. +1.0f] Default: +0.25f</summary>
///<summary>This property controls the amount of processed signal that is fed back to the input of the chorus effect. Negative values will reverse the phase of the feedback signal. At full magnitude the identical sample will repeat endlessly. Range [-1.0f .. +1.0f] Default: +0.25f</summary>
ChorusFeedback = 0x0005,
///<summary>Chorus Parameter. Unit: Seconds Range [0.0f .. 0.016f] Default: 0.016f</summary>
///<summary>This property controls the average amount of time the sample is delayed before it is played back, and with feedback, the amount of time between iterations of the sample. Larger values lower the pitch. Unit: Seconds Range [0.0f .. 0.016f] Default: 0.016f</summary>
ChorusDelay = 0x0006,
///<summary>Distortion Parameter. Range [0.0f .. 1.0f] Default: 0.2f</summary>
///<summary>This property controls the shape of the distortion. The higher the value for Edge, the "dirtier" and "fuzzier" the effect. Range [0.0f .. 1.0f] Default: 0.2f</summary>
DistortionEdge = 0x0001,
///<summary>Distortion Parameter. Range [0.01f .. 1.0f] Default: 0.05f</summary>
///<summary>This property allows you to attenuate the distorted sound. Range [0.01f .. 1.0f] Default: 0.05f</summary>
DistortionGain = 0x0002,
///<summary>Distortion Parameter. Unit: Hz Range [80.0f .. 24000.0f] Default: 8000.0f</summary>
///<summary>Input signals can have a low pass filter applied, to limit the amount of high frequency signal feeding into the distortion effect. Unit: Hz Range [80.0f .. 24000.0f] Default: 8000.0f</summary>
DistortionLowpassCutoff = 0x0003,
///<summary>Distortion Parameter. Unit: Hz Range [80.0f .. 24000.0f] Default: 3600.0f</summary>
///<summary>This property controls the frequency at which the post-distortion attenuation (Distortion Gain) is active. Unit: Hz Range [80.0f .. 24000.0f] Default: 3600.0f</summary>
DistortionEQCenter = 0x0004,
///<summary>Distortion Parameter. Unit: Hz Range [80.0f .. 24000.0f] Default: 3600.0f</summary>
///<summary>This property controls the bandwidth of the post-distortion attenuation. Unit: Hz Range [80.0f .. 24000.0f] Default: 3600.0f</summary>
DistortionEQBandwidth = 0x0005,
///<summary>Echo Parameter. Unit: Seconds Range [0.0f .. 0.207f] Default: 0.1f</summary>
///<summary>This property controls the delay between the original sound and the first "tap", or echo instance. Subsequently, the value for Echo Delay is used to determine the time delay between each "second tap" and the next "first tap". Unit: Seconds Range [0.0f .. 0.207f] Default: 0.1f</summary>
EchoDelay = 0x0001,
///<summary>Echo Parameter. Unit: Seconds Range [0.0f .. 0.404f] Default: 0.1f</summary>
///<summary>This property controls the delay between the "first tap" and the "second tap". Subsequently, the value for Echo LR Delay is used to determine the time delay between each "first tap" and the next "second tap". Unit: Seconds Range [0.0f .. 0.404f] Default: 0.1f</summary>
EchoLRDelay = 0x0002,
///<summary>Echo Parameter. Range [0.0f .. 0.99f] Default: 0.5f</summary>
///<summary>This property controls the amount of high frequency damping applied to each echo. As the sound is subsequently fed back for further echoes, damping results in an echo which progressively gets softer in tone as well as intensity. Range [0.0f .. 0.99f] Default: 0.5f</summary>
EchoDamping = 0x0003,
///<summary>Echo Parameter. Range [0.0f .. 1.0f] Default: 0.5f</summary>
///<summary>This property controls the amount of feedback the output signal fed back into the input. Use this parameter to create "cascading" echoes. At full magnitude, the identical sample will repeat endlessly. Below full magnitude, the sample will repeat and fade. Range [0.0f .. 1.0f] Default: 0.5f</summary>
EchoFeedback = 0x0004,
///<summary>Echo Parameter. Range [-1.0f .. +1.0f] Default: -1.0f</summary>
///<summary>This property controls how hard panned the individual echoes are. With a value of 1.0f, the first "tap" will be panned hard left, and the second "tap" hard right. –1.0f gives the opposite result and values near to 0.0f result in less emphasized panning. Range [-1.0f .. +1.0f] Default: -1.0f</summary>
EchoSpread = 0x0005,
///<summary>Flanger Parameter. Range [0.0f .. 10.0f] Default: 0.27f</summary>
///<summary>The number of times per second the low-frequency oscillator controlling the amount of delay repeats. Range [0.0f .. 10.0f] Default: 0.27f</summary>
FlangerRate = 0x0003,
///<summary>Flanger Parameter. Range [0.0f .. 1.0f] Default: 1.0f</summary>
///<summary>The ratio by which the delay time is modulated by the low-frequency oscillator. Range [0.0f .. 1.0f] Default: 1.0f</summary>
FlangerDepth = 0x0004,
///<summary>Flanger Parameter. Range [-1.0f .. +1.0f] Default: -0.5f</summary>
///<summary>This is the amount of the output signal level fed back into the effect's input. A negative value will reverse the phase of the feedback signal. Range [-1.0f .. +1.0f] Default: -0.5f</summary>
FlangerFeedback = 0x0005,
///<summary>Flanger Parameter. Unit: Seconds Range [0.0f .. 0.004f] Default: 0.002f</summary>
///<summary>The average amount of time the sample is delayed before it is played back. When used with the Feedback property it's the amount of time between iterations of the sample. Unit: Seconds Range [0.0f .. 0.004f] Default: 0.002f</summary>
FlangerDelay = 0x0006,
///<summary>Frequencyshifter Parameter. Unit: Hz Range [0.0f .. 24000.0f] Default: 0.0f</summary>
///<summary>This is the carrier frequency. For carrier frequencies below the audible range, the single sideband modulator may produce phaser effects, spatial effects or a slight pitch-shift. As the carrier frequency increases, the timbre of the sound is affected. Unit: Hz Range [0.0f .. 24000.0f] Default: 0.0f</summary>
FrequencyShifterFrequency = 0x0001,
///<summary>Vocalmorpher Parameter. Unit: Hz Range [0.0f .. 10.0f] Default: 1.41f</summary>
///<summary>This controls the frequency of the low-frequency oscillator used to morph between the two phoneme filters. Unit: Hz Range [0.0f .. 10.0f] Default: 1.41f</summary>
VocalMorpherRate = 0x0006,
///<summary>Ringmodulator Parameter. Unit: Hz Range [0.0f .. 8000.0f] Default: 440.0f</summary>
///<summary>This is the frequency of the carrier signal. If the carrier signal is slowly varying (less than 20 Hz), the result is a slow amplitude variation effect (tremolo). Unit: Hz Range [0.0f .. 8000.0f] Default: 440.0f</summary>
RingModulatorFrequency = 0x0001,
///<summary>Ringmodulator Parameter. Unit: Hz Range [0.0f .. 24000.0f] Default: 800.0f</summary>
///<summary>This controls the cutoff frequency at which the input signal is high-pass filtered before being ring modulated. Unit: Hz Range [0.0f .. 24000.0f] Default: 800.0f</summary>
RingModulatorHighpassCutoff = 0x0002,
///<summary>Autowah Parameter. Unit: Seconds Range [0.0001f .. 1.0f] Default: 0.06f</summary>
///<summary>This property controls the time the filtering effect takes to sweep from minimum to maximum center frequency when it is triggered by input signal. Unit: Seconds Range [0.0001f .. 1.0f] Default: 0.06f</summary>
AutowahAttackTime = 0x0001,
///<summary>Autowah Parameter. Unit: Seconds Range [0.0001f .. 1.0f] Default: 0.06f</summary>
///<summary>This property controls the time the filtering effect takes to sweep from maximum back to base center frequency, when the input signal ends. Unit: Seconds Range [0.0001f .. 1.0f] Default: 0.06f</summary>
AutowahReleaseTime = 0x0002,
///<summary>Autowah Parameter. Range [2.0f .. 1000.0f] Default: 1000.0f</summary>
///<summary>This property controls the resonant peak, sometimes known as emphasis or Q, of the auto-wah band-pass filter. Range [2.0f .. 1000.0f] Default: 1000.0f</summary>
AutowahResonance = 0x0003,
///<summary>Autowah Parameter. Range [0.00003f .. 31621.0f] Default: 11.22f</summary>
///<summary>This property controls the input signal level at which the band-pass filter will be fully opened. Range [0.00003f .. 31621.0f] Default: 11.22f</summary>
AutowahPeakGain = 0x0004,
///<summary>Equalizer Parameter. Range [0.126f .. 7.943f] Default: 1.0f</summary>
///<summary>This property controls amount of cut or boost on the low frequency range. Range [0.126f .. 7.943f] Default: 1.0f</summary>
EqualizerLowGain = 0x0001,
///<summary>Equalizer Parameter. Unit: Hz Range [50.0f .. 800.0f] Default: 200.0f</summary>
///<summary>This property controls the low frequency below which signal will be cut off. Unit: Hz Range [50.0f .. 800.0f] Default: 200.0f</summary>
EqualizerLowCutoff = 0x0002,
///<summary>Equalizer Parameter. Range [0.126f .. 7.943f] Default: 1.0f</summary>
///<summary>This property allows you to cut/boost signal on the "mid1" range. Range [0.126f .. 7.943f] Default: 1.0f</summary>
EqualizerMid1Gain = 0x0003,
///<summary>Equalizer Parameter. Unit: Hz Range [200.0f .. 3000.0f] Default: 500.0f</summary>
///<summary>This property sets the center frequency for the "mid1" range. Unit: Hz Range [200.0f .. 3000.0f] Default: 500.0f</summary>
EqualizerMid1Center = 0x0004,
///<summary>Equalizer Parameter. Range [0.01f .. 1.0f] Default: 1.0f</summary>
///<summary>This property controls the width of the "mid1" range. Range [0.01f .. 1.0f] Default: 1.0f</summary>
EqualizerMid1Width = 0x0005,
///<summary>Equalizer Parameter. Range [0.126f .. 7.943f] Default: 1.0f</summary>
///<summary>This property allows you to cut/boost signal on the "mid2" range. Range [0.126f .. 7.943f] Default: 1.0f</summary>
EqualizerMid2Gain = 0x0006,
///<summary>Equalizer Parameter. Unit: Hz Range [1000.0f .. 8000.0f] Default: 3000.0f</summary>
///<summary>This property sets the center frequency for the "mid2" range. Unit: Hz Range [1000.0f .. 8000.0f] Default: 3000.0f</summary>
EqualizerMid2Center = 0x0007,
///<summary>Equalizer Parameter. Range [0.01f .. 1.0f] Default: 1.0f</summary>
///<summary>This property controls the width of the "mid2" range. Range [0.01f .. 1.0f] Default: 1.0f</summary>
EqualizerMid2Width = 0x0008,
///<summary>Equalizer Parameter. Range [0.126f .. 7.943f] Default: 1.0f</summary>
///<summary>This property allows to cut/boost the signal at high frequencies. Range [0.126f .. 7.943f] Default: 1.0f</summary>
EqualizerHighGain = 0x0009,
///<summary>Equalizer Parameter. Unit: Hz Range [4000.0f .. 16000.0f] Default: 6000.0f</summary>
///<summary>This property controls the high frequency above which signal will be cut off. Unit: Hz Range [4000.0f .. 16000.0f] Default: 6000.0f</summary>
EqualizerHighCutoff = 0x000A,
///<summary>EAXReverb effect parameters. Range [0.0f .. 1.0f] Default: 1.0f</summary>
///<summary>Reverb Modal Density controls the coloration of the late reverb. Range [0.0f .. 1.0f] Default: 1.0f</summary>
EaxReverbDensity = 0x0001,
///<summary>EAXReverb effect parameters. Range [0.0f .. 1.0f] Default: 1.0f</summary>
///<summary>The Reverb Diffusion property controls the echo density in the reverberation decay. Range [0.0f .. 1.0f] Default: 1.0f</summary>
EaxReverbDiffusion = 0x0002,
///<summary>EAXReverb effect parameters. Range [0.0f .. 1.0f] Default: 0.32f</summary>
///<summary>Reverb Gain controls the level of the reverberant sound in an environment. A high level of reverb is characteristic of rooms with highly reflective walls and/or small dimensions. Unit: Linear gain Range [0.0f .. 1.0f] Default: 0.32f</summary>
EaxReverbGain = 0x0003,
///<summary>EAXReverb effect parameters. Range [0.0f .. 1.0f] Default: 0.89f</summary>
///<summary>Gain HF is used to attenuate the high frequency content of all the reflected sound in an environment. You can use this property to give a room specific spectral characteristic. Unit: Linear gain Range [0.0f .. 1.0f] Default: 0.89f</summary>
EaxReverbGainHF = 0x0004,
///<summary>EAXReverb effect parameters. Range [0.0f .. 1.0f] Default: 1.0f</summary>
///<summary>Gain LF is the low frequency counterpart to Gain HF. Use this to reduce or boost the low frequency content in an environment. Unit: Linear gain Range [0.0f .. 1.0f] Default: 1.0f</summary>
EaxReverbGainLF = 0x0005,
///<summary>EAXReverb effect parameters. Unit: Seconds Range [0.1f .. 20.0f] Default: 1.49f</summary>
///<summary>The Decay Time property sets the reverberation decay time. It ranges from 0.1f (typically a small room with very dead surfaces) to 20.0f (typically a large room with very live surfaces). Unit: Seconds Range [0.1f .. 20.0f] Default: 1.49f</summary>
EaxReverbDecayTime = 0x0006,
///<summary>EAXReverb effect parameters. Range [0.1f .. 2.0f] Default: 0.83f</summary>
///<summary>Decay HF Ratio scales the decay time of high frequencies relative to the value of the Decay Time property. By changing this value, you are changing the amount of time it takes for the high frequencies to decay compared to the mid frequencies of the reverb. Range [0.1f .. 2.0f] Default: 0.83f</summary>
EaxReverbDecayHFRatio = 0x0007,
///<summary>EAXReverb effect parameters. Range [0.1f .. 2.0f] Default: 1.0f</summary>
///<summary>Decay LF Ratio scales the decay time of low frequencies in the reverberation in the same manner that Decay HF Ratio handles high frequencies. Unit: Linear multiplier Range [0.1f .. 2.0f] Default: 1.0f</summary>
EaxReverbDecayLFRatio = 0x0008,
///<summary>EAXReverb effect parameters. Range [0.0f .. 3.16f] Default: 0.05f</summary>
///<summary>Reflections Gain sets the level of the early reflections in an environment. Early reflections are used as a cue for determining the size of the environment we are in. Unit: Linear gain Range [0.0f .. 3.16f] Default: 0.05f</summary>
EaxReverbReflectionsGain = 0x0009,
///<summary>EAXReverb effect parameters. Unit: Seconds Range [0.0f .. 0.3f] Default: 0.007f</summary>
///<summary>Reflections Delay controls the amount of time it takes for the first reflected wave front to reach the listener, relative to the arrival of the direct-path sound. Unit: Seconds Range [0.0f .. 0.3f] Default: 0.007f</summary>
EaxReverbReflectionsDelay = 0x000A,
///<summary>EAXReverb effect parameters. Range [0.0f .. 10.0f] Default: 1.26f</summary>
///<summary>The Late Reverb Gain property controls the overall amount of later reverberation relative to the Gain property. Range [0.0f .. 10.0f] Default: 1.26f</summary>
EaxReverbLateReverbGain = 0x000C,
///<summary>EAXReverb effect parameters. Unit: Seconds Range [0.0f .. 0.1f] Default: 0.011f</summary>
///<summary>The Late Reverb Delay property defines the begin time of the late reverberation relative to the time of the initial reflection (the first of the early reflections). It ranges from 0 to 100 milliseconds. Unit: Seconds Range [0.0f .. 0.1f] Default: 0.011f</summary>
EaxReverbLateReverbDelay = 0x000D,
///<summary>EAXReverb effect parameters. Range [0.075f .. 0.25f] Default: 0.25f</summary>
///<summary>Echo Time controls the rate at which the cyclic echo repeats itself along the reverberation decay. Range [0.075f .. 0.25f] Default: 0.25f</summary>
EaxReverbEchoTime = 0x000F,
///<summary>EAXReverb effect parameters. Range [0.0f .. 1.0f] Default: 0.0f</summary>
///<summary>Echo Depth introduces a cyclic echo in the reverberation decay, which will be noticeable with transient or percussive sounds. Range [0.0f .. 1.0f] Default: 0.0f</summary>
EaxReverbEchoDepth = 0x0010,
///<summary>EAXReverb effect parameters. Range [0.04f .. 4.0f] Default: 0.25f</summary>
///<summary>Modulation Time controls the speed of the rate of periodic changes in pitch (vibrato). Range [0.04f .. 4.0f] Default: 0.25f</summary>
EaxReverbModulationTime = 0x0011,
///<summary>EAXReverb effect parameters. Range [0.0f .. 1.0f] Default: 0.0f</summary>
///<summary>Modulation Depth controls the amount of pitch change. Low values of Diffusion will contribute to reinforcing the perceived effect by reducing the mixing of overlapping reflections in the reverberation decay. Range [0.0f .. 1.0f] Default: 0.0f</summary>
EaxReverbModulationDepth = 0x0012,
///<summary>EAXReverb effect parameters. Range [0.892f .. 1.0f] Default: 0.994f</summary>
///<summary>The Air Absorption Gain HF property controls the distance-dependent attenuation at high frequencies caused by the propagation medium. It applies to reflected sound only. Range [0.892f .. 1.0f] Default: 0.994f</summary>
EaxReverbAirAbsorptionGainHF = 0x0013,
///<summary>EAXReverb effect parameters. Unit: Hz Range [1000.0f .. 20000.0f] Default: 5000.0f</summary>
///<summary>The property HF reference determines the frequency at which the high-frequency effects created by Reverb properties are measured. Unit: Hz Range [1000.0f .. 20000.0f] Default: 5000.0f</summary>
EaxReverbHFReference = 0x0014,
///<summary>EAXReverb effect parameters. Unit: Hz Range [20.0f .. 1000.0f] Default: 250.0f</summary>
///<summary>The property LF reference determines the frequency at which the low-frequency effects created by Reverb properties are measured. Unit: Hz Range [20.0f .. 1000.0f] Default: 250.0f</summary>
EaxReverbLFReference = 0x0015,
///<summary>EAXReverb effect parameters. Range [0.0f .. 10.0f] Default: 0.0f</summary>
///<summary>The Room Rolloff Factor property is one of two methods available to attenuate the reflected sound (containing both reflections and reverberation) according to source-listener distance. It's defined the same way as OpenAL Rolloff Factor, but operates on reverb sound instead of direct-path sound. Range [0.0f .. 10.0f] Default: 0.0f</summary>
EaxReverbRoomRolloffFactor = 0x0016,
}
///<summary>A list of valid Math.Vector3 Effect/GetEffect parameters</summary>
public enum EfxEffect3f : int
{
/// <summary>EAXReverb effect parameters. Unit: Vector3 Default: {0.0f, 0.0f, 0.0f}</summary>
/// <summary>Reverb Pan does for the Reverb what Reflections Pan does for the Reflections. Unit: Vector3 of length 0f to 1f Default: {0.0f, 0.0f, 0.0f}</summary>
EaxReverbLateReverbPan = 0x000E,
/// <summary>EAXReverb effect parameters. Unit: Vector3 Default: {0.0f, 0.0f, 0.0f}</summary>
/// <summary>This Vector3 controls the spatial distribution of the cluster of early reflections. The direction of this vector controls the global direction of the reflections, while its magnitude controls how focused the reflections are towards this direction. For legacy reasons this Vector3 follows a left-handed co-ordinate system! Note that OpenAL uses a right-handed coordinate system. Unit: Vector3 of length 0f to 1f Default: {0.0f, 0.0f, 0.0f}</summary>
EaxReverbReflectionsPan = 0x000B,
}
///<summary>A list of valid Int32 Effect/GetEffect parameters</summary>
public enum EfxEffecti : int
{
///<summary>Chorus Parameter. Unit: (0) Sinusoid, (1) Triangle [0 .. 1] Default: 1</summary>
///<summary>This property sets the waveform shape of the low-frequency oscillator that controls the delay time of the delayed signals. Unit: (0) Sinusoid, (1) Triangle Range [0 .. 1] Default: 1</summary>
ChorusWaveform = 0x0001,
///<summary>Chorus Parameter. Unit: Degrees Range [-180 .. 180] Default: 90</summary>
///<summary>This property controls the phase difference between the left and right low-frequency oscillators. At zero degrees the two low-frequency oscillators are synchronized. Unit: Degrees Range [-180 .. 180] Default: 90</summary>
ChorusPhase = 0x0002,
///<summary>Flanger Parameter. Unit: (0) Sinusoid, (1) Triangle Range [0 .. 1] Default: 1</summary>
///<summary>Selects the shape of the low-frequency oscillator waveform that controls the amount of the delay of the sampled signal. Unit: (0) Sinusoid, (1) Triangle Range [0 .. 1] Default: 1</summary>
FlangerWaveform = 0x0001,
///<summary>Flanger Parameter. Range [-180 .. +180] Default: 0</summary>
///<summary>This changes the phase difference between the left and right low-frequency oscillator's. At zero degrees the two low-frequency oscillators are synchronized. Range [-180 .. +180] Default: 0</summary>
FlangerPhase = 0x0002,
///<summary>Frequencyshifter Parameter. Unit: (0) Down, (1) Up, (2) Off Range [0 .. 2] Default: 0</summary>
///<summary>These select which internal signals are added together to produce the output. Unit: (0) Down, (1) Up, (2) Off Range [0 .. 2] Default: 0</summary>
FrequencyShifterLeftDirection = 0x0002,
///<summary>Frequencyshifter Parameter. Unit: (0) Down, (1) Up, (2) Off Range [0 .. 2] Default: 0</summary>
///<summary>These select which internal signals are added together to produce the output. Unit: (0) Down, (1) Up, (2) Off Range [0 .. 2] Default: 0</summary>
FrequencyShifterRightDirection = 0x0003,
///<summary>Vocalmorpher Parameter. Unit: Use enum EfxFormantFilterSettings Range [0 .. 29] Default: 0, AL_VOCAL_MORPHER_PHONEME_A</summary>
///<summary>Sets the vocal morpher 4-band formant filter A, used to impose vocal tract effects upon the input signal. The vocal morpher is not necessarily intended for use on voice signals; it is primarily intended for pitched noise effects, vocal-like wind effects, etc. Unit: Use enum EfxFormantFilterSettings Range [0 .. 29] Default: 0, "Phoneme A"</summary>
VocalMorpherPhonemeA = 0x0001,
///<summary>Vocalmorpher Parameter. Unit: Semitones Range [-24 .. +24] Default: 0</summary>
///<summary>This is used to adjust the pitch of phoneme filter A in 1-semitone increments. Unit: Semitones Range [-24 .. +24] Default: 0</summary>
VocalMorpherPhonemeACoarseTuning = 0x0002,
///<summary>Vocalmorpher Parameter. Unit: Use enum EfxFormantFilterSettings Range [0 .. 29] Default: 10, AL_VOCAL_MORPHER_PHONEME_ER</summary>
///<summary>Sets the vocal morpher 4-band formant filter B, used to impose vocal tract effects upon the input signal. The vocal morpher is not necessarily intended for use on voice signals; it is primarily intended for pitched noise effects, vocal-like wind effects, etc. Unit: Use enum EfxFormantFilterSettings Range [0 .. 29] Default: 10, "Phoneme ER"</summary>
VocalMorpherPhonemeB = 0x0003,
///<summary>Vocalmorpher Parameter. Unit: Semitones Range [-24 .. +24] Default: 0</summary>
///<summary>This is used to adjust the pitch of phoneme filter B in 1-semitone increments. Unit: Semitones Range [-24 .. +24] Default: 0</summary>
VocalMorpherPhonemeBCoarseTuning = 0x0004,
///<summary>Vocalmorpher Parameter. Unit: (0) Sinusoid, (1) Triangle, (2) Sawtooth Range [0 .. 2] Default: 0</summary>
///<summary>This controls the shape of the low-frequency oscillator used to morph between the two phoneme filters. Unit: (0) Sinusoid, (1) Triangle, (2) Sawtooth Range [0 .. 2] Default: 0</summary>
VocalMorpherWaveform = 0x0005,
///<summary>Pitchshifter Parameter. Unit: Semitones Range [-12 .. +12] Default: +12</summary>
///<summary>This sets the number of semitones by which the pitch is shifted. There are 12 semitones per octave. Unit: Semitones Range [-12 .. +12] Default: +12</summary>
PitchShifterCoarseTune = 0x0001,
///<summary>Pitchshifter Parameter. Unit: Cents Range [-50 .. +50] Default: 0</summary>
///<summary>This sets the number of cents between Semitones a pitch is shifted. A Cent is 1/100th of a Semitone. Unit: Cents Range [-50 .. +50] Default: 0</summary>
PitchShifterFineTune = 0x0002,
///<summary>Ringmodulator Parameter. Unit: (0) Sinusoid, (1) Sawtooth, (2) Square Range [0 .. 2] Default: 0</summary>
///<summary>This controls which waveform is used as the carrier signal. Traditional ring modulator and tremolo effects generally use a sinusoidal carrier. Unit: (0) Sinusoid, (1) Sawtooth, (2) Square Range [0 .. 2] Default: 0</summary>
RingModulatorWaveform = 0x0003,
///<summary>Compressor Parameter. Unit: (0) Off, (1) On Range [0 .. 1] Default: 1</summary>
///<summary>Enabling this will result in audio exhibiting smaller variation in intensity between the loudest and quietest portions. Unit: (0) Off, (1) On Range [0 .. 1] Default: 1</summary>
CompressorOnoff = 0x0001,
///<summary>Reverb Parameter. Unit: (0) False, (1) True Range [AL_FALSE .. AL_TRUE] Default: AL_TRUE</summary>
///<summary>When this flag is set, the high-frequency decay time automatically stays below a limit value that's derived from the setting of the property Air Absorption HF. Unit: (0) False, (1) True Range [False, True] Default: True</summary>
ReverbDecayHFLimit = 0x000D,
///<summary>EAXReverb effect parameters. Unit: (0) False, (1) True Range [AL_FALSE .. AL_TRUE] Default: AL_TRUE</summary>
///<summary>When this flag is set, the high-frequency decay time automatically stays below a limit value that's derived from the setting of the property AirAbsorptionGainHF. Unit: (0) False, (1) True Range [False, True] Default: True</summary>
EaxReverbDecayHFLimit = 0x0017,
AL_EFFECT_FIRST_PARAMETER = 0x0000,// deprecated?
@ -246,74 +227,89 @@ namespace OpenTK.OpenAL.Enums
EffectType = 0x8001,
}
///<summary>Vocal morpher effect parameters.</summary>
///<summary>Vocal morpher effect parameters. If both parameters are set to the same phoneme, that determines the filtering effect that will be heard. If these two parameters are set to different phonemes, the filtering effect will morph between the two settings at a rate specified by EfxEffectf.VocalMorpherRate.</summary>
public enum EfxFormantFilterSettings : int
{
AL_VOCAL_MORPHER_PHONEME_A = 0,
AL_VOCAL_MORPHER_PHONEME_E = 1,
AL_VOCAL_MORPHER_PHONEME_I = 2,
AL_VOCAL_MORPHER_PHONEME_O = 3,
AL_VOCAL_MORPHER_PHONEME_U = 4,
AL_VOCAL_MORPHER_PHONEME_AA = 5,
AL_VOCAL_MORPHER_PHONEME_AE = 6,
AL_VOCAL_MORPHER_PHONEME_AH = 7,
AL_VOCAL_MORPHER_PHONEME_AO = 8,
AL_VOCAL_MORPHER_PHONEME_EH = 9,
AL_VOCAL_MORPHER_PHONEME_ER = 10,
AL_VOCAL_MORPHER_PHONEME_IH = 11,
AL_VOCAL_MORPHER_PHONEME_IY = 12,
AL_VOCAL_MORPHER_PHONEME_UH = 13,
AL_VOCAL_MORPHER_PHONEME_UW = 14,
AL_VOCAL_MORPHER_PHONEME_B = 15,
AL_VOCAL_MORPHER_PHONEME_D = 16,
AL_VOCAL_MORPHER_PHONEME_F = 17,
AL_VOCAL_MORPHER_PHONEME_G = 18,
AL_VOCAL_MORPHER_PHONEME_J = 19,
AL_VOCAL_MORPHER_PHONEME_K = 20,
AL_VOCAL_MORPHER_PHONEME_L = 21,
AL_VOCAL_MORPHER_PHONEME_M = 22,
AL_VOCAL_MORPHER_PHONEME_N = 23,
AL_VOCAL_MORPHER_PHONEME_P = 24,
AL_VOCAL_MORPHER_PHONEME_R = 25,
AL_VOCAL_MORPHER_PHONEME_S = 26,
AL_VOCAL_MORPHER_PHONEME_T = 27,
AL_VOCAL_MORPHER_PHONEME_V = 28,
AL_VOCAL_MORPHER_PHONEME_Z = 29,
VocalMorpherPhonemeA = 0,
VocalMorpherPhonemeE = 1,
VocalMorpherPhonemeI = 2,
VocalMorpherPhonemeO = 3,
VocalMorpherPhonemeU = 4,
VocalMorpherPhonemeAA = 5,
VocalMorpherPhonemeAE = 6,
VocalMorpherPhonemeAH = 7,
VocalMorpherPhonemeAO = 8,
VocalMorpherPhonemeEH = 9,
VocalMorpherPhonemeER = 10,
VocalMorpherPhonemeIH = 11,
VocalMorpherPhonemeIY = 12,
VocalMorpherPhonemeUH = 13,
VocalMorpherPhonemeUW = 14,
VocalMorpherPhonemeB = 15,
VocalMorpherPhonemeD = 16,
VocalMorpherPhonemeF = 17,
VocalMorpherPhonemeG = 18,
VocalMorpherPhonemeJ = 19,
VocalMorpherPhonemeK = 20,
VocalMorpherPhonemeL = 21,
VocalMorpherPhonemeM = 22,
VocalMorpherPhonemeN = 23,
VocalMorpherPhonemeP = 24,
VocalMorpherPhonemeR = 25,
VocalMorpherPhonemeS = 26,
VocalMorpherPhonemeT = 27,
VocalMorpherPhonemeV = 28,
VocalMorpherPhonemeZ = 29,
}
///<summary>Effect type definitions to be used with AL_EFFECT_TYPE.</summary>
///<summary>Effect type definitions to be used with EfxEffecti.EffectType.</summary>
public enum EfxEffectType : int
{
EffectNull = 0x0000, /* Can also be used as an Effect Object ID */
EffectReverb = 0x0001,
EffectChorus = 0x0002,
EffectDistortion = 0x0003,
EffectEcho = 0x0004,
EffectFlanger = 0x0005,
EffectFrequencyShifter = 0x0006,
EffectVocalMorpher = 0x0007,
EffectPitchShifter = 0x0008,
EffectRingModulator = 0x0009,
EffectAutowah = 0x000A,
EffectCompressor = 0x000B,
EffectEqualizer = 0x000C,
EffectEaxReverb = 0x8000, // works on native HW only
///<summary>No Effect, disable. This Effect type is used when an Effect object is initially created.</summary>
Null = 0x0000,
///<summary>The Reverb effect is the standard Effects Extension's environmental reverberation effect. It is available on all Generic Software and Generic Hardware devices.</summary>
Reverb = 0x0001,
///<summary>The Chorus effect essentially replays the input audio accompanied by another slightly delayed version of the signal, creating a "doubling" effect.</summary>
Chorus = 0x0002,
///<summary>The Distortion effect simulates turning up (overdriving) the gain stage on a guitar amplifier or adding a distortion pedal to an instrument's output.</summary>
Distortion = 0x0003,
///<summary>The Echo effect generates discrete, delayed instances of the input signal.</summary>
Echo = 0x0004,
///<summary>The Flanger effect creates a "tearing" or "whooshing" sound, like a jet flying overhead.</summary>
Flanger = 0x0005,
///<summary>The Frequency shifter is a single-sideband modulator, which translates all the component frequencies of the input signal by an equal amount.</summary>
FrequencyShifter = 0x0006,
///<summary>The Vocal morpher consists of a pair of 4-band formant filters, used to impose vocal tract effects upon the input signal.</summary>
VocalMorpher = 0x0007,
///<summary>The Pitch shifter applies time-invariant pitch shifting to the input signal, over a one octave range and controllable at a semi-tone and cent resolution.</summary>
PitchShifter = 0x0008,
///<summary>The Ring modulator multiplies an input signal by a carrier signal in the time domain, resulting in tremolo or inharmonic effects.</summary>
RingModulator = 0x0009,
///<summary>The Auto-wah effect emulates the sound of a wah-wah pedal used with an electric guitar, or a mute on a brass instrument.</summary>
Autowah = 0x000A,
///<summary>The Compressor will boost quieter portions of the audio, while louder portions will stay the same or may even be reduced.</summary>
Compressor = 0x000B,
///<summary>The Equalizer is very flexible, providing tonal control over four different adjustable frequency ranges.</summary>
Equalizer = 0x000C,
///<summary>The EAX Reverb has a more advanced parameter set than EfxEffectType.Reverb, but is only natively supported on devices that support the EAX 3.0 or above.</summary>
EaxReverb = 0x8000,
}
#endregion Effect
#region Auxiliary Effect Slot
///<summary>A list of valid Int32 AuxiliaryEffectSlot/GetAuxiliaryEffectSlot parameters</summary>
public enum EfxAuxiliaryi : int
{
/// <summary>This property is used to attach an Effect object to the Auxiliary Effect Slot object. After the attachment, the Auxiliary Effect Slot object will contain the effect type and have the same effect parameters that were stored in the Effect object. Any Sources feeding the Auxiliary Effect Slot will immediate feed the new effect type and new effect parameters.</summary>
EffectslotEffect = 0x0001,
/// <summary>This property is used to enable or disable automatic send adjustments based on the physical positions of the sources and the listener. This property should be enabled when an application wishes to use a reverb effect to simulate the environment surrounding a listener or a collection of Sources. Range [False .. True] Default: True </summary>
/// <summary>This property is used to enable or disable automatic send adjustments based on the physical positions of the sources and the listener. This property should be enabled when an application wishes to use a reverb effect to simulate the environment surrounding a listener or a collection of Sources. Range [False, True] Default: True </summary>
EffectslotAuxiliarySendAuto = 0x0003,
}
}
///<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>
@ -324,7 +320,7 @@ namespace OpenTK.OpenAL.Enums
#region Filter Object
// Filter object definitions to be used with alFilter functions.
///<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>
@ -345,7 +341,7 @@ namespace OpenTK.OpenAL.Enums
BandpassGainHF = 0x0003,
}
// Filter type
///<summary>A list of valid Int32 Filter/GetFilter parameters</summary>
public enum EfxFilteri : int
{
AL_FILTER_FIRST_PARAMETER = 0x0000, // deprecated?
@ -355,13 +351,17 @@ namespace OpenTK.OpenAL.Enums
FilterType = 0x8001,
}
///<summary>Filter type definitions to be used with AL_FILTER_TYPE.</summary>
///<summary>Filter type definitions to be used with EfxFilteri.FilterType.</summary>
public enum EfxFilterType : int
{
FilterNull = 0x0000, // Can also be used as a Filter Object ID
FilterLowpass = 0x0001,
FilterHighpass = 0x0002,
FilterBandpass = 0x0003,
///<summary>No Filter, disable. This Filter type is used when a Filter object is initially created.</summary>
Null = 0x0000,
/// <summary>A low-pass filter is used to remove high frequency content from a signal.</summary>
Lowpass = 0x0001,
///<summary>Currently not implemented. A high-pass filter is used to remove low frequency content from a signal.</summary>
Highpass = 0x0002,
///<summary>Currently not implemented. A band-pass filter is used to remove high and low frequency content from a signal.</summary>
Bandpass = 0x0003,
}
#endregion Filter Object

17
Source/OpenTK/OpenAL/History.txt
View file

@ -29,23 +29,16 @@ Efx: Functions not imported:
- X-Ram Extension untested, as it requires special hardware. !verify parameters of GetBufferMode()!
- functions with ushort, uint, ulong marked as not CLS compliant.
Alpha v0.9
-added docu
-added alEffectfv and alGetEffectfv
-ported samples from SDK
Alpha v0.95
-full cleanup of AL class documentation
-added *.Bind* helpers.
Alpha v0.96
- Cleaned up X-Ram, improved docu, hide some previously public things. No more Console.WriteLines
- Cleaned up X-Ram, added docu, hid some previously public delegates.
- Cleaned up Efx, largely improved docu, refactored some EfxFilter.FilterXYZ glitches to EfxFilter.XYZ.
- commented out debugging Console.WriteLines, replaced errormessages with Trace.Writeline
- Added description for most enums.
Todo for beta:
- Identify: AL_FILTER_FIRST_PARAMETER, AL_FILTER_LAST_PARAMETER
AL_EFFECT_FIRST_PARAMETER, AL_EFFECT_LAST_PARAMETER
- replace EaxEfx reverbs with Efx reverbs.
Todo for final:
- Enums themselves require summaries (do after some more serious tests)
- keep both reverb preset formats, or delete EaxEfxReverb presets?