The Open Toolkit library  1.1
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Properties | List of all members
OpenTK.Audio.OpenAL.EffectsExtension Class Reference

Provides access to the OpenAL effects extension. More...

Public Member Functions

void BindEffect (uint eid, EfxEffectType type)
 (Helper) Selects the Effect type used by this Effect handle. More...
 
void BindEffect (int eid, EfxEffectType type)
 (Helper) Selects the Effect type used by this Effect handle. More...
 
void BindFilterToSource (uint source, uint filter)
 (Helper) reroutes the output of a Source through a Filter. More...
 
void BindFilterToSource (int source, int filter)
 (Helper) reroutes the output of a Source through a Filter. More...
 
void BindEffectToAuxiliarySlot (uint auxiliaryeffectslot, uint effect)
 (Helper) Attaches an Effect to an Auxiliary Effect Slot. More...
 
void BindEffectToAuxiliarySlot (int auxiliaryeffectslot, int effect)
 (Helper) Attaches an Effect to an Auxiliary Effect Slot. More...
 
void BindSourceToAuxiliarySlot (uint source, uint slot, int slotnumber, uint filter)
 (Helper) Reroutes a Source's output into an Auxiliary Effect Slot. More...
 
void BindSourceToAuxiliarySlot (int source, int slot, int slotnumber, int filter)
 (Helper) Reroutes a Source's output into an Auxiliary Effect Slot. More...
 
void GenEffects (int n, out uint effects)
 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 More...
 
void GenEffects (int n, out int effects)
 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 More...
 
int[] GenEffects (int n)
 Generates one or more effect objects. More...
 
int GenEffect ()
 Generates a single effect object. More...
 
void GenEffect (out uint effect)
 Generates a single effect object. More...
 
void DeleteEffects (int n, ref uint effects)
 The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects. More...
 
void DeleteEffects (int n, ref int effects)
 The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects. More...
 
void DeleteEffects (int[] effects)
 The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects. More...
 
void DeleteEffects (uint[] effects)
 The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects. More...
 
void DeleteEffect (int effect)
 This function deletes one Effect only. More...
 
void DeleteEffect (ref uint effect)
 This function deletes one Effect only. More...
 
bool IsEffect (uint eid)
 The IsEffect function is used to determine if an object identifier is a valid Effect object. More...
 
bool IsEffect (int eid)
 The IsEffect function is used to determine if an object identifier is a valid Effect object. More...
 
void Effect (uint eid, EfxEffecti param, int value)
 This function is used to set integer properties on Effect objects. More...
 
void Effect (int eid, EfxEffecti param, int value)
 This function is used to set integer properties on Effect objects. More...
 
void Effect (uint eid, EfxEffectf param, float value)
 This function is used to set floating-point properties on Effect objects. More...
 
void Effect (int eid, EfxEffectf param, float value)
 This function is used to set floating-point properties on Effect objects. More...
 
void Effect (uint eid, EfxEffect3f param, ref Vector3 values)
 This function is used to set 3 floating-point properties on Effect objects. More...
 
void Effect (int eid, EfxEffect3f param, ref Vector3 values)
 This function is used to set 3 floating-point properties on Effect objects. More...
 
void GetEffect (uint eid, EfxEffecti pname, out int value)
 This function is used to retrieve integer properties from Effect objects. More...
 
void GetEffect (int eid, EfxEffecti pname, out int value)
 This function is used to retrieve integer properties from Effect objects. More...
 
void GetEffect (uint eid, EfxEffectf pname, out float value)
 This function is used to retrieve floating-point properties from Effect objects. More...
 
void GetEffect (int eid, EfxEffectf pname, out float value)
 This function is used to retrieve floating-point properties from Effect objects. More...
 
void GetEffect (uint eid, EfxEffect3f param, out Vector3 values)
 This function is used to retrieve 3 floating-point properties from Effect objects. More...
 
void GetEffect (int eid, EfxEffect3f param, out Vector3 values)
 This function is used to retrieve 3 floating-point properties from Effect objects. More...
 
void GenFilters (int n, out uint filters)
 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. More...
 
void GenFilters (int n, out int filters)
 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. More...
 
int[] GenFilters (int n)
 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. More...
 
int GenFilter ()
 This function generates only one Filter. More...
 
