/*
 * This file is part of the Illarion project.
 *
 * Copyright © 2015 - Illarion e.V.
 *
 * Illarion is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Illarion 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 General Public License for more details.
 */
package illarion.common.graphics;

import org.jetbrains.annotations.Contract;

/**
 * This interfaces defines the file constructs that are load by the texture loader implementations.
 *
 * @param <T> the type of the texture stored in this texture atlas
 * @author Martin Karing >nitram@illarion.org<
 */
@FunctionalInterface
public interface TextureAtlas<T> {
    /**
     * Get the texture assigned to a specified name.
     *
     * @param texture the name of the texture to look for
     * @return the texture or {@code null} in case the texture was not found in this object
     */
    @Contract(pure = true)
    T getTexture(String texture);
}