creation / deletion log utility functions.
 
 
 
creation / deletion log utility functions.

Module description

This set of utility functions are useful for tracing the object creation / deletion.

It help to identify potential memory leak inside SDK plugin, or even inside MoBu for particular client workflow.

see Sctipts/Samples/Utilities/DebugMemoryLeak.py for usage example.

Functions

K_DLLIMPORT void  FBObjectLifeLogEnable (bool pEnable)
  Enable object creation / deletion logging.
K_DLLIMPORT unsigned int  FBObjectGetGlobalUniqueId ()
  Get the global static object unique ID counter.
K_DLLIMPORT void  FBObjectPrintLivings (unsigned int pStartUniqueId)
  Print those living objects created when logging is enabled.
K_DLLIMPORT unsigned int  FBObjectGetLivingCount ()
  Get current total living object count.

Function Documentation

K_DLLIMPORT void FBObjectLifeLogEnable ( bool  pEnable )

Enable object creation / deletion logging.

Default logging if off This logging may hurt performance slightly. use it only for debug purpose.

Parameters:
pEnable true to enable logging.
K_DLLIMPORT unsigned int FBObjectGetGlobalUniqueId ( )

Get the global static object unique ID counter.

Each new created object will be assigned this global unique ID. Object.UniqueID = GlobalUniqueID++

K_DLLIMPORT void FBObjectPrintLivings ( unsigned int  pStartUniqueId )

Print those living objects created when logging is enabled.

Parameters:
pStartUniqueId Any living object has been logged and with its uniqueId no less than pStartUniqueId will be printed out.
K_DLLIMPORT unsigned int FBObjectGetLivingCount ( )

Get current total living object count.