unsafe void GenFilter (out uint filter)
 This function generates only one Filter. More...
 
void DeleteFilters (int n, ref uint filters)
 The DeleteFilters function is used to delete and free resources for Filter objects previously created with GenFilters. More...
 
void DeleteFilters (int n, ref int filters)
 The DeleteFilters function is used to delete and free resources for Filter objects previously created with GenFilters. More...
 
void DeleteFilters (uint[] filters)
 This function deletes one Filter only. More...
 
void DeleteFilters (int[] filters)
 This function deletes one Filter only. More...
 
void DeleteFilter (int filter)
 This function deletes one Filter only. More...
 
void DeleteFilter (ref uint filter)
 This function deletes one Filter only. More...
 
bool IsFilter (uint fid)
 The IsFilter function is used to determine if an object identifier is a valid Filter object. More...
 
bool IsFilter (int fid)
 The IsFilter function is used to determine if an object identifier is a valid Filter object. More...
 
void Filter (uint fid, EfxFilteri param, int value)
 This function is used to set integer properties on Filter objects. More...
 
void Filter (int fid, EfxFilteri param, int value)
 This function is used to set integer properties on Filter objects. More...
 
void Filter (uint fid, EfxFilterf param, float value)
 This function is used to set floating-point properties on Filter objects. More...
 
void Filter (int fid, EfxFilterf param, float value)
 This function is used to set floating-point properties on Filter objects. More...
 
void GetFilter (uint fid, EfxFilteri pname, out int value)
 This function is used to retrieve integer properties from Filter objects. More...
 
void GetFilter (int fid, EfxFilteri pname, out int value)
 This function is used to retrieve integer properties from Filter objects. More...
 
void GetFilter (uint fid, EfxFilterf pname, out float value)
 This function is used to retrieve floating-point properties from Filter objects. More...
 
void GetFilter (int fid, EfxFilterf pname, out float value)
 This function is used to retrieve floating-point properties from Filter objects. More...
 
void GenAuxiliaryEffectSlots (int n, out uint slots)
 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. More...
 
void GenAuxiliaryEffectSlots (int n, out int slots)
 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. More...
 
int[] GenAuxiliaryEffectSlots (int n)
 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. More...
 
int GenAuxiliaryEffectSlot ()
 This function generates only one Auxiliary Effect Slot. More...
 
void GenAuxiliaryEffectSlot (out uint slot)
 This function generates only one Auxiliary Effect Slot. More...
 
void DeleteAuxiliaryEffectSlots (int n, ref uint slots)
 The DeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with GenAuxiliaryEffectSlots. More...
 
void DeleteAuxiliaryEffectSlots (int n, ref int slots)
 The DeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with GenAuxiliaryEffectSlots. More...
 
void DeleteAuxiliaryEffectSlots (int[] slots)
 The DeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with GenAuxiliaryEffectSlots. More...
 
void DeleteAuxiliaryEffectSlots (uint[] slots)
 This function deletes one AuxiliaryEffectSlot only. More...
 
void DeleteAuxiliaryEffectSlot (int slot)
 This function deletes one AuxiliaryEffectSlot only. More...
 
void DeleteAuxiliaryEffectSlot (ref uint slot)
 This function deletes one AuxiliaryEffectSlot only. More...
 
bool IsAuxiliaryEffectSlot (uint slot)
 The IsAuxiliaryEffectSlot function is used to determine if an object identifier is a valid Auxiliary Effect Slot object. More...
 
bool IsAuxiliaryEffectSlot (int slot)
 The IsAuxiliaryEffectSlot function is used to determine if an object identifier is a valid Auxiliary Effect Slot object. More...
 
void AuxiliaryEffectSlot (uint asid, EfxAuxiliaryi param, int value)
 This function is used to set integer properties on Auxiliary Effect Slot objects. More...
 
void AuxiliaryEffectSlot (int asid, EfxAuxiliaryi param, int value)
 This function is used to set integer properties on Auxiliary Effect Slot objects. More...
 
void AuxiliaryEffectSlot (uint asid, EfxAuxiliaryf param, float value)
 This function is used to set floating-point properties on Auxiliary Effect Slot objects. More...
 
void AuxiliaryEffectSlot (int asid, EfxAuxiliaryf param, float value)
 This function is used to set floating-point properties on Auxiliary Effect Slot objects. More...
 
