Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
|
TDx_Input_Library v2.00 Component Reference
|
|
[ TDx_InputDevice::CreateEffect() ]
[ next: Destroy() ]
[ prev: Create() ]
public:
virtual HRESULT __fastcall CreateEffect( REFGUID pRefGuid, TDIEffect* pEffectData, TDx_InputEffect* pNewEffect );
TDX_INPUTDEVICE::CREATEEFFECT()
[ component method ]
- Description
The
CreateEffect()
method
will
create
and
initialize
an
effect
instance.
A
return
value
of
S_OK
will
be
generated
if
the
device
is
not
acquired
in
exclusive
mode.
This
indicates
that
the
effect
has
been
created
and
its
parameters
updated,
but
it
may
not
have
been
downloaded
to
the
device.
Error
values
that
can
be
generated
are:
DIERR_DEVICENOTREG
DIERR_DEVICEFULL
DIERR_INVALIDPARAM
DIERR_NOTINITIALIZED
- Parameters
RefGuid
The RefGuid parameter identifies the effect being created.
One of the predefined effects below or a GUID obtained from TDx_InputDevice::EnumEffects() can be used.
GUID_ConstantForce
GUID_RampForce
Periodic:
GUID_Square
GUID_Sine
GUID_Triangle
GUID_SawtoothUp
GUID_SawtoothDown
Conditions:
GUID_Spring
GUID_Damper
GUID_Inertia
GUID_Friction
User Defined:
GUID_CustomForce
EffectData
The EffectData parameter references a TDIEffect component holding the properties of the effect being created.
Set this property to NULL to create a blank effect object to be set later up using TDx_InputEffect::SetParameters().
NewEffect
The NewEffect parameter will reference the new TDx_InputEffect interface if the method returns successfully.
- See Also
- Top
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com.
|
|