StarOpenSource/Engine
StarOpenSource/Engine
2
0
Fork 1
Code Issues 10 Pull requests Releases 9 Activity Actions

Add @since tag to VsyncMode javadoc

Browse source
This commit is contained in:
JeremyStar™ 2024-07-21 16:43:07 +02:00
parent a3849f1813
commit de0d5cb8a8
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
graphics/src/main/java/de/staropensource/sosengine/graphics/types/VsyncMode.java
View file

@ -21,21 +21,29 @@ package de.staropensource.sosengine.graphics.types;
/** /**
* Used for determining if and how a window's frame rate should be synchronized to the monitor's refresh rate. * Used for determining if and how a window's frame rate should be synchronized to the monitor's refresh rate.
*
* @since v1-alpha1
*/ */
@SuppressWarnings({ "unused" }) @SuppressWarnings({ "unused" })
public enum VsyncMode { public enum VsyncMode {
/** /**
* Disables VSync. The frame rate can be uncapped and will allow for processing an unlimited amount of frames. * Disables VSync. The frame rate can be uncapped and will allow for processing an unlimited amount of frames.
*
* @since v1-alpha1
*/ */
OFF, OFF,
/** /**
* Enables VSync and will cap the window's frame rate at the refresh rate of the target monitor. * Enables VSync and will cap the window's frame rate at the refresh rate of the target monitor.
*
* @since v1-alpha1
*/ */
ON, ON,
/** /**
* This mode will disables VSync if the window's frame rate drops below the monitor's refresh rate and enable it otherwise. * This mode will disables VSync if the window's frame rate drops below the monitor's refresh rate and enable it otherwise.
*
* @since v1-alpha1
*/ */
ADAPTIVE ADAPTIVE
} }