void GetAuxiliaryEffectSlot (uint asid, EfxAuxiliaryi pname, out int value)
 This function is used to retrieve integer properties on Auxiliary Effect Slot objects. More...
 
void GetAuxiliaryEffectSlot (int asid, EfxAuxiliaryi pname, out int value)
 This function is used to retrieve integer properties on Auxiliary Effect Slot objects. More...
 
void GetAuxiliaryEffectSlot (uint asid, EfxAuxiliaryf pname, out float value)
 This function is used to retrieve floating properties on Auxiliary Effect Slot objects. More...
 
void GetAuxiliaryEffectSlot (int asid, EfxAuxiliaryf pname, out float value)
 This function is used to retrieve floating properties on Auxiliary Effect Slot objects. More...
 
 EffectsExtension ()
 Constructs a new EffectsExtension instance. More...
 

Static Public Member Functions

static void GetEaxFromEfxEax (ref EaxReverb input, out EfxEaxReverb output)
 

Properties

bool IsInitialized [get]
 Returns True if the EFX Extension has been found and could be initialized. More...
 

Detailed Description

Provides access to the OpenAL effects extension.

Constructor & Destructor Documentation

OpenTK.Audio.OpenAL.EffectsExtension.EffectsExtension ( )

Constructs a new EffectsExtension instance.

Member Function Documentation

void OpenTK.Audio.OpenAL.EffectsExtension.AuxiliaryEffectSlot ( uint  asid,
EfxAuxiliaryi  param,
int  value 
)

This function is used to set integer properties on Auxiliary Effect Slot objects.

Parameters
asidAuxiliary Effect Slot object identifier.
paramAuxiliary Effect Slot property to set.
valueInteger value.
void OpenTK.Audio.OpenAL.EffectsExtension.AuxiliaryEffectSlot ( int  asid,
EfxAuxiliaryi  param,
int  value 
)

This function is used to set integer properties on Auxiliary Effect Slot objects.

Parameters
asidAuxiliary Effect Slot object identifier.
paramAuxiliary Effect Slot property to set.
valueInteger value.
void OpenTK.Audio.OpenAL.EffectsExtension.AuxiliaryEffectSlot ( uint  asid,
EfxAuxiliaryf  param,
float  value 
)

This function is used to set floating-point properties on Auxiliary Effect Slot objects.

Parameters
asidAuxiliary Effect Slot object identifier.
paramAuxiliary Effect Slot property to set.
valueFloating-point value.
void OpenTK.Audio.OpenAL.EffectsExtension.AuxiliaryEffectSlot ( int  asid,
EfxAuxiliaryf  param,
float  value 
)

This function is used to set floating-point properties on Auxiliary Effect Slot objects.

Parameters
asidAuxiliary Effect Slot object identifier.
paramAuxiliary Effect Slot property to set.
valueFloating-point value.
void OpenTK.Audio.OpenAL.EffectsExtension.BindEffect ( uint  eid,
EfxEffectType  type 
)

(Helper) Selects the Effect type used by this Effect handle.

Parameters
eidEffect id returned from a successful call to GenEffects.
typeEffect type.
void OpenTK.Audio.OpenAL.EffectsExtension.BindEffect ( int  eid,
EfxEffectType  type 
)

(Helper) Selects the Effect type used by this Effect handle.

Parameters
eidEffect id returned from a successful call to GenEffects.
typeEffect type.
void OpenTK.Audio.OpenAL.EffectsExtension.BindEffectToAuxiliarySlot ( uint  auxiliaryeffectslot,
uint  effect 
)

(Helper) Attaches an Effect to an Auxiliary Effect Slot.

Parameters
auxiliaryeffectslotThe slot handle to attach the Effect to.
effectThe Effect handle that is being attached.
void OpenTK.Audio.OpenAL.EffectsExtension.BindEffectToAuxiliarySlot ( int  auxiliaryeffectslot,
int  effect 
)

(Helper) Attaches an Effect to an Auxiliary Effect Slot.

Parameters
auxiliaryeffectslotThe slot handle to attach the Effect to.
effectThe Effect handle that is being attached.
void OpenTK.Audio.OpenAL.EffectsExtension.BindFilterToSource ( uint  source,
uint  filter 
)

(Helper) reroutes the output of a Source through a Filter.

