Show / Hide Table of Contents

Class ALC.EFX

Exposes the functions of the Effects Extension.

Inheritance
object
ALBase
ALC.EFX
Inherited Members
ALBase.RegisterOpenALResolver()
ALBase.LoadDelegate<TDelegate>(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: OpenTK.Audio.OpenAL
Assembly: OpenTK.Audio.OpenAL.dll
Syntax
public class ALC.EFX : ALBase

Fields

ExtensionName

The EFX extension name.

Declaration
public const string ExtensionName = "ALC_EXT_EFX"
Field Value
Type Description
string

Methods

AuxiliaryEffectSlot(int, EffectSlotBoolean, bool)

Sets the value of a named property on the given effect slot.

Declaration
public static void AuxiliaryEffectSlot(int slot, EffectSlotBoolean param, bool value)
Parameters
Type Name Description
int slot

The slot.

EffectSlotBoolean param

The named property.

bool value

The value to set the property to.

AuxiliaryEffectSlot(int, EffectSlotFloat, float)

Sets the value of a named property on the given effect slot.

Declaration
public static void AuxiliaryEffectSlot(int slot, EffectSlotFloat param, float value)
Parameters
Type Name Description
int slot

The slot.

EffectSlotFloat param

The named property.

float value

The value to set the property to.

AuxiliaryEffectSlot(int, EffectSlotInteger, int)

Sets the value of a named property on the given effect slot.

Declaration
public static void AuxiliaryEffectSlot(int slot, EffectSlotInteger param, int value)
Parameters
Type Name Description
int slot

The slot.

EffectSlotInteger param

The named property.

int value

The value to set the property to.

DeleteAuxiliaryEffectSlot(int)

Deletes and frees resources used an auxiliary effect slot.

Declaration
public static void DeleteAuxiliaryEffectSlot(int slot)
Parameters
Type Name Description
int slot

The slot to delete.

See Also
GenAuxiliaryEffectSlot()
IsAuxiliaryEffectSlot(int)

DeleteAuxiliaryEffectSlots(int, int[])

Deletes and frees resources used for a set of auxiliary effect slots.

Declaration
public static void DeleteAuxiliaryEffectSlots(int count, int[] slots)
Parameters
Type Name Description
int count

The number of slots to delete.

int[] slots

A pointer to the array of slots to delete.

See Also
GenAuxiliaryEffectSlots(int, int[])
IsAuxiliaryEffectSlot(int)

DeleteAuxiliaryEffectSlots(int, ref int)

Deletes and frees resources used for a set of auxiliary effect slots.

Declaration
public static void DeleteAuxiliaryEffectSlots(int count, ref int slots)
Parameters
Type Name Description
int count

The number of slots to delete.

int slots

A pointer to the array of slots to delete.

See Also
GenAuxiliaryEffectSlots(int, ref int)
IsAuxiliaryEffectSlot(int)

DeleteAuxiliaryEffectSlots(int, int*)

Deletes and frees resources used for a set of auxiliary effect slots.

Declaration
public static void DeleteAuxiliaryEffectSlots(int count, int* slots)
Parameters
Type Name Description
int count

The number of slots to delete.

int* slots

A pointer to the array of slots to delete.

See Also
GenAuxiliaryEffectSlots(int, int*)
IsAuxiliaryEffectSlot(int)

DeleteAuxiliaryEffectSlots(int[])

Deletes and frees resources used for a set of auxiliary effect slots.

Declaration
public static void DeleteAuxiliaryEffectSlots(int[] slots)
Parameters
Type Name Description
int[] slots

An array of slots to delete.

See Also
GenAuxiliaryEffectSlots(int)
IsAuxiliaryEffectSlot(int)

DeleteEffect(int)

Deletes and frees resources used an effect.

Declaration
public static void DeleteEffect(int effect)
Parameters
Type Name Description
int effect

The effect to delete.

See Also
GenEffect()
IsEffect(int)

DeleteEffects(int, int[])

Deletes one or more effect objects, freeing their resources.

Declaration
public static void DeleteEffects(int count, int[] effects)
Parameters
Type Name Description
int count

The number of objects to delete.

int[] effects

A pointer to the first element of the array where the handles are stored.

See Also
GenEffects(int, int[])
IsEffect(int)

DeleteEffects(int, ref int)

Deletes one or more effect objects, freeing their resources.

Declaration
public static void DeleteEffects(int count, ref int effects)
Parameters
Type Name Description
int count

The number of objects to delete.

int effects

A pointer to the first element of the array where the handles are stored.

See Also
GenEffects(int, ref int)
IsEffect(int)

DeleteEffects(int, int*)

Deletes one or more effect objects, freeing their resources.

Declaration
public static void DeleteEffects(int count, int* effects)
Parameters
Type Name Description
int count

The number of objects to delete.

int* effects

A pointer to the first element of the array where the handles are stored.

See Also
GenEffects(int, int*)
IsEffect(int)

DeleteEffects(int[])

Deletes and frees resources used for a set of effects.

Declaration
public static void DeleteEffects(int[] effects)
Parameters
Type Name Description
int[] effects

An array of effects to delete.

See Also
GenEffects(int)
IsEffect(int)

DeleteFilter(int)

Deletes and frees resources used an filter.

Declaration
public static void DeleteFilter(int filter)
Parameters
Type Name Description
int filter

The filter to delete.

See Also
GenFilter()
IsFilter(int)

DeleteFilters(int, int[])

Deletes one or more filter objects, freeing their resources.

Declaration
public static void DeleteFilters(int count, int[] filters)
Parameters
Type Name Description
int count

The number of objects to delete.

int[] filters

A pointer to the first element of the array where the handles are stored.

See Also
GenFilters(int, int[])
IsFilter(int)

DeleteFilters(int, ref int)

Deletes one or more filter objects, freeing their resources.

Declaration
public static void DeleteFilters(int count, ref int filters)
Parameters
Type Name Description
int count

The number of objects to delete.

int filters

A pointer to the first element of the array where the handles are stored.

See Also
GenFilters(int, ref int)
IsFilter(int)

DeleteFilters(int, int*)

Deletes one or more filter objects, freeing their resources.

Declaration
public static void DeleteFilters(int count, int* filters)
Parameters
Type Name Description
int count

The number of objects to delete.

int* filters

A pointer to the first element of the array where the handles are stored.

See Also
GenFilters(int, int*)
IsFilter(int)

DeleteFilters(int[])

Deletes and frees resources used for a set of filters.

Declaration
public static void DeleteFilters(int[] filters)
Parameters
Type Name Description
int[] filters

An array of filters to delete.

See Also
GenFilters(int)
IsFilter(int)

Effect(int, EffectFloat, float)

Sets the value of a named property on the given effect.

Declaration
public static void Effect(int effect, EffectFloat param, float value)
Parameters
Type Name Description
int effect

The effect.

EffectFloat param

The named property.

float value

The value to set the property to.

Effect(int, EffectInteger, int)

Sets the value of a named property on the given effect.

Declaration
public static void Effect(int effect, EffectInteger param, int value)
Parameters
Type Name Description
int effect

The effect.

EffectInteger param

The named property.

int value

The value to set the property to.

Effect(int, EffectVector3, ref Vector3)

Sets the vector value of a named property on the given effect.

Declaration
public static void Effect(int effect, EffectVector3 param, ref Vector3 value)
Parameters
Type Name Description
int effect

The effect.

EffectVector3 param

The named property.

Vector3 value

The value to set the property to.

Effect(int, EffectVector3, float[])

Sets the vector value of a named property on the given effect.

Declaration
public static void Effect(int effect, EffectVector3 param, float[] value)
Parameters
Type Name Description
int effect

The effect.

EffectVector3 param

The named property.

float[] value

The value to set the property to.

Effect(int, EffectVector3, ref float)

Sets the vector value of a named property on the given effect.

Declaration
public static void Effect(int effect, EffectVector3 param, ref float value)
Parameters
Type Name Description
int effect

The effect.

EffectVector3 param

The named property.

float value

The value to set the property to.

Effect(int, EffectVector3, float*)

Sets the vector value of a named property on the given effect.

Declaration
public static void Effect(int effect, EffectVector3 param, float* value)
Parameters
Type Name Description
int effect

The effect.

EffectVector3 param

The named property.

float* value

The value to set the property to.

Filter(int, FilterFloat, float)

Sets the value of a named property on the given filter.

Declaration
public static void Filter(int filter, FilterFloat param, float value)
Parameters
Type Name Description
int filter

The filter.

FilterFloat param

The named property.

float value

The value to set the property to.

Filter(int, FilterInteger, int)

Sets the value of a named property on the given filter.

Declaration
public static void Filter(int filter, FilterInteger param, int value)
Parameters
Type Name Description
int filter

The filter.

FilterInteger param

The named property.

int value

The value to set the property to.

GenAuxiliaryEffectSlot()

Creates an auxiliary effect slot.

Declaration
public static int GenAuxiliaryEffectSlot()
Returns
Type Description
int

The slot.

See Also
DeleteAuxiliaryEffectSlot(int)
IsAuxiliaryEffectSlot(int)

GenAuxiliaryEffectSlot(out int)

Creates an auxiliary effect slot.

Declaration
public static void GenAuxiliaryEffectSlot(out int slot)
Parameters
Type Name Description
int slot

The generated slot.

See Also
DeleteAuxiliaryEffectSlot(int)
IsAuxiliaryEffectSlot(int)

GenAuxiliaryEffectSlots(int, int[])

Creates one or more auxiliary effect slots.

Declaration
public static void GenAuxiliaryEffectSlots(int count, int[] slots)
Parameters
Type Name Description
int count

The number of slots to create.

int[] slots

The first element of the array to place the slots into.

See Also
DeleteAuxiliaryEffectSlots(int, int[])
IsAuxiliaryEffectSlot(int)

GenAuxiliaryEffectSlots(int, ref int)

Creates one or more auxiliary effect slots.

Declaration
public static void GenAuxiliaryEffectSlots(int count, ref int slots)
Parameters
Type Name Description
int count

The number of slots to create.

int slots

The first element of the array to place the slots into.

See Also
DeleteAuxiliaryEffectSlots(int, ref int)
IsAuxiliaryEffectSlot(int)

GenAuxiliaryEffectSlots(int, int*)

Creates one or more auxiliary effect slots.

Declaration
public static void GenAuxiliaryEffectSlots(int count, int* slots)
Parameters
Type Name Description
int count

The number of slots to create.

int* slots

The first element of the array to place the slots into.

See Also
DeleteAuxiliaryEffectSlots(int, int*)
IsAuxiliaryEffectSlot(int)

GenAuxiliaryEffectSlots(int)

Creates one or more auxiliary effect slots.

Declaration
public static int[] GenAuxiliaryEffectSlots(int count)
Parameters
Type Name Description
int count

The number of slots to create.

Returns
Type Description
int[]

The slots.

See Also
DeleteAuxiliaryEffectSlots(int[])
IsAuxiliaryEffectSlot(int)

GenAuxiliaryEffectSlots(int[])

Creates one or more auxiliary effect slots.

Declaration
public static void GenAuxiliaryEffectSlots(int[] slots)
Parameters
Type Name Description
int[] slots

An array to fill with created slots.

See Also
DeleteAuxiliaryEffectSlots(int[])
IsAuxiliaryEffectSlot(int)

GenEffect()

Creates an effect.

Declaration
public static int GenEffect()
Returns
Type Description
int

The effect.

See Also
DeleteEffect(int)
IsEffect(int)

GenEffect(out int)

Creates an effect.

Declaration
public static void GenEffect(out int effect)
Parameters
Type Name Description
int effect

The effect.

See Also
DeleteEffect(int)
IsEffect(int)

GenEffects(int, int[])

Creates one or more effect objects.

Declaration
public static void GenEffects(int count, int[] effects)
Parameters
Type Name Description
int count

The number of objects to generate.

int[] effects

A pointer to the first element of the array where the handles will be stored.

See Also
DeleteEffects(int, int[])
IsEffect(int)

GenEffects(int, ref int)

Creates one or more effect objects.

Declaration
public static void GenEffects(int count, ref int effects)
Parameters
Type Name Description
int count

The number of objects to generate.

int effects

A pointer to the first element of the array where the handles will be stored.

See Also
DeleteEffects(int, ref int)
IsEffect(int)

GenEffects(int, int*)

Creates one or more effect objects.

Declaration
public static void GenEffects(int count, int* effects)
Parameters
Type Name Description
int count

The number of objects to generate.

int* effects

A pointer to the first element of the array where the handles will be stored.

See Also
DeleteEffects(int, int*)
IsEffect(int)

GenEffects(int)

Creates one or more effects.

Declaration
public static int[] GenEffects(int count)
Parameters
Type Name Description
int count

The number of effects to create.

Returns
Type Description
int[]

The effects.

See Also
DeleteEffects(int[])
IsEffect(int)

GenEffects(int[])

Creates one or more effects.

Declaration
public static void GenEffects(int[] effects)
Parameters
Type Name Description
int[] effects

An arrays to fill with the generated effects.

See Also
DeleteEffects(int[])
IsEffect(int)

GenFilter()

Creates an filter.

Declaration
public static int GenFilter()
Returns
Type Description
int

The filter.

See Also
DeleteFilter(int)
IsFilter(int)

GenFilter(out int)

Creates an filter.

Declaration
public static void GenFilter(out int filter)
Parameters
Type Name Description
int filter

The filter.

See Also
DeleteFilter(int)
IsFilter(int)

GenFilters(int, int[])

Creates one or more filter objects.

Declaration
public static void GenFilters(int count, int[] filters)
Parameters
Type Name Description
int count

The number of objects to generate.

int[] filters

A pointer to the first element of the array where the handles will be stored.

See Also
DeleteFilters(int, int[])
IsFilter(int)

GenFilters(int, ref int)

Creates one or more filter objects.

Declaration
public static void GenFilters(int count, ref int filters)
Parameters
Type Name Description
int count

The number of objects to generate.

int filters

A pointer to the first element of the array where the handles will be stored.

See Also
DeleteFilters(int, ref int)
IsFilter(int)

GenFilters(int, int*)

Creates one or more filter objects.

Declaration
public static void GenFilters(int count, int* filters)
Parameters
Type Name Description
int count

The number of objects to generate.

int* filters

A pointer to the first element of the array where the handles will be stored.

See Also
DeleteFilters(int, int*)
IsFilter(int)

GenFilters(int)

Creates one or more filters.

Declaration
public static int[] GenFilters(int count)
Parameters
Type Name Description
int count

The number of filters to create.

Returns
Type Description
int[]

The filters.

See Also
DeleteFilters(int[])
IsFilter(int)

GenFilters(int[])

Creates one or more filters.

Declaration
public static void GenFilters(int[] filters)
Parameters
Type Name Description
int[] filters

An array to fill with the generated filters.

See Also
DeleteFilters(int[])
IsFilter(int)

GetAuxiliaryEffectSlot(int, EffectSlotFloat, out float)

Gets the value of a named property on the given effect slot.

Declaration
public static void GetAuxiliaryEffectSlot(int slot, EffectSlotFloat param, out float value)
Parameters
Type Name Description
int slot

The slot.

EffectSlotFloat param

The named property.

float value

The value.

GetAuxiliaryEffectSlot(int, EffectSlotFloat, float*)

Gets the value of a named property on the given effect slot.

Declaration
public static void GetAuxiliaryEffectSlot(int slot, EffectSlotFloat param, float* value)
Parameters
Type Name Description
int slot

The slot.

EffectSlotFloat param

The named property.

float* value

The value.

GetAuxiliaryEffectSlot(int, EffectSlotFloat)

Gets the value of a named property on the given effect slot.

Declaration
public static float GetAuxiliaryEffectSlot(int slot, EffectSlotFloat param)
Parameters
Type Name Description
int slot

The slot.

EffectSlotFloat param

The named property.

Returns
Type Description
float

The value.

GetAuxiliaryEffectSlot(int, EffectSlotInteger, out int)

Gets the value of a named property on the given effect slot.

Declaration
public static void GetAuxiliaryEffectSlot(int slot, EffectSlotInteger param, out int value)
Parameters
Type Name Description
int slot

The slot.

EffectSlotInteger param

The named property.

int value

The value.

GetAuxiliaryEffectSlot(int, EffectSlotInteger, int*)

Gets the value of a named property on the given effect slot.

Declaration
public static void GetAuxiliaryEffectSlot(int slot, EffectSlotInteger param, int* value)
Parameters
Type Name Description
int slot

The slot.

EffectSlotInteger param

The named property.

int* value

The value.

GetAuxiliaryEffectSlot(int, EffectSlotInteger)

Gets the value of a named property on the given effect slot.

Declaration
public static int GetAuxiliaryEffectSlot(int slot, EffectSlotInteger param)
Parameters
Type Name Description
int slot

The slot.

EffectSlotInteger param

The named property.

Returns
Type Description
int

The value.

GetEffect(int, EffectFloat, out float)

Gets the value of a named property on the given effect.

Declaration
public static void GetEffect(int effect, EffectFloat param, out float value)
Parameters
Type Name Description
int effect

The effect.

EffectFloat param

The named property.

float value

The value to set the property to.

GetEffect(int, EffectFloat, float*)

Gets the value of a named property on the given effect.

Declaration
public static void GetEffect(int effect, EffectFloat param, float* value)
Parameters
Type Name Description
int effect

The effect.

EffectFloat param

The named property.

float* value

The value to set the property to.

GetEffect(int, EffectFloat)

Gets the value of a named property on the given effect.

Declaration
public static float GetEffect(int effect, EffectFloat param)
Parameters
Type Name Description
int effect

The effect.

EffectFloat param

The named property.

Returns
Type Description
float

The value.

GetEffect(int, EffectInteger, out int)

Gets the value of a named property on the given effect.

Declaration
public static void GetEffect(int effect, EffectInteger param, out int value)
Parameters
Type Name Description
int effect

The effect.

EffectInteger param

The named property.

int value

The value to set the property to.

GetEffect(int, EffectInteger, int*)

Gets the value of a named property on the given effect.

Declaration
public static void GetEffect(int effect, EffectInteger param, int* value)
Parameters
Type Name Description
int effect

The effect.

EffectInteger param

The named property.

int* value

The value to set the property to.

GetEffect(int, EffectInteger)

Gets the value of a named property on the given effect.

Declaration
public static int GetEffect(int effect, EffectInteger param)
Parameters
Type Name Description
int effect

The effect.

EffectInteger param

The named property.

Returns
Type Description
int

The value.

GetEffect(int, EffectVector3, out Vector3)

Gets the vector value of a named property on the given effect.

Declaration
public static void GetEffect(int effect, EffectVector3 param, out Vector3 value)
Parameters
Type Name Description
int effect

The effect.

EffectVector3 param

The named property.

Vector3 value

The value to set the property to.

GetEffect(int, EffectVector3, out float)

Gets the vector value of a named property on the given effect.

Declaration
public static void GetEffect(int effect, EffectVector3 param, out float value)
Parameters
Type Name Description
int effect

The effect.

EffectVector3 param

The named property.

float value

The value to set the property to.

GetEffect(int, EffectVector3, float*)

Gets the vector value of a named property on the given effect.

Declaration
public static void GetEffect(int effect, EffectVector3 param, float* value)
Parameters
Type Name Description
int effect

The effect.

EffectVector3 param

The named property.

float* value

The value to set the property to.

GetEffect(int, EffectVector3)

Gets the value of a named property on the given effect.

Declaration
public static Vector3 GetEffect(int effect, EffectVector3 param)
Parameters
Type Name Description
int effect

The effect.

EffectVector3 param

The named property.

Returns
Type Description
Vector3

The value.

GetEFXMajorVersion(ALDevice)

Gets the major version of the Effect Extension.

Declaration
public int GetEFXMajorVersion(ALDevice device)
Parameters
Type Name Description
ALDevice device

The device that the context is on.

Returns
Type Description
int

The major version.

GetEFXMinorVersion(ALDevice)

Gets the minor version of the Effect Extension.

Declaration
public int GetEFXMinorVersion(ALDevice device)
Parameters
Type Name Description
ALDevice device

The device that the context is on.

Returns
Type Description
int

The minor version.

GetEFXVersion(ALDevice)

Gets the version of the Effect Extension.

Declaration
public Version GetEFXVersion(ALDevice device)
Parameters
Type Name Description
ALDevice device

The device that the context is on.

Returns
Type Description
Version

The version.

GetFilter(int, FilterFloat, out float)

Gets the value of a named property on the given filter.

Declaration
public static void GetFilter(int filter, FilterFloat param, out float value)
Parameters
Type Name Description
int filter

The filter.

FilterFloat param

The named property.

float value

The value to set the property to.

GetFilter(int, FilterFloat, float*)

Gets the value of a named property on the given filter.

Declaration
public static void GetFilter(int filter, FilterFloat param, float* value)
Parameters
Type Name Description
int filter

The filter.

FilterFloat param

The named property.

float* value

The value to set the property to.

GetFilter(int, FilterFloat)

Gets the value of a named property on the given filter.

Declaration
public static float GetFilter(int filter, FilterFloat param)
Parameters
Type Name Description
int filter

The filter.

FilterFloat param

The named property.

Returns
Type Description
float

The value.

GetFilter(int, FilterInteger, out int)

Gets the value of a named property on the given filter.

Declaration
public static void GetFilter(int filter, FilterInteger param, out int value)
Parameters
Type Name Description
int filter

The filter.

FilterInteger param

The named property.

int value

The value to set the property to.

GetFilter(int, FilterInteger, int*)

Gets the value of a named property on the given filter.

Declaration
public static void GetFilter(int filter, FilterInteger param, int* value)
Parameters
Type Name Description
int filter

The filter.

FilterInteger param

The named property.

int* value

The value to set the property to.

GetFilter(int, FilterInteger)

Gets the value of a named property on the given filter.

Declaration
public static int GetFilter(int filter, FilterInteger param)
Parameters
Type Name Description
int filter

The filter.

FilterInteger param

The named property.

Returns
Type Description
int

The value.

GetInteger(ALDevice, EFXContextInteger, int, int[])

Gets a vector of integer properties from the context.

Declaration
public static extern void GetInteger(ALDevice device, EFXContextInteger param, int size, int[] data)
Parameters
Type Name Description
ALDevice device

The audio device.

EFXContextInteger param

The named property.

int size

The size of the provided buffer.

int[] data

A pointer to the first element of a provided data buffer.

GetInteger(ALDevice, EFXContextInteger, int, ref int)

Gets a vector of integer properties from the context.

Declaration
public static extern void GetInteger(ALDevice device, EFXContextInteger param, int size, ref int data)
Parameters
Type Name Description
ALDevice device

The audio device.

EFXContextInteger param

The named property.

int size

The size of the provided buffer.

int data

A pointer to the first element of a provided data buffer.

GetInteger(ALDevice, EFXContextInteger, int, int*)

Gets a vector of integer properties from the context.

Declaration
public static extern void GetInteger(ALDevice device, EFXContextInteger param, int size, int* data)
Parameters
Type Name Description
ALDevice device

The audio device.

EFXContextInteger param

The named property.

int size

The size of the provided buffer.

int* data

A pointer to the first element of a provided data buffer.

GetInteger(ALDevice, EFXContextInteger, int[])

Gets a vector of integer properties from the context.

Declaration
public static void GetInteger(ALDevice device, EFXContextInteger param, int[] data)
Parameters
Type Name Description
ALDevice device

The audio device.

EFXContextInteger param

The named property.

int[] data

A provided data buffer.

GetListener(int, EFXListenerFloat, out float)

Gets the value of a named property on the given listener.

Declaration
public static void GetListener(int listener, EFXListenerFloat param, out float value)
Parameters
Type Name Description
int listener

The listener.

EFXListenerFloat param

The named property.

float value

The value to set the property to.

GetListener(int, EFXListenerFloat, float*)

Gets the value of a named property on the given listener.

Declaration
public static void GetListener(int listener, EFXListenerFloat param, float* value)
Parameters
Type Name Description
int listener

The listener.

EFXListenerFloat param

The named property.

float* value

The value to set the property to.

GetListener(int, EFXListenerFloat)

Gets the value of a named property on the given listener.

Declaration
public static float GetListener(int listener, EFXListenerFloat param)
Parameters
Type Name Description
int listener

The listener.

EFXListenerFloat param

The named property.

Returns
Type Description
float

The value of the property.

GetSource(int, EFXSourceBoolean, out bool)

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceBoolean param, out bool value)
Parameters
Type Name Description
int source

