Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The SetParameters() method sets the properties of this effect.
Only one or less of the DIEP_NODOWNLOAD, DIEP_START and DIEP_NORESTART flags should be set in the Flags parameter of this method.
The effect will be automatically downloaded to the device unless the DIEP_NODOWNLOAD flag is set.
TDIEffectInfo::DynamicParams indicates which parameters may be dynamically updated while the effect is playing.
Updating an effects parameters while it is playing causes the effect to behave as if the new parameters are the ones with which it started playing.
For example : If a 10 second effect is playing, and the duration of the effect is changed to 4 seconds, the effect will stop 4 seconds after it began. If the effect has been going for more than four seconds, it will stop immediately.
Error values that can be generated are:
DIERR_NOTINITIALIZED
DIERR_INCOMPLETEEFFECT
DIERR_INPUTLOST
DIERR_INVALIDPARAM
DIERR_EFFECTPLAYING
- Parameters
Effect
The Effect parameter references a TDIEffect component for holding the effect information if this method returns successfully.
Flags
The Flags parameter defines flags indicating which properties of TDIEffect contain valid data and how that data should be applied to the device.
The described effect applies when the flag is set.
-
DIEP_AXES
TDIEffect::NumAxes and TDIEffect::Axes hold valid data.
TDIEffect::NumAxes should hold the size of the buffer referenced by TDIEffect::Axes.
DIEP_DIRECTION
TDIEffect::NumAxes and TDIEffect::Direction hold valid data.
TDIEffect::NumAxes should hold the size of the buffer referenced by TDIEffect::Direction.
One of the DIEFF_CARTESIAN, DIEFF_POLAR or DIEFF_SPHERICAL flags must be set in TDIEffect::Flags to indicate which coordinate system is being used.
DIEP_DURATION
TDIEffect::Duration holds valid data.
DIEP_ENVELOPE
The TDIEnvelope component referenced by TDIEffect::Envelope contains valid data.
Setting TDIEffect::Envelope to NULL with this flag set will detach any existing envelope from this effect.
DIEP_GAIN
TDIEffect::Gain holds valid data.
DIEP_NODOWNLOAD
The updated properties should not be downloaded to the device until TDx_InputEffect::Download() is called.
DIEP_NORESTART
If the effect is already playing, it should not be stopped and restarted in order to update its properties.
This means that if the driver doesnt support "on the fly" modifications and this flag is set, the effect parameters will not be updated and a DIERR_EFFECTPLAYING error returned.
DIEP_SAMPLEPERIOD
TDIEffect::SamplePeriod holds valid data.
DIEP_START
The effect should be started or restarted after the properties are updated.
DIEP_STARTDELAY
TDIEffect::StartDelay holds valid data.
DIEP_TRIGGERBUTTON
TDIEffect::TriggerButton holds valid data.
DIEP_TRIGGERDELAY
TDIEffect::TriggerDelay holds valid data.
DIEP_TRIGGERREPEATINTERVAL
TDIEffect::TriggerRepeatInterval holds valid data.
DIEP_TYPESPECIFICPARAMS
TDIEffect::TypeSpecificParams and TDIEffect::TypeSpecificParamsSize contain valid data.
TDIEffect::TypeSpecificParamsSize holds the size of the data referenced by TDIEffect::TypeSpecificParams.
- See Also
- Top
TDx_Input_Library v2.00 Component Reference
|
|
|
[ TDx_InputEffect::SetParameters() ] [ next: Start() ] [ prev: GetParameters() ] public:
virtual bool __fastcall SetParameters( TDIEffect* pEffect, dword pFlags );
TDX_INPUTEFFECT::SETPARAMETERS()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|