All options can be accessed and modified on Optimizer.options.
Optional _options: Partial<OptimizerOptions>Private _enabledWhether to enable or disable he optimizer.
Private _increasingPrivate _windowA function that handles the window blur event.
Private _windowA function that gets called when the window gains focus. This function does not take any parameters and does not return any value.
Private _windowIndicates whether the window is currently focused.
The timestamp indicating when the optimization process begins. Represented as the number of milliseconds elapsed since the UNIX epoch.
Whether or not the optimizer has stopped iterating and sampling the framerate.
The current optimization level or state. This value represents the current stage or level of optimization being applied.
The current priority level of the optimizer. This can be a number representing the priority or null if no priority is set.
The number of frames that have elapsed since the start of the optimization process.
The amount of time that has elapsed, in milliseconds.
The minimum priority level for the optimizer. This value determines the lowest priority task that the optimizer will consider.
A dictionary where the key is a number representing an optimization level
and the value is an array of Optimization objects associated with that level.
See OptimizerOptions for more information.
The number of frames that have been waited. This property keeps track of how many frames have passed while waiting for a certain condition or event.
The number of milliseconds that the optimizer has waited. This value is used to track the waiting time for certain operations.
Getter and setter for enabling or disabling the optimizer. Elapsed time is reset on reenable.
Getter and setter for enabling or disabling the optimizer. Elapsed time is reset on reenable.
Private _beginPrivate _endEnds the current timing iteration and records the elapsed time since begin was called.
If end is called before begin, the method will return immediately without recording any time.
This method calculates the time elapsed since begin was called using window.performance.now()
and adds the sample to the collection of recorded times.
Private _iterateIterates through the optimization process, adjusting the current priority level and applying optimizations to improve performance.
The change in priority level. Positive values increase the priority, while negative values decrease it.
A boolean indicating whether an optimization was successfully applied.
The method works by iterating through the current priority level's optimizations. If an optimization is successfully applied, the iteration stops. If no optimizations are applied at the current priority level, the priority level is adjusted by the delta value, and the process continues until the priority level is out of bounds.
If an optimization function does not return a boolean value, a warning is logged and the return value is coerced to a boolean.
Private _resetResets the internal tracking variables for the optimizer.
This method sets the following properties to their initial values:
elapsedFrames: Number of frames that have elapsed since the last reset.elapsedTime: Total time that has elapsed since the last reset.waitedFrames: Number of frames to wait before performing the next optimization, based on options.maxWaitFrames.waitedMillis: Number of milliseconds to wait before performing the next optimization, based on options.waitMillis.beginTime: The start time for the current optimization cycle, set to -1 to indicate it hasn't started yet.Adds an optimization to the optimizer with an optional priority.
The optimization to add. Can be an instance of Optimization or a function.
The priority of the optimization. Defaults to 0 if not provided.
If the optimization parameter is a function, it will be wrapped in an Optimization instance.
The priority is parsed as an integer and defaults to 0 if parsing fails.
The optimization is then added to the internal optimizations list at the specified priority.
The minPriority and maxPriority properties are updated accordingly.
Adds a sample time to the optimizer and performs optimization logic.
The time of the sample to add, in milliseconds.
This method performs the following steps:
Restarts the optimizer by resetting its state.
This method performs the following actions:
resetCheck()._increasingWork property to the value of options.increaseWork.currPriority to null.currOptimization to 0.completed to false.Generated using TypeDoc
The optimizer tracks the amount of time spent between frames or between calls to begin and end and calculates the difference between the target amount of time to spend and the actual time spent on the last frame.
After the specified amount of time has passed the average time spent is calculated and the framerate the amount of work is either increased or decreased depending on whether or not the time spent was above or below the target.
The amount of work is adjusted by iteratively calling prioritized optimizations and sampling framerate until the target work time is met.