io.github.palexdev.mfxcore.enums.LoaderCacheLevel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of materialfx-all Show documentation

Material Design/Modern components for JavaFX, now packed as a single Jar

The newest version!

/*
 * Copyright (C) 2022 Parisi Alessandro - [email protected]
 * This file is part of MaterialFX (https://github.com/palexdev/MaterialFX)
 *
 * MaterialFX is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * MaterialFX is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MaterialFX. If not, see .
 */

package io.github.palexdev.mfxcore.enums;

import io.github.palexdev.mfxcore.utils.loader.MFXLoader;
import javafx.scene.Parent;
import javafx.scene.Scene;

/**
 * Enumerator to define the level of caching used by {@link MFXLoader}.
 * 
 * By enabling cache the switch performance vastly improves
 * but the views cannot be loaded in parallel (quite acceptable loss in some cases).
 */
public enum LoaderCacheLevel {
	/**
	 * No caching, may lag a little in some occasions
	 * (when the root contains a huge amount of nodes for example).
	 */
	NONE,

	/**
	 * The root node is added to a dummy pane and {@link Scene},
	 * then {@link Parent#applyCss()} and {@link Parent#layout()} are called.
	 * This causes all nodes in the scene to create their skin and layout
	 * thus "caching" the scenegraph. Vastly improves view switching performance.
	 */
	SCENE_CACHE,

	/**
	 * Does what SCENE_CACHE does, plus sets the JavaFX's properties cache to true
	 * and the cache hint to SPEED on the loaded root node.
	 * (To be honest I don't know if this truly improves performance since I didn't notice anything notable)
	 */
	SCENE_JAVAFX_CACHE
}