Update javadocs for API enums

and move one core enum out of the API
2023-06-30 07:46:00 -05:00
parent 10b9161188
commit 52edbd7c18
15 changed files with 24 additions and 67 deletions
@@ -30,6 +30,7 @@ package com.seibel.distanthorizons.api.enums.config;
 * @author Leonardo Amato
 * @version 9-25-2021
 */
+@Deprecated // not currently in use, if the config this enum represents is re-implemented, the deprecated flag can be removed
 public enum EBufferRebuildTimes
 {
 	CONSTANT(0, 0, 0, 1),
@@ -30,6 +30,7 @@ package com.seibel.distanthorizons.api.enums.config;
 * @author Leonardo Amato
 * @version 12-1-2021
 */
+@Deprecated // not currently in use, if the config this enum represents is re-implemented, the deprecated flag can be removed
 public enum EGenerationPriority
 {
 	// Reminder:
@@ -38,30 +38,20 @@ public enum EGpuUploadMethod
 	// commented out since it isn't currently in use
 	//BUFFER_STORAGE_MAPPING(true, true),
 	
-	/**
-	 * Default for NVIDIA if OpenGL 4.5 is supported. <br>
-	 * Fast rendering, no stuttering.
-	 */
+	/** Fast rendering, no stuttering. */
 	BUFFER_STORAGE(false, true),
 	
-	/**
-	 * Backup option for NVIDIA. <br>
-	 * Fast rendering but may stutter when uploading.
-	 */
+	/** Fast rendering but may stutter when uploading. */
 	SUB_DATA(false, false),

 	/** 
-	 * Default option for AMD/Intel. <br>
 	 * May end up storing buffers in System memory. <br>
 	 * Fast rending if in GPU memory, slow if in system memory, <br>
 	 * but won't stutter when uploading. 
 	 */
 	BUFFER_MAPPING(true, false),

-	/** 
-	 * Backup option for AMD/Intel. <br>
-	 * Fast rendering but may stutter when uploading. 
-	 */
+	/** Fast rendering but may stutter when uploading. */
 	DATA(false, false);
 	
 	
@@ -24,6 +24,7 @@ package com.seibel.distanthorizons.api.enums.config;
 * LOW <br>
 * MEDIUM <br>
 * HIGH <br>
+ * UNLIMITED <br>
 */
 public enum EHorizontalQuality
 {
@@ -20,8 +20,8 @@
 package com.seibel.distanthorizons.api.enums.config;

 /**
- * FAST, <br>
- * FANCY,
+ * DISTANT_HORIZONS, <br>
+ * MINECRAFT,
 *
 * @author Leetom
 * @version 2023-6-7
@@ -1,41 +0,0 @@
-/*
- *    This file is part of the Distant Horizons mod (formerly the LOD Mod),
- *    licensed under the GNU LGPL v3 License.
- *
- *    Copyright (C) 2020-2022  James Seibel
- *
- *    This program is free software: you can redistribute it and/or modify
- *    it under the terms of the GNU Lesser General Public License as published by
- *    the Free Software Foundation, version 3.
- *
- *    This program 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 Lesser General Public License for more details.
- *
- *    You should have received a copy of the GNU Lesser General Public License
- *    along with this program.  If not, see <https://www.gnu.org/licenses/>.
- */
- 
-package com.seibel.distanthorizons.api.enums.config;
-
-/**
- * NONE, GAME_SHADING
- * 
- * @author James Seibel
- * @version 7-25-2020
- */
-public enum EShadingMode
-{
-	/**
-	 * LODs will have darker sides and bottoms to simulate
-	 * Minecraft's fast lighting.
-	 */
-	GAME_SHADING,
-	
-	/**
-	 * LODs will use ambient occlusion to mimic Minecraft's
-	 * Fancy lighting.
-	 */
-	AMBIENT_OCCLUSION
-}
@@ -30,6 +30,7 @@ package com.seibel.distanthorizons.api.enums.config;
 * @author James Seibel
 * @version 2022-6-30
 */
+@Deprecated // not currently in use, if the config this enum represents is re-implemented, the deprecated flag can be removed
 public enum EVanillaOverdraw
 {
 	// Reminder:
@@ -26,7 +26,7 @@ import com.seibel.distanthorizons.coreapi.util.MathUtil;
 * LOW <br>
 * MEDIUM <br>
 * HIGH <br>
- * ULTRA <br>
+ * EXTREME <br>
 *
 * @author Leonardo Amato
 * @version 2023-2-5
@@ -8,6 +8,7 @@ package com.seibel.distanthorizons.api.enums.worldGeneration;
 * @author James Seibel
 * @version 7-14-2022
 */
+@Deprecated // not currently in use, if the config this enum represents is re-implemented, the deprecated flag can be removed
 public enum EDhApiWorldGenThreadMode
 {
 	/**
@@ -630,16 +630,16 @@ public class Config
 						.build();
 				
 				public static ConfigEntry<ELightGenerationMode> lightingEngine = new ConfigEntry.Builder<ELightGenerationMode>()
-						.set(ELightGenerationMode.DISTANT_HORIZONS)
+						.set(ELightGenerationMode.MINECRAFT)
 						.comment(""
 								+ " How should distant generation chunk lighting be generated? \n"
 								+ "\n"
-								+ ELightGenerationMode.DISTANT_HORIZONS + ": Uses Distant Horizons' lighting engine to estimate chunk lighting. \n"
-								+ "    Generally lower quality; but more stable for large numbers of world generator threads. \n"
 								+ ELightGenerationMode.MINECRAFT + ": Use Minecraft's lighting engine to generate chunk lighting. \n"
 								+ "    Generally higher quality; but may crash MC's lighting engine if there is an issue. \n"
+								+ ELightGenerationMode.DISTANT_HORIZONS + ": Uses Distant Horizons' lighting engine to estimate chunk lighting. \n"
+								+ "    Generally lower quality; but more stable for large numbers of world generator threads. \n"
 								+ "\n"
-								+ "This will effect generation speed, but not the rendering performance.")
+								+ "This will effect generation speed, but not rendering performance.")
 						.build();
 				
 				// deprecated and not implemented, can be made public if we ever re-implement it
@@ -52,7 +52,7 @@ public class RenderQualityPresetConfigEventHandler extends AbstractPresetConfigE
 		new HashMap<EQualityPreset, ETransparency>()
 		{{
 			this.put(EQualityPreset.MINIMUM, ETransparency.DISABLED);
-			this.put(EQualityPreset.LOW, ETransparency.FAKE);
+			this.put(EQualityPreset.LOW, ETransparency.DISABLED); // should be fake if/when fake is fixed
 			this.put(EQualityPreset.MEDIUM, ETransparency.COMPLETE);
 			this.put(EQualityPreset.HIGH, ETransparency.COMPLETE);
 			this.put(EQualityPreset.EXTREME, ETransparency.COMPLETE);
@@ -2,7 +2,7 @@ package com.seibel.distanthorizons.core.dataObjects.render.bufferBuilding;

 import com.seibel.distanthorizons.api.enums.config.EGpuUploadMethod;
 import com.seibel.distanthorizons.api.enums.rendering.EDebugRendering;
-import com.seibel.distanthorizons.api.enums.rendering.EGLProxyContext;
+import com.seibel.distanthorizons.core.enums.EGLProxyContext;
 import com.seibel.distanthorizons.core.config.Config;
 import com.seibel.distanthorizons.core.config.listeners.ConfigChangeListener;
 import com.seibel.distanthorizons.core.dataObjects.render.ColumnRenderSource;
@@ -17,10 +17,13 @@
 *    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

-package com.seibel.distanthorizons.api.enums.rendering;
+package com.seibel.distanthorizons.core.enums;

 /**
- * Minecraft, Lod_Builder, None
+ * Minecraft, 		<br>
+ * Lod_Builder,		<br>
+ * Proxy_Worker,	<br>
+ * None				<br>
 * 
 * @author James Seibel
 * @version 10-1-2021
@@ -41,7 +41,7 @@ import org.lwjgl.opengl.GLUtil;
 import com.google.common.util.concurrent.ThreadFactoryBuilder;
 import com.seibel.distanthorizons.coreapi.ModInfo;
 import com.seibel.distanthorizons.api.enums.config.EGpuUploadMethod;
-import com.seibel.distanthorizons.api.enums.rendering.EGLProxyContext;
+import com.seibel.distanthorizons.core.enums.EGLProxyContext;
 import com.seibel.distanthorizons.core.util.objects.GLMessage;
 import com.seibel.distanthorizons.core.util.objects.GLMessageOutputStream;
 import com.seibel.distanthorizons.core.wrapperInterfaces.minecraft.IMinecraftClientWrapper;
@@ -1,7 +1,7 @@
 package com.seibel.distanthorizons.core.render.glObject.buffer;

 import com.seibel.distanthorizons.api.enums.config.EGpuUploadMethod;
-import com.seibel.distanthorizons.api.enums.rendering.EGLProxyContext;
+import com.seibel.distanthorizons.core.enums.EGLProxyContext;
 import com.seibel.distanthorizons.core.logging.DhLoggerBuilder;
 import com.seibel.distanthorizons.core.render.glObject.GLProxy;
 import com.seibel.distanthorizons.core.util.LodUtil;