Move some comments and improve DhApi Debugging

This commit is contained in:
James Seibel
2022-07-05 21:23:42 -05:00
parent cedffb03d8
commit 9434275e51
5 changed files with 11 additions and 29 deletions
@@ -36,11 +36,6 @@ import com.seibel.lod.core.enums.config.EGpuUploadMethod;
*/
public class DhApiBuffers
{
// developer note:
// DhApiConfig needs types explicitly defined otherwise Intellij
// won't do type checking and the wrong types can be used.
// For example returning IDhApiConfig<Integer> when the config should be a Boolean.
/** Defines how geometry data is uploaded to the GPU. */
public static IDhApiConfig<EDhApiGpuUploadMethod> getGpuUploadMethodConfig()
@@ -27,27 +27,20 @@ import com.seibel.lod.core.config.Config.Client.Advanced.Debugging;
import com.seibel.lod.core.enums.rendering.EDebugMode;
/**
* Distant Horizons debug configuration.
* Distant Horizons' debug configuration.
*
* @author James Seibel
* @version 2022-7-4
* @version 2022-7-5
*/
public class DhApiDebugging
{
/**
* Returns the config related to if/how Distant Horizons
* uses debug rendering.
*/
/** Can be used to debug the standard fake chunk rendering. */
public static IDhApiConfig<EDhApiDebugMode> getDebugRenderModeConfig()
{ return new DhApiConfig<>(Debugging.debugMode, new GenericEnumConverter<>(EDebugMode.class, EDhApiDebugMode.class)); }
{ return new DhApiConfig<EDebugMode, EDhApiDebugMode>(Debugging.debugMode, new GenericEnumConverter<>(EDebugMode.class, EDhApiDebugMode.class)); }
/**
* Returns the config related to if Distant Horizons
* debug keybindings are active or not.
*/
public static IDhApiConfig<Double> getEnableDebugKeybindingsConfig()
{ return new DhApiConfig<>(Debugging.enableDebugKeybindings); }
/** If enabled debug keybindings can be used. */
public static IDhApiConfig<Boolean> getEnableDebugKeybindingsConfig()
{ return new DhApiConfig<Boolean, Boolean>(Debugging.enableDebugKeybindings); }
}
@@ -40,11 +40,6 @@ import com.seibel.lod.core.config.Config.Client.Graphics.AdvancedGraphics;
*/
public class DhApiGraphics
{
// developer note:
// DhApiConfig needs types explicitly defined otherwise Intellij
// won't do type checking and the wrong types can be used.
// For example returning IDhApiConfig<Integer> when the config should be a Boolean.
//========================//
// basic graphic settings //
@@ -38,11 +38,6 @@ import com.seibel.lod.core.config.Config.Client.Graphics.FogQuality;
*/
public class DhApiGraphicsFog
{
// developer note:
// DhApiConfig needs types explicitly defined otherwise Intellij
// won't do type checking and the wrong types can be used.
// For example returning IDhApiConfig<Integer> when the config should be a Boolean.
//====================//
// basic fog settings //
@@ -8,6 +8,10 @@ import com.seibel.lod.core.config.types.ConfigEntry;
/**
* A wrapper used to interface with Distant Horizon's Config.
*
* When using this object you need to explicitly define the generic types,
* otherwise Intellij won't do any type checking and the wrong types can be used. <br>
* For example a method returning IDhApiConfig<Integer> when the config should be a Boolean.
*
* @param <apiType>
* @author James Seibel
* @version 2022-6-30