The source.

EFXSourceBoolean param

The named property.

bool value

The value to set the property to.

GetSource(int, EFXSourceBoolean, bool*)

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceBoolean param, bool* value)
Parameters
Type Name Description
int source

The source.

EFXSourceBoolean param

The named property.

bool* value

The value to set the property to.

GetSource(int, EFXSourceBoolean)

Gets the value of a named property on the given source.

Declaration
public static bool GetSource(int source, EFXSourceBoolean param)
Parameters
Type Name Description
int source

The source.

EFXSourceBoolean param

The named property.

Returns
Type Description
bool

The value.

GetSource(int, EFXSourceFloat, out float)

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceFloat param, out float value)
Parameters
Type Name Description
int source

The source.

EFXSourceFloat param

The named property.

float value

The value to set the property to.

GetSource(int, EFXSourceFloat, float*)

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceFloat param, float* value)
Parameters
Type Name Description
int source

The source.

EFXSourceFloat param

The named property.

float* value

The value to set the property to.

GetSource(int, EFXSourceFloat)

Gets the value of a named property on the given source.

Declaration
public static float GetSource(int source, EFXSourceFloat param)
Parameters
Type Name Description
int source

The source.

EFXSourceFloat param

The named property.

Returns
Type Description
float

The value.

