Class EffectsExtension
Provides access to the OpenAL effects extension.
Inherited Members
Namespace: OpenTK.Audio.OpenAL
Assembly: OpenTK.dll
Syntax
public class EffectsExtensionConstructors
EffectsExtension()
Constructs a new EffectsExtension instance.
Declaration
public EffectsExtension()Properties
IsInitialized
Returns True if the EFX Extension has been found and could be initialized.
Declaration
public bool IsInitialized { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
AuxiliaryEffectSlot(Int32, EfxAuxiliaryf, Single)
This function is used to set floating-point properties on Auxiliary Effect Slot objects.
Declaration
public void AuxiliaryEffectSlot(int asid, EfxAuxiliaryf param, float value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | asid | Auxiliary Effect Slot object identifier. |
| EfxAuxiliaryf | param | Auxiliary Effect Slot property to set. |
| Single | value | Floating-point value. |
AuxiliaryEffectSlot(Int32, EfxAuxiliaryi, Int32)
This function is used to set integer properties on Auxiliary Effect Slot objects.
Declaration
public void AuxiliaryEffectSlot(int asid, EfxAuxiliaryi param, int value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | asid | Auxiliary Effect Slot object identifier. |
| EfxAuxiliaryi | param | Auxiliary Effect Slot property to set. |
| Int32 | value | Integer value. |
AuxiliaryEffectSlot(UInt32, EfxAuxiliaryf, Single)
This function is used to set floating-point properties on Auxiliary Effect Slot objects.
Declaration
[CLSCompliant(false)]
public void AuxiliaryEffectSlot(uint asid, EfxAuxiliaryf param, float value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | asid | Auxiliary Effect Slot object identifier. |
| EfxAuxiliaryf | param | Auxiliary Effect Slot property to set. |
| Single | value | Floating-point value. |
AuxiliaryEffectSlot(UInt32, EfxAuxiliaryi, Int32)
This function is used to set integer properties on Auxiliary Effect Slot objects.
Declaration
[CLSCompliant(false)]
public void AuxiliaryEffectSlot(uint asid, EfxAuxiliaryi param, int value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | asid | Auxiliary Effect Slot object identifier. |
| EfxAuxiliaryi | param | Auxiliary Effect Slot property to set. |
| Int32 | value | Integer value. |
BindEffect(Int32, EfxEffectType)
(Helper) Selects the Effect type used by this Effect handle.
Declaration
public void BindEffect(int eid, EfxEffectType type)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | eid | Effect id returned from a successful call to GenEffects. |
| EfxEffectType | type | Effect type. |
BindEffect(UInt32, EfxEffectType)
(Helper) Selects the Effect type used by this Effect handle.
Declaration
[CLSCompliant(false)]
public void BindEffect(uint eid, EfxEffectType type)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | eid | Effect id returned from a successful call to GenEffects. |
| EfxEffectType | type | Effect type. |
BindEffectToAuxiliarySlot(Int32, Int32)
(Helper) Attaches an Effect to an Auxiliary Effect Slot.
Declaration
public void BindEffectToAuxiliarySlot(int auxiliaryeffectslot, int effect)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | auxiliaryeffectslot | The slot handle to attach the Effect to. |
| Int32 | effect | The Effect handle that is being attached. |
BindEffectToAuxiliarySlot(UInt32, UInt32)
(Helper) Attaches an Effect to an Auxiliary Effect Slot.
Declaration
[CLSCompliant(false)]
public void BindEffectToAuxiliarySlot(uint auxiliaryeffectslot, uint effect)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | auxiliaryeffectslot | The slot handle to attach the Effect to. |
| UInt32 | effect | The Effect handle that is being attached. |
BindFilterToSource(Int32, Int32)
(Helper) reroutes the output of a Source through a Filter.
Declaration
public void BindFilterToSource(int source, int filter)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | source | A valid Source handle. |
| Int32 | filter | A valid Filter handle. |
BindFilterToSource(UInt32, UInt32)
(Helper) reroutes the output of a Source through a Filter.
Declaration
[CLSCompliant(false)]
public void BindFilterToSource(uint source, uint filter)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | source | A valid Source handle. |
| UInt32 | filter | A valid Filter handle. |
BindSourceToAuxiliarySlot(Int32, Int32, Int32, Int32)
(Helper) Reroutes a Source's output into an Auxiliary Effect Slot.
Declaration
public void BindSourceToAuxiliarySlot(int source, int slot, int slotnumber, int filter)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | source | The Source handle who's output is forwarded. |
| Int32 | slot | The Auxiliary Effect Slot handle that receives input from the Source. |
| Int32 | slotnumber | Every Source has only a limited number of slots it can feed buffer to. The number must stay below AlcContextAttributes.EfxMaxAuxiliarySends |
| Int32 | filter | Filter handle to be attached between Source ouput and Auxiliary Slot input. Use 0 or EfxFilterType.FilterNull for no filter. |
BindSourceToAuxiliarySlot(UInt32, UInt32, Int32, UInt32)
(Helper) Reroutes a Source's output into an Auxiliary Effect Slot.
Declaration
[CLSCompliant(false)]
public void BindSourceToAuxiliarySlot(uint source, uint slot, int slotnumber, uint filter)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | source | The Source handle who's output is forwarded. |
| UInt32 | slot | The Auxiliary Effect Slot handle that receives input from the Source. |
| Int32 | slotnumber | Every Source has only a limited number of slots it can feed buffer to. The number must stay below AlcContextAttributes.EfxMaxAuxiliarySends |
| UInt32 | filter | Filter handle to be attached between Source ouput and Auxiliary Slot input. Use 0 or EfxFilterType.FilterNull for no filter. |
DeleteAuxiliaryEffectSlot(Int32)
This function deletes one AuxiliaryEffectSlot only.
Declaration
public void DeleteAuxiliaryEffectSlot(int slot)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | slot | Pointer to an auxiliary effect slot name/handle identifying the Auxiliary Effect Slot Object to be deleted. |
DeleteAuxiliaryEffectSlot(ref UInt32)
This function deletes one AuxiliaryEffectSlot only.
Declaration
[CLSCompliant(false)]
public void DeleteAuxiliaryEffectSlot(ref uint slot)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | slot | Pointer to an auxiliary effect slot name/handle identifying the Auxiliary Effect Slot Object to be deleted. |
DeleteAuxiliaryEffectSlots(Int32, ref Int32)
The DeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with GenAuxiliaryEffectSlots.
Declaration
public void DeleteAuxiliaryEffectSlots(int n, ref int slots)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Auxiliary Effect Slots to be deleted. |
| Int32 | slots | Pointer to n Effect Slot object identifiers. |
DeleteAuxiliaryEffectSlots(Int32, ref UInt32)
The DeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with GenAuxiliaryEffectSlots.
Declaration
[CLSCompliant(false)]
public void DeleteAuxiliaryEffectSlots(int n, ref uint slots)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Auxiliary Effect Slots to be deleted. |
| UInt32 | slots | Pointer to n Effect Slot object identifiers. |
DeleteAuxiliaryEffectSlots(Int32[])
The DeleteAuxiliaryEffectSlots function is used to delete and free resources for Auxiliary Effect Slots previously created with GenAuxiliaryEffectSlots.
Declaration
public void DeleteAuxiliaryEffectSlots(int[] slots)Parameters
| Type | Name | Description |
|---|---|---|
| Int32[] | slots | Pointer to n Effect Slot object identifiers. |
DeleteAuxiliaryEffectSlots(UInt32[])
This function deletes one AuxiliaryEffectSlot only.
Declaration
[CLSCompliant(false)]
public void DeleteAuxiliaryEffectSlots(uint[] slots)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32[] | slots | Pointer to an auxiliary effect slot name/handle identifying the Auxiliary Effect Slot Object to be deleted. |
DeleteEffect(Int32)
This function deletes one Effect only.
Declaration
public void DeleteEffect(int effect)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | effect | Pointer to an effect name/handle identifying the Effect Object to be deleted. |
DeleteEffect(ref UInt32)
This function deletes one Effect only.
Declaration
[CLSCompliant(false)]
public void DeleteEffect(ref uint effect)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | effect | Pointer to an effect name/handle identifying the Effect Object to be deleted. |
DeleteEffects(Int32, ref Int32)
The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects.
Declaration
public void DeleteEffects(int n, ref int effects)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Effects to be deleted. |
| Int32 | effects | Pointer to n Effect object identifiers. |
DeleteEffects(Int32, ref UInt32)
The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects.
Declaration
[CLSCompliant(false)]
public void DeleteEffects(int n, ref uint effects)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Effects to be deleted. |
| UInt32 | effects | Pointer to n Effect object identifiers. |
DeleteEffects(Int32[])
The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects.
Declaration
public void DeleteEffects(int[] effects)Parameters
| Type | Name | Description |
|---|---|---|
| Int32[] | effects | Pointer to n Effect object identifiers. |
DeleteEffects(UInt32[])
The DeleteEffects function is used to delete and free resources for Effect objects previously created with GenEffects.
Declaration
[CLSCompliant(false)]
public void DeleteEffects(uint[] effects)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32[] | effects | Pointer to n Effect object identifiers. |
DeleteFilter(Int32)
This function deletes one Filter only.
Declaration
public void DeleteFilter(int filter)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | filter | Pointer to an filter name/handle identifying the Filter Object to be deleted. |
DeleteFilter(ref UInt32)
This function deletes one Filter only.
Declaration
[CLSCompliant(false)]
public void DeleteFilter(ref uint filter)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | filter | Pointer to an filter name/handle identifying the Filter Object to be deleted. |
DeleteFilters(Int32, ref Int32)
The DeleteFilters function is used to delete and free resources for Filter objects previously created with GenFilters.
Declaration
public void DeleteFilters(int n, ref int filters)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Filters to be deleted. |
| Int32 | filters | Pointer to n Filter object identifiers. |
DeleteFilters(Int32, ref UInt32)
The DeleteFilters function is used to delete and free resources for Filter objects previously created with GenFilters.
Declaration
[CLSCompliant(false)]
public void DeleteFilters(int n, ref uint filters)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Filters to be deleted. |
| UInt32 | filters | Pointer to n Filter object identifiers. |
DeleteFilters(Int32[])
This function deletes one Filter only.
Declaration
public void DeleteFilters(int[] filters)Parameters
| Type | Name | Description |
|---|---|---|
| Int32[] | filters | Pointer to an filter name/handle identifying the Filter Object to be deleted. |
DeleteFilters(UInt32[])
This function deletes one Filter only.
Declaration
[CLSCompliant(false)]
public void DeleteFilters(uint[] filters)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32[] | filters | Pointer to an filter name/handle identifying the Filter Object to be deleted. |
Effect(Int32, EfxEffect3f, ref Vector3)
This function is used to set 3 floating-point properties on Effect objects.
Declaration
public void Effect(int eid, EfxEffect3f param, ref Vector3 values)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | eid | Effect object identifier. |
| EfxEffect3f | param | Effect property to set. |
| Vector3 | values | Pointer to Math.Vector3. |
Effect(Int32, EfxEffectf, Single)
This function is used to set floating-point properties on Effect objects.
Declaration
public void Effect(int eid, EfxEffectf param, float value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | eid | Effect object identifier. |
| EfxEffectf | param | Effect property to set. |
| Single | value | Floating-point value. |
Effect(Int32, EfxEffecti, Int32)
This function is used to set integer properties on Effect objects.
Declaration
public void Effect(int eid, EfxEffecti param, int value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | eid | Effect object identifier. |
| EfxEffecti | param | Effect property to set. |
| Int32 | value | Integer value. |
Effect(UInt32, EfxEffect3f, ref Vector3)
This function is used to set 3 floating-point properties on Effect objects.
Declaration
[CLSCompliant(false)]
public void Effect(uint eid, EfxEffect3f param, ref Vector3 values)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | eid | Effect object identifier. |
| EfxEffect3f | param | Effect property to set. |
| Vector3 | values | Pointer to Math.Vector3. |
Effect(UInt32, EfxEffectf, Single)
This function is used to set floating-point properties on Effect objects.
Declaration
[CLSCompliant(false)]
public void Effect(uint eid, EfxEffectf param, float value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | eid | Effect object identifier. |
| EfxEffectf | param | Effect property to set. |
| Single | value | Floating-point value. |
Effect(UInt32, EfxEffecti, Int32)
This function is used to set integer properties on Effect objects.
Declaration
[CLSCompliant(false)]
public void Effect(uint eid, EfxEffecti param, int value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | eid | Effect object identifier. |
| EfxEffecti | param | Effect property to set. |
| Int32 | value | Integer value. |
Filter(Int32, EfxFilterf, Single)
This function is used to set floating-point properties on Filter objects.
Declaration
public void Filter(int fid, EfxFilterf param, float value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | fid | Filter object identifier. |
| EfxFilterf | param | Effect property to set. |
| Single | value | Floating-point value. |
Filter(Int32, EfxFilteri, Int32)
This function is used to set integer properties on Filter objects.
Declaration
public void Filter(int fid, EfxFilteri param, int value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | fid | Filter object identifier. |
| EfxFilteri | param | Effect property to set. |
| Int32 | value | Integer value. |
Filter(UInt32, EfxFilterf, Single)
This function is used to set floating-point properties on Filter objects.
Declaration
[CLSCompliant(false)]
public void Filter(uint fid, EfxFilterf param, float value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | fid | Filter object identifier. |
| EfxFilterf | param | Effect property to set. |
| Single | value | Floating-point value. |
Filter(UInt32, EfxFilteri, Int32)
This function is used to set integer properties on Filter objects.
Declaration
[CLSCompliant(false)]
public void Filter(uint fid, EfxFilteri param, int value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | fid | Filter object identifier. |
| EfxFilteri | param | Effect property to set. |
| Int32 | value | Integer value. |
GenAuxiliaryEffectSlot()
This function generates only one Auxiliary Effect Slot.
Declaration
public int GenAuxiliaryEffectSlot()Returns
| Type | Description |
|---|---|
| Int32 | Storage Int32 for the new auxiliary effect slot name/handle. |
GenAuxiliaryEffectSlot(out UInt32)
This function generates only one Auxiliary Effect Slot.
Declaration
[CLSCompliant(false)]
public void GenAuxiliaryEffectSlot(out uint slot)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | slot |
GenAuxiliaryEffectSlots(Int32)
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.
Declaration
public int[] GenAuxiliaryEffectSlots(int n)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Auxiliary Effect Slots to be created. |
Returns
| Type | Description |
|---|---|
| Int32[] | Pointer addressing sufficient memory to store n Effect Slot object identifiers. |
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.
GenAuxiliaryEffectSlots(Int32, out Int32)
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.
Declaration
public void GenAuxiliaryEffectSlots(int n, out int slots)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Auxiliary Effect Slots to be created. |
| Int32 | slots | Pointer addressing sufficient memory to store n Effect Slot object identifiers. |
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.
GenAuxiliaryEffectSlots(Int32, out UInt32)
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.
Declaration
[CLSCompliant(false)]
public void GenAuxiliaryEffectSlots(int n, out uint slots)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Auxiliary Effect Slots to be created. |
| UInt32 | slots | Pointer addressing sufficient memory to store n Effect Slot object identifiers. |
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.
GenEffect()
Generates a single effect object.
Declaration
public int GenEffect()Returns
| Type | Description |
|---|---|
| Int32 | A handle to the generated effect object. |
Remarks
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.
GenEffect(out UInt32)
Generates a single effect object.
Declaration
[CLSCompliant(false)]
public void GenEffect(out uint effect)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | effect | A handle to the generated effect object. |
GenEffects(Int32)
Generates one or more effect objects.
Declaration
public int[] GenEffects(int n)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Effect object identifiers to generate. |
Returns
| Type | Description |
|---|---|
| Int32[] |
Remarks
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.
GenEffects(Int32, out Int32)
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
Declaration
public void GenEffects(int n, out int effects)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Effects to be created. |
| Int32 | effects | Pointer addressing sufficient memory to store n Effect object identifiers. |
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.
GenEffects(Int32, out UInt32)
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
Declaration
[CLSCompliant(false)]
public void GenEffects(int n, out uint effects)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Effects to be created. |
| UInt32 | effects | Pointer addressing sufficient memory to store n Effect object identifiers. |
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.
GenFilter()
This function generates only one Filter.
Declaration
public int GenFilter()Returns
| Type | Description |
|---|---|
| Int32 | Storage Int32 for the new filter name/handle. |
GenFilter(out UInt32)
This function generates only one Filter.
Declaration
[CLSCompliant(false)]
public void GenFilter(out uint filter)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | filter | Storage UInt32 for the new filter name/handle. |
GenFilters(Int32)
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.
Declaration
public int[] GenFilters(int n)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Filters to be created. |
Returns
| Type | Description |
|---|---|
| Int32[] | Pointer addressing sufficient memory to store n Filter object identifiers. |
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.
GenFilters(Int32, out Int32)
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.
Declaration
public void GenFilters(int n, out int filters)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Filters to be created. |
| Int32 | filters | Pointer addressing sufficient memory to store n Filter object identifiers. |
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.
GenFilters(Int32, out UInt32)
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.
Declaration
[CLSCompliant(false)]
public void GenFilters(int n, out uint filters)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | n | Number of Filters to be created. |
| UInt32 | filters | Pointer addressing sufficient memory to store n Filter object identifiers. |
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.
GetAuxiliaryEffectSlot(Int32, EfxAuxiliaryf, out Single)
This function is used to retrieve floating properties on Auxiliary Effect Slot objects.
Declaration
public void GetAuxiliaryEffectSlot(int asid, EfxAuxiliaryf pname, out float value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | asid | Auxiliary Effect Slot object identifier. |
| EfxAuxiliaryf | pname | Auxiliary Effect Slot property to retrieve. |
| Single | value | Address where floating-point value will be stored. |
GetAuxiliaryEffectSlot(Int32, EfxAuxiliaryi, out Int32)
This function is used to retrieve integer properties on Auxiliary Effect Slot objects.
Declaration
public void GetAuxiliaryEffectSlot(int asid, EfxAuxiliaryi pname, out int value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | asid | Auxiliary Effect Slot object identifier. |
| EfxAuxiliaryi | pname | Auxiliary Effect Slot property to retrieve. |
| Int32 | value | Address where integer value will be stored. |
GetAuxiliaryEffectSlot(UInt32, EfxAuxiliaryf, out Single)
This function is used to retrieve floating properties on Auxiliary Effect Slot objects.
Declaration
[CLSCompliant(false)]
public void GetAuxiliaryEffectSlot(uint asid, EfxAuxiliaryf pname, out float value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | asid | Auxiliary Effect Slot object identifier. |
| EfxAuxiliaryf | pname | Auxiliary Effect Slot property to retrieve. |
| Single | value | Address where floating-point value will be stored. |
GetAuxiliaryEffectSlot(UInt32, EfxAuxiliaryi, out Int32)
This function is used to retrieve integer properties on Auxiliary Effect Slot objects.
Declaration
[CLSCompliant(false)]
public void GetAuxiliaryEffectSlot(uint asid, EfxAuxiliaryi pname, out int value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | asid | Auxiliary Effect Slot object identifier. |
| EfxAuxiliaryi | pname | Auxiliary Effect Slot property to retrieve. |
| Int32 | value | Address where integer value will be stored. |
GetEaxFromEfxEax(ref EffectsExtension.EaxReverb, out EffectsExtension.EfxEaxReverb)
Declaration
[CLSCompliant(false)]
public static void GetEaxFromEfxEax(ref EffectsExtension.EaxReverb input, out EffectsExtension.EfxEaxReverb output)Parameters
| Type | Name | Description |
|---|---|---|
| EffectsExtension.EaxReverb | input | |
| EffectsExtension.EfxEaxReverb | output |
GetEffect(Int32, EfxEffect3f, out Vector3)
This function is used to retrieve 3 floating-point properties from Effect objects.
Declaration
public void GetEffect(int eid, EfxEffect3f param, out Vector3 values)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | eid | Effect object identifier. |
| EfxEffect3f | param | Effect property to retrieve. |
| Vector3 | values | A Math.Vector3 to hold the values. |
GetEffect(Int32, EfxEffectf, out Single)
This function is used to retrieve floating-point properties from Effect objects.
Declaration
public void GetEffect(int eid, EfxEffectf pname, out float value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | eid | Effect object identifier. |
| EfxEffectf | pname | Effect property to retrieve. |
| Single | value | Address where floating-point value will be stored. |
GetEffect(Int32, EfxEffecti, out Int32)
This function is used to retrieve integer properties from Effect objects.
Declaration
public void GetEffect(int eid, EfxEffecti pname, out int value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | eid | Effect object identifier. |
| EfxEffecti | pname | Effect property to retrieve. |
| Int32 | value | Address where integer value will be stored. |
GetEffect(UInt32, EfxEffect3f, out Vector3)
This function is used to retrieve 3 floating-point properties from Effect objects.
Declaration
[CLSCompliant(false)]
public void GetEffect(uint eid, EfxEffect3f param, out Vector3 values)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | eid | Effect object identifier. |
| EfxEffect3f | param | Effect property to retrieve. |
| Vector3 | values | A Math.Vector3 to hold the values. |
GetEffect(UInt32, EfxEffectf, out Single)
This function is used to retrieve floating-point properties from Effect objects.
Declaration
[CLSCompliant(false)]
public void GetEffect(uint eid, EfxEffectf pname, out float value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | eid | Effect object identifier. |
| EfxEffectf | pname | Effect property to retrieve. |
| Single | value | Address where floating-point value will be stored. |
GetEffect(UInt32, EfxEffecti, out Int32)
This function is used to retrieve integer properties from Effect objects.
Declaration
[CLSCompliant(false)]
public void GetEffect(uint eid, EfxEffecti pname, out int value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | eid | Effect object identifier. |
| EfxEffecti | pname | Effect property to retrieve. |
| Int32 | value | Address where integer value will be stored. |
GetFilter(Int32, EfxFilterf, out Single)
This function is used to retrieve floating-point properties from Filter objects.
Declaration
public void GetFilter(int fid, EfxFilterf pname, out float value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | fid | Filter object identifier. |
| EfxFilterf | pname | Effect property to retrieve. |
| Single | value | Address where floating-point value will be stored. |
GetFilter(Int32, EfxFilteri, out Int32)
This function is used to retrieve integer properties from Filter objects.
Declaration
public void GetFilter(int fid, EfxFilteri pname, out int value)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | fid | Filter object identifier. |
| EfxFilteri | pname | Effect property to retrieve. |
| Int32 | value | Address where integer value will be stored. |
GetFilter(UInt32, EfxFilterf, out Single)
This function is used to retrieve floating-point properties from Filter objects.
Declaration
[CLSCompliant(false)]
public void GetFilter(uint fid, EfxFilterf pname, out float value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | fid | Filter object identifier. |
| EfxFilterf | pname | Effect property to retrieve. |
| Single | value | Address where floating-point value will be stored. |
GetFilter(UInt32, EfxFilteri, out Int32)
This function is used to retrieve integer properties from Filter objects.
Declaration
[CLSCompliant(false)]
public void GetFilter(uint fid, EfxFilteri pname, out int value)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | fid | Filter object identifier. |
| EfxFilteri | pname | Effect property to retrieve. |
| Int32 | value | Address where integer value will be stored. |
IsAuxiliaryEffectSlot(Int32)
The IsAuxiliaryEffectSlot function is used to determine if an object identifier is a valid Auxiliary Effect Slot object.
Declaration
public bool IsAuxiliaryEffectSlot(int slot)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | slot | Effect Slot object identifier to validate. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the identifier is a valid Auxiliary Effect Slot, False otherwise. |
IsAuxiliaryEffectSlot(UInt32)
The IsAuxiliaryEffectSlot function is used to determine if an object identifier is a valid Auxiliary Effect Slot object.
Declaration
[CLSCompliant(false)]
public bool IsAuxiliaryEffectSlot(uint slot)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | slot | Effect Slot object identifier to validate. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the identifier is a valid Auxiliary Effect Slot, False otherwise. |
IsEffect(Int32)
The IsEffect function is used to determine if an object identifier is a valid Effect object.
Declaration
public bool IsEffect(int eid)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | eid | Effect identifier to validate. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the identifier is a valid Effect, False otherwise. |
IsEffect(UInt32)
The IsEffect function is used to determine if an object identifier is a valid Effect object.
Declaration
[CLSCompliant(false)]
public bool IsEffect(uint eid)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | eid | Effect identifier to validate. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the identifier is a valid Effect, False otherwise. |
IsFilter(Int32)
The IsFilter function is used to determine if an object identifier is a valid Filter object.
Declaration
public bool IsFilter(int fid)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | fid | Effect identifier to validate. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the identifier is a valid Filter, False otherwise. |
IsFilter(UInt32)
The IsFilter function is used to determine if an object identifier is a valid Filter object.
Declaration
[CLSCompliant(false)]
public bool IsFilter(uint fid)Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | fid | Effect identifier to validate. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the identifier is a valid Filter, False otherwise. |