Parameters
sourceA valid Source handle.
filterA valid Filter handle.
void OpenTK.Audio.OpenAL.EffectsExtension.BindFilterToSource ( int  source,
int  filter 
)

(Helper) reroutes the output of a Source through a Filter.

Parameters
sourceA valid Source handle.
filterA valid Filter handle.
void OpenTK.Audio.OpenAL.EffectsExtension.BindSourceToAuxiliarySlot ( uint  source,
uint  slot,
int  slotnumber,
uint  filter 
)

(Helper) Reroutes a Source's output into an Auxiliary Effect Slot.

Parameters
sourceThe Source handle who's output is forwarded.
slotThe Auxiliary Effect Slot handle that receives input from the Source.
slotnumberEvery Source has only a limited number of slots it can feed buffer to. The number must stay below AlcContextAttributes.EfxMaxAuxiliarySends
filterFilter handle to be attached between Source ouput and Auxiliary Slot input. Use 0 or EfxFilterType.FilterNull for no filter.
void OpenTK.Audio.OpenAL.EffectsExtension.BindSourceToAuxiliarySlot ( int  source,
int  slot,
int  slotnumber,
int  filter 
)

(Helper) Reroutes a Source's output into an Auxiliary Effect Slot.

Parameters
sourceThe Source handle who's output is forwarded.
slotThe Auxiliary Effect Slot handle that receives input from the Source.
slotnumberEvery Source has only a limited number of slots it can feed buffer to. The number must stay below AlcContextAttributes.EfxMaxAuxiliarySends
filterFilter handle to be attached between Source ouput and Auxiliary Slot input. Use 0 or EfxFilterType.FilterNull for no filter.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteAuxiliaryEffectSlot ( int  slot)

This function deletes one AuxiliaryEffectSlot only.

Parameters
slotPointer to an auxiliary effect slot name/handle identifying the Auxiliary Effect Slot Object to be deleted.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteAuxiliaryEffectSlot ( ref uint  slot)

This function deletes one AuxiliaryEffectSlot only.

Parameters
slotPointer to an auxiliary effect slot name/handle identifying the Auxiliary Effect Slot Object to be deleted.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteAuxiliaryEffectSlots ( int  n,
ref uint  slots 
)

The DeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with GenAuxiliaryEffectSlots.

Parameters
nNumber of Auxiliary Effect Slots to be deleted.
slotsPointer to n Effect Slot object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteAuxiliaryEffectSlots ( int  n,
ref int  slots 
)

The DeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with GenAuxiliaryEffectSlots.

Parameters
nNumber of Auxiliary Effect Slots to be deleted.
slotsPointer to n Effect Slot object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteAuxiliaryEffectSlots ( int[]  slots)

The DeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with GenAuxiliaryEffectSlots.

Parameters
slotsPointer to n Effect Slot object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteAuxiliaryEffectSlots ( uint[]  slots)

This function deletes one AuxiliaryEffectSlot only.

Parameters
slotsPointer to an auxiliary effect slot name/handle identifying the Auxiliary Effect Slot Object to be deleted.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteEffect ( int  effect)

This function deletes one Effect only.

Parameters
effectPointer to an effect name/handle identifying the Effect Object to be deleted.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteEffect ( ref uint  effect)

This function deletes one Effect only.

Parameters
effectPointer to an effect name/handle identifying the Effect Object to be deleted.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteEffects ( int  n,
ref uint  effects 
)

The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects.

Parameters
nNumber of Effects to be deleted.
effectsPointer to n Effect object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteEffects ( int  n,
ref int  effects 
)

The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects.

Parameters
nNumber of Effects to be deleted.
effectsPointer to n Effect object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteEffects ( int[]  effects)

The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects.

Parameters
effectsPointer to n Effect object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteEffects ( uint[]  effects)

The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects.

Parameters
effectsPointer to n Effect object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteFilter ( int  filter)

This function deletes one Filter only.

Parameters
filterPointer to an filter name/handle identifying the Filter Object to be deleted.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteFilter ( ref uint  filter)

This function deletes one Filter only.

Parameters
filterPointer to an filter name/handle identifying the Filter Object to be deleted.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteFilters ( int  n,
ref uint  filters 
)

The DeleteFilters function is used to delete and free resources for Filter objects previously created with GenFilters.

