com.badlogic.gdx.graphics.FPSLogger Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gdx Show documentation

Android/Desktop/iOS/HTML5 game development framework

There is a newer version: 1.12.1

/*******************************************************************************
 * 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.graphics;

import com.badlogic.gdx.Gdx;
import com.badlogic.gdx.utils.TimeUtils;

/** A simple helper class to log the frames per seconds achieved. Just invoke the {@link #log()} method in your rendering method.
 * The output will be logged once per second.
 * 
 * @author mzechner */
public class FPSLogger {
	long startTime;
	int bound;

	public FPSLogger () {
		this(Integer.MAX_VALUE);
	}

	/** @param bound only logs when they frames per second are less than the bound */
	public FPSLogger (int bound) {
		this.bound = bound;
		startTime = TimeUtils.nanoTime();
	}

	/** Logs the current frames per second to the console. */
	public void log () {
		final long nanoTime = TimeUtils.nanoTime();
		if (nanoTime - startTime > 1000000000) /* 1,000,000,000ns == one second */ {
			final int fps = Gdx.graphics.getFramesPerSecond();
			if (fps < bound) {
				Gdx.app.log("FPSLogger", "fps: " + fps);
				startTime = nanoTime;
			}
		}
	}
}