C# Class OpenTK.Audio.OpenAL.EffectsExtension

Exibir arquivo Open project: secred/Tachycardia Class Usage Examples

Public Methods

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

Private Methods

Method	Description
AuxiliaryEffectSlot ( uint asid, EfxAuxiliaryf param, float value ) : void
AuxiliaryEffectSlot ( uint asid, EfxAuxiliaryi param, int value ) : void
BindEffect ( uint eid, EfxEffectType type ) : void
BindEffectToAuxiliarySlot ( uint auxiliaryeffectslot, uint effect ) : void
BindFilterToSource ( uint source, uint filter ) : void
BindSourceToAuxiliarySlot ( uint source, uint slot, int slotnumber, uint filter ) : void
DeleteAuxiliaryEffectSlot ( uint &slot ) : void
DeleteAuxiliaryEffectSlots ( int n, uint &slots ) : void
DeleteAuxiliaryEffectSlots ( uint slots ) : void
DeleteEffect ( uint &effect ) : void
DeleteEffects ( int n, uint &effects ) : void
DeleteEffects ( uint effects ) : void
DeleteFilter ( uint &filter ) : void
DeleteFilters ( int n, uint &filters ) : void
DeleteFilters ( uint filters ) : void
Effect ( uint eid, EfxEffect3f param, Mogre &values ) : void
Effect ( uint eid, EfxEffectf param, float value ) : void
Effect ( uint eid, EfxEffecti param, int value ) : void
Filter ( uint fid, EfxFilterf param, float value ) : void
Filter ( uint fid, EfxFilteri param, int value ) : void
GenAuxiliaryEffectSlot ( uint &slot ) : void
GenAuxiliaryEffectSlots ( int n, uint &slots ) : void
GenEffect ( uint &effect ) : void
GenEffects ( int n, uint &effects ) : void
GenFilter ( uint &filter ) : void
GenFilters ( int n, uint &filters ) : void
GetAuxiliaryEffectSlot ( uint asid, EfxAuxiliaryf pname, float &value ) : void
GetAuxiliaryEffectSlot ( uint asid, EfxAuxiliaryi pname, int &value ) : void
GetEaxFromEfxEax ( EaxReverb &input, EfxEaxReverb &output ) : void
GetEffect ( uint eid, EfxEffect3f param, Mogre &values ) : void
GetEffect ( uint eid, EfxEffectf pname, float &value ) : void
GetEffect ( uint eid, EfxEffecti pname, int &value ) : void
GetFilter ( uint fid, EfxFilterf pname, float &value ) : void
GetFilter ( uint fid, EfxFilteri pname, int &value ) : void
IsAuxiliaryEffectSlot ( uint slot ) : bool
IsEffect ( uint eid ) : bool
IsFilter ( uint fid ) : bool

Method Details

AuxiliaryEffectSlot() public method

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

public AuxiliaryEffectSlot ( int asid, EfxAuxiliaryf param, float value ) : void
asid	int	Auxiliary Effect Slot object identifier.
param	EfxAuxiliaryf	Auxiliary Effect Slot property to set.
value	float	Floating-point value.
return	void

AuxiliaryEffectSlot() public method

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

public AuxiliaryEffectSlot ( int asid, EfxAuxiliaryi param, int value ) : void
asid	int	Auxiliary Effect Slot object identifier.
param	EfxAuxiliaryi	Auxiliary Effect Slot property to set.
value	int	Integer value.
return	void

BindEffect() public method

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

public BindEffect ( int eid, EfxEffectType type ) : void
eid	int	Effect id returned from a successful call to GenEffects.
type	EfxEffectType	Effect type.
return	void

BindEffectToAuxiliarySlot() public method

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

public BindEffectToAuxiliarySlot ( int auxiliaryeffectslot, int effect ) : void
auxiliaryeffectslot	int	The slot handle to attach the Effect to.
effect	int	The Effect handle that is being attached.
return	void

BindFilterToSource() public method

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

public BindFilterToSource ( int source, int filter ) : void
source	int	A valid Source handle.
filter	int	A valid Filter handle.
return	void

BindSourceToAuxiliarySlot() public method

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

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

DeleteAuxiliaryEffectSlot() public method

This function deletes one AuxiliaryEffectSlot only.

public DeleteAuxiliaryEffectSlot ( int slot ) : void
slot	int	Pointer to an auxiliary effect slot name/handle identifying the Auxiliary Effect Slot Object to be deleted.
return	void

DeleteAuxiliaryEffectSlots() public method

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

public DeleteAuxiliaryEffectSlots ( int slots ) : void
slots	int	Pointer to n Effect Slot object identifiers.
return	void

DeleteAuxiliaryEffectSlots() public method

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

public DeleteAuxiliaryEffectSlots ( int n, int &slots ) : void
n	int	Number of Auxiliary Effect Slots to be deleted.
slots	int	Pointer to n Effect Slot object identifiers.
return	void

DeleteEffect() public method

This function deletes one Effect only.

public DeleteEffect ( int effect ) : void
effect	int	Pointer to an effect name/handle identifying the Effect Object to be deleted.
return	void

DeleteEffects() public method

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

public DeleteEffects ( int effects ) : void
effects	int	Pointer to n Effect object identifiers.
return	void

DeleteEffects() public method

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

public DeleteEffects ( int n, int &effects ) : void
n	int	Number of Effects to be deleted.
effects	int	Pointer to n Effect object identifiers.
return	void

DeleteFilter() public method

This function deletes one Filter only.

