/*
 * This file is part of the Illarion project.
 *
 * Copyright © 2014 - 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 org.illarion.engine.graphic.effects;

import org.illarion.engine.graphic.Color;

import javax.annotation.Nonnull;

/**
 * This effect is used to render the light on a texture.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
public interface TileLightEffect extends TextureEffect {
    /**
     * Set the color of the tile top left of the rendered tile.
     *
     * @param color the color of the tile
     */
    void setTopLeftColor(@Nonnull Color color);

    /**
     * Set the color of the tile top right of the rendered tile.
     *
     * @param color the color of the tile
     */
    void setTopRightColor(@Nonnull Color color);

    /**
     * Set the color of the tile bottom left of the rendered tile.
     *
     * @param color the color of the tile
     */
    void setBottomLeftColor(@Nonnull Color color);

    /**
     * Set the color of the tile bottom right of the rendered tile.
     *
     * @param color the color of the tile
     */
    void setBottomRightColor(@Nonnull Color color);

    /**
     * Set the color of the tile top of the rendered tile.
     *
     * @param color the color of the tile
     */
    void setTopColor(@Nonnull Color color);

    /**
     * Set the color of the tile bottom of the rendered tile.
     *
     * @param color the color of the tile
     */
    void setBottomColor(@Nonnull Color color);

    /**
     * Set the color of the tile left of the rendered tile.
     *
     * @param color the color of the tile
     */
    void setLeftColor(@Nonnull Color color);

    /**
     * Set the color of the tile right of the rendered tile.
     *
     * @param color the color of the tile
     */
    void setRightColor(@Nonnull Color color);

    /**
     * Set the color in the center of the rendered tile.
     *
     * @param color the color of the tile
     */
    void setCenterColor(@Nonnull Color color);
}