Parameters
nNumber of Filters to be deleted.
filtersPointer to n Filter object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteFilters ( int  n,
ref int  filters 
)

The DeleteFilters function is used to delete and free resources for Filter objects previously created with GenFilters.

Parameters
nNumber of Filters to be deleted.
filtersPointer to n Filter object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteFilters ( uint[]  filters)

This function deletes one Filter only.

Parameters
filtersPointer to an filter name/handle identifying the Filter Object to be deleted.
void OpenTK.Audio.OpenAL.EffectsExtension.DeleteFilters ( int[]  filters)

This function deletes one Filter only.

Parameters
filtersPointer to an filter name/handle identifying the Filter Object to be deleted.
void OpenTK.Audio.OpenAL.EffectsExtension.Effect ( uint  eid,
EfxEffecti  param,
int  value 
)

This function is used to set integer properties on Effect objects.

Parameters
eidEffect object identifier.
paramEffect property to set.
valueInteger value.
void OpenTK.Audio.OpenAL.EffectsExtension.Effect ( int  eid,
EfxEffecti  param,
int  value 
)

This function is used to set integer properties on Effect objects.

Parameters
eidEffect object identifier.
paramEffect property to set.
valueInteger value.
void OpenTK.Audio.OpenAL.EffectsExtension.Effect ( uint  eid,
EfxEffectf  param,
float  value 
)

This function is used to set floating-point properties on Effect objects.

Parameters
eidEffect object identifier.
paramEffect property to set.
valueFloating-point value.
void OpenTK.Audio.OpenAL.EffectsExtension.Effect ( int  eid,
EfxEffectf  param,
float  value 
)

This function is used to set floating-point properties on Effect objects.

Parameters
eidEffect object identifier.
paramEffect property to set.
valueFloating-point value.
void OpenTK.Audio.OpenAL.EffectsExtension.Effect ( uint  eid,
EfxEffect3f  param,
ref Vector3  values 
)

This function is used to set 3 floating-point properties on Effect objects.

Parameters
eidEffect object identifier.
paramEffect property to set.
valuesPointer to Math.Vector3.
void OpenTK.Audio.OpenAL.EffectsExtension.Effect ( int  eid,
EfxEffect3f  param,
ref Vector3  values 
)

This function is used to set 3 floating-point properties on Effect objects.

Parameters
eidEffect object identifier.
paramEffect property to set.
valuesPointer to Math.Vector3.
void OpenTK.Audio.OpenAL.EffectsExtension.Filter ( uint  fid,
EfxFilteri  param,
int  value 
)

This function is used to set integer properties on Filter objects.

Parameters
fidFilter object identifier.
paramEffect property to set.
valueInteger value.
void OpenTK.Audio.OpenAL.EffectsExtension.Filter ( int  fid,
EfxFilteri  param,
int  value 
)

This function is used to set integer properties on Filter objects.

Parameters
fidFilter object identifier.
paramEffect property to set.
valueInteger value.
void OpenTK.Audio.OpenAL.EffectsExtension.Filter ( uint  fid,
EfxFilterf  param,
float  value 
)

This function is used to set floating-point properties on Filter objects.

Parameters
fidFilter object identifier.
paramEffect property to set.
valueFloating-point value.
void OpenTK.Audio.OpenAL.EffectsExtension.Filter ( int  fid,
EfxFilterf  param,
float  value 
)

This function is used to set floating-point properties on Filter objects.

Parameters
fidFilter object identifier.
paramEffect property to set.
valueFloating-point value.
int OpenTK.Audio.OpenAL.EffectsExtension.GenAuxiliaryEffectSlot ( )

This function generates only one Auxiliary Effect Slot.

Returns
Storage Int32 for the new auxiliary effect slot name/handle.
void OpenTK.Audio.OpenAL.EffectsExtension.GenAuxiliaryEffectSlot ( out uint  slot)

This function generates only one Auxiliary Effect Slot.

Returns
Storage UInt32 for the new auxiliary effect slot name/handle.
void OpenTK.Audio.OpenAL.EffectsExtension.GenAuxiliaryEffectSlots ( int  n,
out uint  slots 
)

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.

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.

Parameters
nNumber of Auxiliary Effect Slots to be created.
slotsPointer addressing sufficient memory to store n Effect Slot object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.GenAuxiliaryEffectSlots ( int  n,
out int  slots 
)

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.

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.