public DeleteFilter ( int filter ) : void
filter	int	Pointer to an filter name/handle identifying the Filter Object to be deleted.
return	void

DeleteFilters() public method

This function deletes one Filter only.

public DeleteFilters ( int filters ) : void
filters	int	Pointer to an filter name/handle identifying the Filter Object to be deleted.
return	void

DeleteFilters() public method

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

public DeleteFilters ( int n, int &filters ) : void
n	int	Number of Filters to be deleted.
filters	int	Pointer to n Filter object identifiers.
return	void

Effect() public method

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

public Effect ( int eid, EfxEffect3f param, Mogre &values ) : void
eid	int	Effect object identifier.
param	EfxEffect3f	Effect property to set.
values	Mogre	Pointer to Math.Vector3.
return	void

Effect() public method

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

public Effect ( int eid, EfxEffectf param, float value ) : void
eid	int	Effect object identifier.
param	EfxEffectf	Effect property to set.
value	float	Floating-point value.
return	void

Effect() public method

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

public Effect ( int eid, EfxEffecti param, int value ) : void
eid	int	Effect object identifier.
param	EfxEffecti	Effect property to set.
value	int	Integer value.
return	void

EffectsExtension() public method

Constructs a new EffectsExtension instance.

public EffectsExtension ( ) : System
return	System

Filter() public method

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

public Filter ( int fid, EfxFilterf param, float value ) : void
fid	int	Filter object identifier.
param	EfxFilterf	Effect property to set.
value	float	Floating-point value.
return	void

Filter() public method

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

public Filter ( int fid, EfxFilteri param, int value ) : void
fid	int	Filter object identifier.
param	EfxFilteri	Effect property to set.
value	int	Integer value.
return	void

GenAuxiliaryEffectSlot() public method

This function generates only one Auxiliary Effect Slot.

public GenAuxiliaryEffectSlot ( ) : int
return	int

GenAuxiliaryEffectSlots() public method

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.

public GenAuxiliaryEffectSlots ( int n ) : int[]
n	int	Number of Auxiliary Effect Slots to be created.
return	int[]

GenAuxiliaryEffectSlots() public method

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.

public GenAuxiliaryEffectSlots ( int n, int &slots ) : void
n	int	Number of Auxiliary Effect Slots to be created.
slots	int	Pointer addressing sufficient memory to store n Effect Slot object identifiers.
return	void

GenEffect() public method

Generates a single 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.

public GenEffect ( ) : int
return	int

GenEffects() public method

Generates one or more effect objects.

public GenEffects ( int n ) : int[]
n	int	Number of Effect object identifiers to generate.
return	int[]

GenEffects() public method

public GenEffects ( int n, int &effects ) : void
n	int	Number of Effects to be created.
effects	int	Pointer addressing sufficient memory to store n Effect object identifiers.
return	void

GenFilter() public method

This function generates only one Filter.

public GenFilter ( ) : int
return	int

GenFilters() public method

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.

public GenFilters ( int n ) : int[]
n	int	Number of Filters to be created.
return	int[]

GenFilters() public method

public GenFilters ( int n, int &filters ) : void
n	int	Number of Filters to be created.
filters	int	Pointer addressing sufficient memory to store n Filter object identifiers.
return	void

GetAuxiliaryEffectSlot() public method

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

public GetAuxiliaryEffectSlot ( int asid, EfxAuxiliaryf pname, float &value ) : void
asid	int	Auxiliary Effect Slot object identifier.
pname	EfxAuxiliaryf	Auxiliary Effect Slot property to retrieve.
value	float	Address where floating-point value will be stored.
return	void

GetAuxiliaryEffectSlot() public method

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

public GetAuxiliaryEffectSlot ( int asid, EfxAuxiliaryi pname, int &value ) : void
asid	int	Auxiliary Effect Slot object identifier.
pname	EfxAuxiliaryi	Auxiliary Effect Slot property to retrieve.
value	int	Address where integer value will be stored.
return	void

GetEffect() public method

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

public GetEffect ( int eid, EfxEffect3f param, Mogre &values ) : void
eid	int	Effect object identifier.
param	EfxEffect3f	Effect property to retrieve.
values	Mogre	A Math.Vector3 to hold the values.
return	void

GetEffect() public method

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

public GetEffect ( int eid, EfxEffectf pname, float &value ) : void
eid	int	Effect object identifier.
pname	EfxEffectf	Effect property to retrieve.
value	float	Address where floating-point value will be stored.
return	void

GetEffect() public method

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

public GetEffect ( int eid, EfxEffecti pname, int &value ) : void
eid	int	Effect object identifier.
pname	EfxEffecti	Effect property to retrieve.
value	int	Address where integer value will be stored.
return	void

GetFilter() public method

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

public GetFilter ( int fid, EfxFilterf pname, float &value ) : void
fid	int	Filter object identifier.
pname	EfxFilterf	Effect property to retrieve.
value	float	Address where floating-point value will be stored.
return	void

GetFilter() public method

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

public GetFilter ( int fid, EfxFilteri pname, int &value ) : void
fid	int	Filter object identifier.
pname	EfxFilteri	Effect property to retrieve.
value	int	Address where integer value will be stored.
return	void

IsAuxiliaryEffectSlot() public method

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

public IsAuxiliaryEffectSlot ( int slot ) : bool
slot	int	Effect Slot object identifier to validate.
return	bool

IsEffect() public method

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

public IsEffect ( int eid ) : bool
eid	int	Effect identifier to validate.
return	bool

IsFilter() public method

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

public IsFilter ( int fid ) : bool
fid	int	Effect identifier to validate.
return	bool