Geometry::getUserData

FMOD Studio API

Firelight Technologies FMOD Studio API

Geometry::getUserData

Retrieves the user value that that was set by calling the Geometry::setUserData function.

C++ Syntax

FMOD_RESULT Geometry::getUserData(
  void **userdata
);

C Syntax

FMOD_RESULT FMOD_Geometry_GetUserData(
  FMOD_GEOMETRY *geometry,
  void **userdata
);

C# Syntax

RESULT Geometry.getUserData(
  out IntPtr userdata
);

JavaScript Syntax

Geometry.getUserData(
  userdata                         // writes value to userdata.val
);

Parameters

userdata
Address of a pointer that receives the data specified with the Geometry::setUserData function.

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.

See Also




Version 1.10.03 Built on Feb 1, 2018