| nanoseconds | The maximum time in nanoseconds to perform the garbage collection for. |
bool Returns true if additional garbage collection work remains when the method returns and false if garbage collection is complete. Also returns false if incremental garbage collection is not enabled or is not supported on the current platform.
Perform an on-demand incremental garbage collection for a maximum duration specified by the nanoseconds parameter.
If incremental garbage collection is enabled, then CollectIncremental runs the incremental garbage collector for up to the specified number of nanoseconds. The method returns when either the specified amount of time has elapsed, or there is no more garbage collection work to be done. Note that the garbage collector uses the underlying platform timer, which can have a resolution as low as a few microseconds. In other words, changing the value by a few nanoseconds might have no effect.
Use this method when you know you have a certain amount of time to wait for something to happen, and want to use this time to let the garbage collector run.
If incremental garbage collection is not enabled, this method does nothing and returns false. Enable incremental garbage collection in the PlayerSettings for a project. You can check whether incremental garbage collection is enabled with GarbageCollector.isIncremental.
If no value is specified for the nanoseconds parameter, the value defaults to 0 and no incremental garbage collection is performed.
Note: The nanoseconds parameter specifies the maximum total time for which to perform an on-demand incremental garbage collection and should not be confused with GarbageCollector.incrementalTimeSliceNanoseconds which specifies the target duration of the individual collection steps that incremental garbage collection is split across. For example, if GarbageCollector.incrementalTimeSliceNanoseconds has its default value of 3000000 nanoseconds (3 ms) and you call GarbageCollector.CollectIncremental(10000000), the garbage collector can run for a maximum of 10 ms and therefore can perform a maximum of three (but likely no more than two) 3 ms long incremental collection steps in the time available.
Additional resources: incrementalTimeSliceNanoseconds.