/*
 * 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 org.illarion.engine.backend.gdx;

import com.badlogic.gdx.graphics.Cursor;
import org.illarion.engine.MouseCursor;

import javax.annotation.Nonnull;

/**
 * This is the mouse cursor implementation for libGDX.
 * <p/>
 * Since libGDX is not able to handle the native mouse cursor this class uses LWJGL directly to show the cursor. This
 * only works properly in case the libGDX backend is used.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
class GdxCursor implements MouseCursor {
    /**
     * The actual mouse cursor of libGDX
     */
    @Nonnull
    private final Cursor gdxCursor;

    /**
     * Create a new engine mouse cursor and set the LWJGL mouse cursor that is wrapped by this class.
     *
     * @param gdxCursor the lwjgl mouse cursor
     */
    GdxCursor(@Nonnull Cursor gdxCursor) {
        this.gdxCursor = gdxCursor;
    }

    /**
     * Disposing the cursor does nothing
     */
    @Override
    public void dispose() {
    }

    /**
     * Get the internal LWJGL cursor.
     *
     * @return the LWJGL mouse cursor
     */
    @Nonnull
    Cursor getGdxCursor() {
        return gdxCursor;
    }
}