Firelight Technologies FMOD Studio API

DSP::setUserData

Sets a user value that the DSP object will store internally. Can be retrieved with DSP::getUserData.

C++ Syntax

FMOD_RESULT DSP::setUserData(
  void *userdata
);

C Syntax

FMOD_RESULT FMOD_DSP_SetUserData(
  FMOD_DSP *dsp,
  void *userdata
);

C# Syntax

RESULT DSP.setUserData(
  IntPtr userdata
);

JavaScript Syntax

DSP.setUserData(
  userdata                         
);

Parameters

userdata

Address of user data that the user wishes stored within the DSP object.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

This function is primarily used in case the user wishes to 'attach' data to an FMOD object.

It can be useful if an FMOD callback passes an object of this type as a parameter, and the user does not know which object it is (if many of these types of objects exist). Using DSP::getUserData would help in the identification of the object.

See Also

• DSP::getUserData

Version 1.10.03 Built on Feb 1, 2018