GetSource(int, EFXSourceInteger, out int)

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceInteger param, out int value)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger param

The named property.

int value

The value to set the property to.

GetSource(int, EFXSourceInteger, int*)

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceInteger param, int* value)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger param

The named property.

int* value

The value to set the property to.

GetSource(int, EFXSourceInteger)

Gets the value of a named property on the given source.

Declaration
public static int GetSource(int source, EFXSourceInteger param)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger param

The named property.

Returns
Type Description
int

The value.

GetSource(int, EFXSourceInteger3, int[])

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceInteger3 param, int[] value)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger3 param

The named property.

int[] value

The value to set the property to.

GetSource(int, EFXSourceInteger3, out int, out int, out int)

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceInteger3 param, out int value1, out int value2, out int value3)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger3 param

The named property.

int value1

The first value to set the property to.

int value2

The second value to set the property to.

int value3

The third value to set the property to.

GetSource(int, EFXSourceInteger3, ref int)

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceInteger3 param, ref int value)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger3 param

The named property.

int value

The value to set the property to.

GetSource(int, EFXSourceInteger3, int*, int*, int*)

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceInteger3 param, int* value1, int* value2, int* value3)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger3 param

The named property.

int* value1

The first value to set the property to.

int* value2