Parameters
nNumber of Auxiliary Effect Slots to be created.
slotsPointer addressing sufficient memory to store n Effect Slot object identifiers.
int [] OpenTK.Audio.OpenAL.EffectsExtension.GenAuxiliaryEffectSlots ( int  n)

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.

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.

Parameters
nNumber of Auxiliary Effect Slots to be created.
Returns
Pointer addressing sufficient memory to store n Effect Slot object identifiers.
int OpenTK.Audio.OpenAL.EffectsExtension.GenEffect ( )

Generates a single effect object.

Returns
A handle to the generated effect object.

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.

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.

void OpenTK.Audio.OpenAL.EffectsExtension.GenEffect ( out uint  effect)

Generates a single effect object.

Parameters
effectA handle to the generated effect object.
void OpenTK.Audio.OpenAL.EffectsExtension.GenEffects ( int  n,
out uint  effects 
)

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

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.

Parameters
nNumber of Effects to be created.
effectsPointer addressing sufficient memory to store n Effect object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.GenEffects ( int  n,
out int  effects 
)

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

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.

Parameters
nNumber of Effects to be created.
effectsPointer addressing sufficient memory to store n Effect object identifiers.
int [] OpenTK.Audio.OpenAL.EffectsExtension.GenEffects ( int  n)

Generates one or more effect objects.

Parameters
nNumber of Effect object identifiers to generate.

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.

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.

int OpenTK.Audio.OpenAL.EffectsExtension.GenFilter ( )

This function generates only one Filter.

Returns
Storage Int32 for the new filter name/handle.
unsafe void OpenTK.Audio.OpenAL.EffectsExtension.GenFilter ( out uint  filter)

This function generates only one Filter.

Parameters
filterStorage UInt32 for the new filter name/handle.
void OpenTK.Audio.OpenAL.EffectsExtension.GenFilters ( int  n,
out uint  filters 
)

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.

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.

Parameters
nNumber of Filters to be created.
filtersPointer addressing sufficient memory to store n Filter object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.GenFilters ( int  n,
out int  filters 
)

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.

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.

Parameters
nNumber of Filters to be created.
filtersPointer addressing sufficient memory to store n Filter object identifiers.
int [] OpenTK.Audio.OpenAL.EffectsExtension.GenFilters ( int  n)

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.

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.

Parameters
nNumber of Filters to be created.
Returns
Pointer addressing sufficient memory to store n Filter object identifiers.
void OpenTK.Audio.OpenAL.EffectsExtension.GetAuxiliaryEffectSlot ( uint  asid,
EfxAuxiliaryi  pname,
out int  value 
)

This function is used to retrieve integer properties on Auxiliary Effect Slot objects.

Parameters
asidAuxiliary Effect Slot object identifier.
pnameAuxiliary Effect Slot property to retrieve.
valueAddress where integer value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetAuxiliaryEffectSlot ( int  asid,
EfxAuxiliaryi  pname,
out int  value 
)

This function is used to retrieve integer properties on Auxiliary Effect Slot objects.

Parameters
asidAuxiliary Effect Slot object identifier.
pnameAuxiliary Effect Slot property to retrieve.
valueAddress where integer value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetAuxiliaryEffectSlot ( uint  asid,
EfxAuxiliaryf  pname,
out float  value 
)

This function is used to retrieve floating properties on Auxiliary Effect Slot objects.

Parameters
asidAuxiliary Effect Slot object identifier.
pnameAuxiliary Effect Slot property to retrieve.
valueAddress where floating-point value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetAuxiliaryEffectSlot ( int  asid,
EfxAuxiliaryf  pname,
out float  value 
)

This function is used to retrieve floating properties on Auxiliary Effect Slot objects.

Parameters
asidAuxiliary Effect Slot object identifier.
pnameAuxiliary Effect Slot property to retrieve.
valueAddress where floating-point value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetEffect ( uint  eid,
EfxEffecti  pname,
out int  value 
)

This function is used to retrieve integer properties from Effect objects.

Parameters
eidEffect object identifier.
pnameEffect property to retrieve.
valueAddress where integer value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetEffect ( int  eid,
EfxEffecti  pname,
out int  value 
)

This function is used to retrieve integer properties from Effect objects.

