ApplicationListener.java

/*******************************************************************************
 * Copyright 2011 See AUTHORS file.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 ******************************************************************************/

package com.badlogic.gdx;

/**
 * <p>
 * An <code>ApplicationListener</code> is called when the {@link Application} is created, resumed, rendering, paused or
 * destroyed. All methods are called in a thread that has the OpenGL context current. You can thus safely create and
 * manipulate graphics resources.
 * </p>
 * 
 * <p>
 * The <code>ApplicationListener</code> interface follows the standard Android activity life-cycle and is emulated on
 * the desktop accordingly.
 * </p>
 * 
 * @author mzechner
 */
public interface ApplicationListener {
	/** Called when the {@link Application} is first created. */
	public void create();

	/**
	 * Called when the {@link Application} is resized. This can happen at any point during a non-paused state but will
	 * never happen before a call to {@link #create()}.
	 * 
	 * @param width
	 *            the new width in pixels
	 * @param height
	 *            the new height in pixels
	 */
	public void resize(int width, int height);

	/** Called when the {@link Application} should render itself. */
	public void render();

	/**
	 * Called when the {@link Application} is paused. An Application is paused before it is destroyed, when a user
	 * pressed the Home button on Android or an incoming call happend. On the desktop this will only be called
	 * immediately before {@link #dispose()} is called.
	 */
	public void pause();

	/**
	 * Called when the {@link Application} is resumed from a paused state. On Android this happens when the activity
	 * gets focus again. On the desktop this method will never be called.
	 */
	public void resume();

	/** Called when the {@link Application} is destroyed. Preceded by a call to {@link #pause()}. */
	public void dispose();
}