CHWRMHaptics::THWRMHapticsPeriodicEffect Struct Reference

struct CHWRMHaptics::THWRMHapticsPeriodicEffect

Defines the parameters used in a periodic effect.

Used by PlayPeriodicEffect() , ModifyPlayingPeriodicEffect() , GetPeriodicEffectDefinition() .

Member Data Documentation

TInt iAttackLevel

TInt iAttackLevel

Attack level of the effect.

The attack level is clamped to a value from KHWRMHapticsMinMagnitude to KHWRMHapticsMaxMagnitude.

TInt iAttackTime

TInt iAttackTime

Attack time of the effect. Unit is milliseconds.

The attack time is clamped to a value from 0 to the value returned by GetDeviceCapability() for the EHWRMHapticsMaxEnvelopeTime capability type.

TInt iDuration

TInt iDuration

Duration of the effect. Unit is milliseconds.

To specify an infinite duration, the effect duration should be set to InfiniteDuration() . For a finite duration, the effect duration is clamped to a value from 0 to the value returned by GetDeviceCapability() for the EHWRMHapticsMaxEffectDuration capability type.

TInt iFadeLevel

TInt iFadeLevel

Fade level of the effect.

The fade level is clamped to a value from KHWRMHapticsMinMagnitude to KHWRMHapticsMaxMagnitude.

TInt iFadeTime

TInt iFadeTime

Fade time of the effect. Unit is milliseconds.

The fade time is clamped to a value from 0 to the value returned by GetDeviceCapability() for the EHWRMHapticsMaxEnvelopeTime capability type.

TInt iMagnitude

TInt iMagnitude

Magnitude of the effect.

The effect magnitude is clamped to a value from KHWRMHapticsMinMagnitude to KHWRMHapticsMaxMagnitude.

TInt iPeriod

TInt iPeriod

Period of the effect. Unit is milliseconds.

The period is clamped to a value returned by GetDeviceCapability() for EHWRMHapticsMinPeriod capability type to the value returned by GetDeviceCapability() for the EHWRMHapticsMaxEnvelopeTime capability type.

TInt iStyle

TInt iStyle

Style of the effect.

Can be one of THWRMHapticsEffectStyles.