Parameters
eidEffect object identifier.
pnameEffect property to retrieve.
valueAddress where integer value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetEffect ( uint  eid,
EfxEffectf  pname,
out float  value 
)

This function is used to retrieve floating-point properties from Effect objects.

Parameters
eidEffect object identifier.
pnameEffect property to retrieve.
valueAddress where floating-point value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetEffect ( int  eid,
EfxEffectf  pname,
out float  value 
)

This function is used to retrieve floating-point properties from Effect objects.

Parameters
eidEffect object identifier.
pnameEffect property to retrieve.
valueAddress where floating-point value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetEffect ( uint  eid,
EfxEffect3f  param,
out Vector3  values 
)

This function is used to retrieve 3 floating-point properties from Effect objects.

Parameters
eidEffect object identifier.
paramEffect property to retrieve.
valuesA Math.Vector3 to hold the values.
void OpenTK.Audio.OpenAL.EffectsExtension.GetEffect ( int  eid,
EfxEffect3f  param,
out Vector3  values 
)

This function is used to retrieve 3 floating-point properties from Effect objects.

Parameters
eidEffect object identifier.
paramEffect property to retrieve.
valuesA Math.Vector3 to hold the values.
void OpenTK.Audio.OpenAL.EffectsExtension.GetFilter ( uint  fid,
EfxFilteri  pname,
out int  value 
)

This function is used to retrieve integer properties from Filter objects.

Parameters
fidFilter object identifier.
pnameEffect property to retrieve.
valueAddress where integer value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetFilter ( int  fid,
EfxFilteri  pname,
out int  value 
)

This function is used to retrieve integer properties from Filter objects.

Parameters
fidFilter object identifier.
pnameEffect property to retrieve.
valueAddress where integer value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetFilter ( uint  fid,
EfxFilterf  pname,
out float  value 
)

This function is used to retrieve floating-point properties from Filter objects.

Parameters
fidFilter object identifier.
pnameEffect property to retrieve.
valueAddress where floating-point value will be stored.
void OpenTK.Audio.OpenAL.EffectsExtension.GetFilter ( int  fid,
EfxFilterf  pname,
out float  value 
)

This function is used to retrieve floating-point properties from Filter objects.

Parameters
fidFilter object identifier.
pnameEffect property to retrieve.
valueAddress where floating-point value will be stored.
bool OpenTK.Audio.OpenAL.EffectsExtension.IsAuxiliaryEffectSlot ( uint  slot)

The IsAuxiliaryEffectSlot function is used to determine if an object identifier is a valid Auxiliary Effect Slot object.

Parameters
slotEffect Slot object identifier to validate.
Returns
True if the identifier is a valid Auxiliary Effect Slot, False otherwise.
bool OpenTK.Audio.OpenAL.EffectsExtension.IsAuxiliaryEffectSlot ( int  slot)

The IsAuxiliaryEffectSlot function is used to determine if an object identifier is a valid Auxiliary Effect Slot object.

Parameters
slotEffect Slot object identifier to validate.
Returns
True if the identifier is a valid Auxiliary Effect Slot, False otherwise.
bool OpenTK.Audio.OpenAL.EffectsExtension.IsEffect ( uint  eid)

The IsEffect function is used to determine if an object identifier is a valid Effect object.

Parameters
eidEffect identifier to validate.
Returns
True if the identifier is a valid Effect, False otherwise.
bool OpenTK.Audio.OpenAL.EffectsExtension.IsEffect ( int  eid)

The IsEffect function is used to determine if an object identifier is a valid Effect object.

Parameters
eidEffect identifier to validate.
Returns
True if the identifier is a valid Effect, False otherwise.
bool OpenTK.Audio.OpenAL.EffectsExtension.IsFilter ( uint  fid)

The IsFilter function is used to determine if an object identifier is a valid Filter object.

Parameters
fidEffect identifier to validate.
Returns
True if the identifier is a valid Filter, False otherwise.
bool OpenTK.Audio.OpenAL.EffectsExtension.IsFilter ( int  fid)

The IsFilter function is used to determine if an object identifier is a valid Filter object.

Parameters
fidEffect identifier to validate.
Returns
True if the identifier is a valid Filter, False otherwise.

Property Documentation

bool OpenTK.Audio.OpenAL.EffectsExtension.IsInitialized
get

Returns True if the EFX Extension has been found and could be initialized.