The second value to set the property to.

int* value3

The third value to set the property to.

GetSource(int, EFXSourceInteger3, int*)

Gets the value of a named property on the given source.

Declaration
public static void GetSource(int source, EFXSourceInteger3 param, int* value)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger3 param

The named property.

int* value

The value to set the property to.

IsAuxiliaryEffectSlot(int)

Determines whether or not the given handle is an auxiliary slot handle.

Declaration
public static bool IsAuxiliaryEffectSlot(int slot)
Parameters
Type Name Description
int slot

The handle.

Returns
Type Description
bool

true if the handle is a slot handle; otherwise, false.

IsEffect(int)

Determines whether or not a given handle is an effect handle.

Declaration
public static bool IsEffect(int effect)
Parameters
Type Name Description
int effect

The handle.

Returns
Type Description
bool

true if the handle is an effect handle; otherwise, false.

See Also
GenEffects(int[])
DeleteEffects(int[])

IsExtensionPresent(ALDevice)

Checks if this extension is present.

Declaration
public static bool IsExtensionPresent(ALDevice device)
Parameters
Type Name Description
ALDevice device

The device to query.

Returns
Type Description
bool

Whether the extension was present or not.

IsFilter(int)

Determines whether or not a given handle is an filter handle.

Declaration
public static bool IsFilter(int filter)
Parameters
Type Name Description
int filter

