Debug_Initialize

FMOD Studio API

Firelight Technologies FMOD Studio API

Debug_Initialize

Specify the level and delivery method of log messages when using the logging version of FMOD.

C++ Syntax

FMOD_RESULT Debug_Initialize(
  FMOD_DEBUG_FLAGS flags,
  FMOD_DEBUG_MODE mode,
  FMOD_DEBUG_CALLBACK callback,
  const char *filename
);

C Syntax

FMOD_RESULT FMOD_Debug_Initialize(
  FMOD_DEBUG_FLAGS flags,
  FMOD_DEBUG_MODE mode,
  FMOD_DEBUG_CALLBACK callback,
  const char *filename
);

C# Syntax

static RESULT Debug.Initialize(
  DEBUG_FLAGS flags,
  DEBUG_MODE mode,
  DEBUG_CALLBACK callback,
  string filename
);

JavaScript Syntax

FMOD.Debug_Initialize(
  flags,
);

Parameters

flags

Mask of bits representing the desired log information. Note: LOG implies WARN and WARN implies ERROR.

mode

Destination for log messages.

callback

Callback to use when mode is set to callback, only required when using that mode.

filename

Filename to use when mode is set to file, only required when using that mode.

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 will return FMOD_ERR_UNSUPPORTED when using the non-logging (release) versions of FMOD.

The logging version of FMOD can be recognized by the 'L' suffix in the library name, fmodL.dll or libfmodL.so for instance.

See Also




Version 1.10.03 Built on Feb 1, 2018