Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The EnumEffectsInFile() method will enumerate effects stored in a file by the Force Editor utility or another application that utilizes the same file format. (RIFF)
The Force Editor is included with the DirectX sdk and can usually be found at (SDK root)\Bin\Dxutils\Fedit.exe or under DirectX 7->DX Tools on your start bar.
When enumeration is halted by the callback function, the return result is still DI_OK.
Error values that can be generated are:
DIERR_INVALIDPARAM
DIERR_NOTINITIALIZED
- Parameters
FileName
The FileName parameter defines the name of the RIFF file.
ReferenceData
The ReferenceData parameter references an application defined 32 bit value to be passed to the callback function for each enumeration.
Flags
The Flags parameter defines flags indicating which effects to include or modify while enumerating.
The described effect applies when the flag is set.
-
DIFEF_DEFAULT
This flag is equivilent to setting the parameter to 0.
DIFEF_INCLUDENONSTANDARD
Effect types that are undefined by DirectInput should also be enumerated.
DIFEF_MODIFYIFNEEDED
Modify the effects being enumerated so that they can be played on this device.
Setting this flag causes the properties of the TDIEffect component referenced by the TDIFileEffect::Effect in the callback function to be modified.
For example : An attempt to play an effect authored for a two axis device on a single axis device will fail unless this flag was set when retrieving the effect from the file.
- See Also
- Top
TDx_Input_Library v2.00 Component Reference
|
|
|
[ TDx_InputDevice::EnumEffectsInFile() ] [ next: EnumObjects() ] [ prev: EnumEffects() ] public:
virtual bool __fastcall EnumEffectsInFile( AnsiString* pFileName, void* pReferenceData, dword pFlags );
TDX_INPUTDEVICE::ENUMEFFECTSINFILE()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|