The handle.

Returns
Type Description
bool

true if the handle is an filter handle; otherwise, false.

See Also
GenFilters(int)
DeleteFilters(int[])

Listener(int, EFXListenerFloat, float)

Sets the value of a named property on the given listener.

Declaration
public static void Listener(int listener, EFXListenerFloat param, float value)
Parameters
Type Name Description
int listener

The listener.

EFXListenerFloat param

The named property.

float value

The value to set the property to.

Source(int, EFXSourceBoolean, bool)

Sets the value of a named property on the given source.

Declaration
public static void Source(int source, EFXSourceBoolean param, bool value)
Parameters
Type Name Description
int source

The source.

EFXSourceBoolean param

The named property.

bool value

The value to set the property to.

Source(int, EFXSourceFloat, float)

Sets the value of a named property on the given source.

Declaration
public static void Source(int source, EFXSourceFloat param, float value)
Parameters
Type Name Description
int source

The source.

EFXSourceFloat param

The named property.

float value

The value to set the property to.

Source(int, EFXSourceInteger, int)

Sets the value of a named property on the given source.

Declaration
public static void Source(int source, EFXSourceInteger param, int value)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger param

The named property.

int value

The value to set the property to.

Source(int, EFXSourceInteger3, int, int, int)

Sets the value of a named property on the given source.

Declaration
public static void Source(int source, EFXSourceInteger3 param, int value1, int value2, int value3)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger3 param

The named property.

int value1

The first value to set the property to.

int value2

The second value to set the property to.

int value3

The third value to set the property to.

Source(int, EFXSourceInteger3, int[])

Sets the value of a named property on the given source.

Declaration
public static void Source(int source, EFXSourceInteger3 param, int[] value)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger3 param

The named property.

int[] value

The value to set the property to.

Source(int, EFXSourceInteger3, ref int)

Sets the value of a named property on the given source.

Declaration
public static void Source(int source, EFXSourceInteger3 param, ref int value)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger3 param

The named property.

int value

The value to set the property to.

Source(int, EFXSourceInteger3, int*)

Sets the value of a named property on the given source.

Declaration
public static void Source(int source, EFXSourceInteger3 param, int* value)
Parameters
Type Name Description
int source

The source.

EFXSourceInteger3 param

The named property.

int* value

The value to set the property to.

In This Article
Back to top Generated by DocFX