Changed license to Creative Commons Zero (CC0).
[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / gui / ViewRenderListener.java
1 /*
2  * Sixth 3D engine. Author: Svjatoslav Agejenko. 
3  * This project is released under Creative Commons Zero (CC0) license.
4  *
5 *
6  */
7
8 package eu.svjatoslav.sixth.e3d.gui;
9
10 public interface ViewRenderListener {
11
12     /**
13      * Notifies that it is about time to render next frame and
14      * allows listener to do any related processing that it needs to.
15      * <p>
16      * Each {@link ViewRenderListener} will be notified exactly once before every frame is rendered.
17      * <p>
18      * {@link ViewRenderListener} can determine if frame repaint is actually
19      * needed from its perspective. Frame will be rendered only if at least one listener says yes.
20      *
21      * @return <code>true</code> if underlying view shall be re-rendered. If at least one of the view update listeners
22      * returns <code>true</code>, view is re-rendered.
23      */
24     boolean beforeRender(ViewPanel viewPanel, final int millisecondsSinceLastFrame);
25 }