Highlights:

• Up API version 6.0.0 -> 6.1.0

Full Changelog

Additions:

• add opacity to IDhApiBlockStateWrapper
• add alpha to DhApiBlockColorOverrideEvent

Highlights:

• Up API version 5.1.0 -> 6.0.0

Full Changelog

Additions:

• DhApiRenderParam.dhMvmProjMatrix
• DhApiBlockStateWrapperCreatedEvent
  • Allows changing how DH handles certain blocks (IE opacity, Iris material, or color)
• DhApiBlockColorOverrideEvent
  • Allows overriding the color of specific blocks when DH is creating render data
• EDhApiRenderApi
  • Auto, Open_GL, and Blaze_3D

Improvements:

• Improved several Javadocs
  • Fixed a couple typos
  • Added some additional deprecation info
  • Mentioned a few events/methods that are only relevant to the OpenGL renderer
  • Mentioned that IDhApiUnsafeWrapper can return null objects (specifically when dealing with the air block wrapper)

Changes:

• EDhApiRendererMode DEBUG -> DEBUG_TRIANGLE
• IDhApiTerrainDataCache is now AutoClosable
• Replace several "Double" config options with "Float"
  • Float is more accurate to what is happening behind the scenes
• EDhApiVerticalQuality
  • renamed method calculateMaxVerticalData(byte dataDetail) -> calculateMaxNumberOfVerticalSlicesAtDetailLevel(byte dataDetail)

Deprecations:

• DhApiBeforeColorDepthTextureCreatedEvent
  • This event will still be triggered for the OpenGL renderer, but not the Blaze3D renderer
  • Using DhApiAfterColorDepthTextureCreatedEvent is recommended instead

Removals:

• IDhApiTerrainDataRepo methods that don't use a IDhApiTerrainDataCache
  • If a cache isn't included each call would require a separate database/decompression hit, which is very slow and caused confusion
• Removed SSAO config options
  • enabling/disabling SSAO is still available however no additional configuration options can be done
• EDhApiDebugRendering SHOW_RENDER_SOURCE_FLAG
  • This hasn't been used for some time
• EDhApiGpuUploadMethod BUFFER_MAPPING
  • This has been deprecated for some time and hasn't been used for about as long

Highlights:

• Up API version 5.0.0 -> 5.1.0

Full Changelog

Additions:

• DhApiRenderParam.clientLevelWrapper
  • The render parameters will now include the IDhApiLevelWrapper that is currently being rendered.

Highlights:

• Up API version 4.1.0 -> 5.0.0
• Removed 2 deprecated constructors
• Renamed IDhApiTerrainDataRepo.getSoftCache() -> createSoftCache() for clarity

Full Changelog

Additions:

• EDhApiDataCompressionMode
  • Z_STD_STREAM
    • Deprecated legacy option to support migrating old database formats
    • Identical in behavior to the removed Z_STD option
• EDhApiLoggerLevel
• IDhApiGraphicsConfig
  • getBiomeBlending()
• IDhApiTerrainDataRepo
  • createSoftCache() identical in behavior to the removed getSoftCache(), this was only renamed to prevent confusion
• DhApiTerrainDataPoint
  • add a default toString() method for easier debugging

Changes:

• Up API version 4.1.0 -> 5.0.0
• EDhApiDataCompressionMode
  • Z_STD_BLOCK now uses block compression instead of streams, use Z_STD_STREAM to get the old behavior

Removals:

• EDhApiDataCompressionMode
  • Z_STD
    • Replaced by Z_STD_STREAM
• EDhApiLoggerMode
  • Replaced by the more granular options of EDhApiLoggerLevel
• IDhApiTerrainDataRepo
  • getSoftCache()
    • Replaced by createSoftCache()
      • both methods function identically, the replacement was done just to prevent confusion about how the method would work
• DhApiChunk
  • remove deprecated constructor
• DhApiTerrainDataPoint
  • remove deprecated constructor

Highlights:

• Up API version 4.0.1 -> 4.1.0

Full Changelog

Additions:

• EDhApiDataCompressionMode.Z_STD
• EDhApiLoggerMode.LOG_ERROR_TO_CHAT_AND_WARNING_TO_FILE
• IDhApiEventParam.getCopyBeforeFire()
• DhApiAfterColorDepthTextureCreatedEvent
• DhApiBeforeColorDepthTextureCreatedEvent
• DhApiChunkProcessingEvent
• Add remove(obj) and remove(index) to IRenderableBoxGroup

Changes:

• Up API version 4.0.1 -> 4.1.0

Bug Fixes:

• Fix setting the config value renderingEnabled() causing the user's rendering mode to be changed and saved to file
• Fix DhApiAfterDhInitEvent firing before the DH config has been set up
• Fix VANILLA_CHUNKS API world gen

Deprecations:

• DhApiColorDepthTextureCreatedEvent
  • replaced by DhApiAfterColorDepthTextureCreatedEvent and DhApiBeforeColorDepthTextureCreatedEvent

Highlights:

• Up API version 4.0.0 -> 4.1.0

Full Changelog

Additions:

• DhApiAfterColorDepthTextureCreatedEvent
• DhApiBeforeColorDepthTextureCreatedEvent

Changes:

• Up API version 4.0.0 -> 4.1.0

Bug Fixes:

• Fix setting the config value renderingEnabled() causing the user's rendering mode to be changed and saved to file
• Fix DhApiAfterDhInitEvent firing before the DH config has been set up

Deprecations:

• DhApiColorDepthTextureCreatedEvent
  • replaced by DhApiAfterColorDepthTextureCreatedEvent and DhApiBeforeColorDepthTextureCreatedEvent

API Changes

Highlights:

• Up API version 3.0.1 -> 4.0.0

Full Changelog

Additions:

• IDhApiWorldProxy
  • setReadOnly()
  • getReadOnly()
• IDhApiLevelWrapper
  • getDimensionName()
  • getDhIdentifier()
  • getDhSaveFolder()
• generateLod()
  • Can be used to generate N-sized LODs
• IDhApiFogConfig
  • enableDhFog()
  • enableVanillaFog()
• EDhApiWorldGeneratorReturnType
  • API_DATA_SOURCES
• IDhApiFullDataSource
  • For use with the IDhApiWorldGenerator
• DhApiWorldUnloadEvent
• DhApiWorldLoadEvent
• IDhApiSaveStructure
• EDhApiDistantGeneratorMode
  • FULL

Changes:

• Up API version 3.0.1 -> 4.0.0
• IDhApiWorldGenerator
  • rename runApiChunkValidation() -> runApiValidation()
• IDhApiHeightFogConfig
  • heightFogMode -> heightFogDirection
• EDhApiHeightFogMode -> EDhApiHeightFogDirection
• EDhApiHeightFogMixMode
  • BASIC -> SPHERICAL
  • IGNORE_HEIGHT -> CYLINDRICAL

Bug Fixes:

• Fix off by one error in the following IDhApiTerrainDataRepo methods when getting blocks in negative X and/or Z positions:
  • getSingleDataPointAtBlockPos()
  • getColumnDataAtBlockPos()
  • getAllTerrainDataAtChunkPos()
  • getAllTerrainDataAtRegionPos()
  • getAllTerrainDataAtDetailLevelAndPos()

Removals:

• IDhApiDimensionTypeWrapper
  • getDimensionName()
• IDhApiWorldGenerator
  • getMinGenerationGranularity()
  • getMaxGenerationGranularity()
  • isBusy()
  • generateChunks() and generateApiChunks() byte granularity parameter
    • int generationRequestChunkWidthCount is it's replacement and represents a different thing. Having the number of chunks wide is much easier to understand than the granularity.
• IDhApiMultiplayerConfig
  • multiverseSimilarityRequirement()
    • This config is no longer supported or needed

Deprecations:

• IDhApiFogConfig
  • drawMode()
    • Use enableDhFog() instead
    • The old method is kept but deprecated to prevent breaking support with Iris 1.7.5
  • disableVanillaFog()
    • Use enableVanillaFog() instead
    • The old method is kept but deprecated to prevent breaking support with Iris 1.7.5
• EDhApiFogDrawMode
  • USE_OPTIFINE_SETTING

Highlights:

• Due to breaking changes (mainly caused by incorrectly named objects) the api version number has been up from 2.1.0 to 3.0.0
  • please make sure your implementing programs check the API version and handle old DH versions cleanly.

Full Details:

updated javadocs

Additions:

• Generic Rendering API
  • New objects include:
    • DhApiRenderableBoxGroupShading
    • DhApiRenderableBox
    • DhApiBeforeGenericRenderSetupEvent
    • DhApiBeforeGenericRenderCleanupEvent
    • DhApiBeforeGenericObjectRenderEvent
    • IDhApiRenderableBoxGroup
    • IDhApiCustomRenderRegister
    • IDhApiCustomRenderObjectFactory
    • IDhApiGenericObjectShaderProgram
    • IDhApiGenericRenderingConfig
  • New bindings/methods include:
    • DhApi.Delayed.IDhApiCustomRenderObjectFactory
    • IDhApiLevelWrapper.getRenderRegister()
    • IDhApiGraphicsConfig.IDhApiGenericRenderingConfig
• Optional memory caching to IDhApiTerrainDataRepo methods
  • This allows for much faster raycasting and repeat query operations
  • IDhApiTerrainDataCache
• New Enum EDhApiBlockMaterial
• New getter IDhApiBlockStateWrapper methods
  • IDhApiBlockStateWrapper.getSerialString()
  • IDhApiBlockStateWrapper.getMaterialId()
• New wrapper Factory methods to builder wrappers from resource location strings (IE "minecraft:stone", or "minecraft:plains")
  • IDhApiWrapperFactory.getBiomeWrapper(String resourceLocationString, IDhApiLevelWrapper levelWrapper)
  • IDhApiWrapperFactory.getDefaultBlockStateWrapper(String resourceLocationString, IDhApiLevelWrapper levelWrapper)
• Optional additional world gen DhApiChunk validation

Bugfixes:

• Fix/add AbstractDhApiChunkWorldGenerator.generateApiChunk()
  • API Chunk generation was present previously but was broken preventing it's correct use

Breaking Changes:

• Renamed

  • Math/Position objects
    • Vec3f -> DhApiVec3f
    • Vec3d -> DhApiVec3d
    • Vec3i -> DhApiVec3i
    • Mat4f -> DhApiMat4f
  • Affected API objects:
    • Vec3i -> DhApiVec3i
      • DhApiRaycastResult
      • DhApiBeforeBufferRenderEvent
      • DhApiAfterRenderEvent
      • IDhApiShaderProgram
      • IDhApiCullingFrustum
    • Mat4f -> DhApiMat4f
      • DhApiRenderParam

• Removed

  • IDhApiGpuBuffersConfig
    • These config values didn't need to be changed by the end users (Note: if James is wrong and these do need to be changed in some edge cases, let him know so the change can be rolled back)
    • this includes:
      • gpuUploadMethod
      • gpuUploadPerMegabyteInMilliseconds

Deprecations:

• IDhApiLevelWrapper.getHeight()
  • This change is done so get min/max heigth are both viable methods
  • use getMaxHeight() instead
• DhApiChunk constructor
  • This change was due to the old constructor's parameters being in the wrong order (Specifically top and bottom positions being flipped)
  • use DhApiChunk.create() instead
• DhApiTerrainDataPoint constructor
  • This change was due to the old constructor's parameters being in the wrong order (Specifically top and bottom positions being flipped)
  • use DhApiTerrainDataPoint.create() instead
• EDhApiGpuUploadMethod.BUFFER_MAPPING
  • Buffer mapping was removed as an option due to memory leaks in the old system and having one system being simpler. This can be reverted if users determine that buffer mapping is better in some situations.
• IDhApiWorldGenerator.isBusy()
  • The method now has a default implementation but isn't used.
  • The task queuing logic is now handled internally by DH

Additions

• EDhApiUpdateBranch.AUTO

Highlights:

• Due to breaking changes the api version number has been up from 1.0.0 to 2.0.0
  • please make sure your implementing programs check the API version and handle old DH versions cleanly.

Full Details:

Breaking Changes

• Renamed

  • ERendererMode -> EDhApiRendererMode
  • DhApiChunkOfDataPoints -> DhApiChunk
  • DhApiTerrainDataPoint
    • lightLevel -> blockLightLevel, skyLightLevel
  • DhApiBeforeRenderEvent and DhApiAfterRenderEvent -> EventParam
    • DhApiBeforeRenderEvent.EventParam -> DhApiRenderParam
    • DhApiAfterRenderEvent.EventParam -> DhApiRenderParam
  • Added missing "DhApi" prefix to the following enums:
    • EDhApiQualityPreset
    • EDhApiThreadPreset
    • EDhApiBlocksToAvoid
    • EDhApiDataCompressionMode
    • EDhApiGLErrorHandlingMode
    • EDhApiGlProfileMode
    • EDhApiGpuUploadMethod
    • EDhApiGrassSideRendering
    • EDhApiHorizontalQuality
    • EDhApiLodShading
    • EDhApiLoggerMode
    • EDhApiMaxHorizontalResolution
    • EDhApiServerFolderNameMode
    • EDhApiUpdateBranch
    • EDhApiVanillaOverdraw
    • EDhApiVerticalQuality
    • EDhApiWorldCompressionMode
    • EDhApiDebugRendering
    • EDhApiFogColorMode
    • EDhApiFogDrawMode
    • EDhApiFogFalloff
    • EDhApiHeightFogMixMode
    • EDhApiHeightFogMode
    • EDhApiRendererMode
    • EDhApiRenderPass
    • EDhApiTransparency
    • EDhApiWorldGeneratorReturnType

• Replaced

  • IDhApiRenderProxy
    • removed getDhFrameBufferId() and setTargetFrameBufferId()
      • replaced with the bindable IDhApiFramebuffer interface
  • IDhApiGraphicsConfig
    • Replaced overdrawPrevention() with overdrawPreventionRadius()
  • Removed DhApiScreenResizeEvent
    • replaced with DhApiColorDepthTextureCreatedEvent

Additions

• expand API to allow world generator to generate chunks of data points in addition to actual chunks. - Builderb0y

• usable interfaces

  • IDhApiWrapperFactory

• bindable interfaces

  • IDhApiFramebuffer
  • IDhApiShaderProgram
  • IDhApiCullingFrustum
  • IDhApiShadowCullingFrustum

• bindable events

  • DhApiBeforeApplyShaderRenderEvent
  • DhApiBeforeBufferRenderEvent
  • DhApiBeforeDeferredRenderEvent
  • DhApiBeforeRenderCleanupEvent
  • DhApiBeforeRenderPassEvent
  • DhApiBeforeRenderSetupEvent
  • DhApiBeforeTextureClearEvent
  • DhApiColorDepthTextureCreatedEvent

• methods

  • IDhApiRenderProxy
    • setDeferTransparentRendering()
    • getDeferTransparentRendering()
    • getNearClipPlaneDistanceInBlocks()
  • IOverrideInjector.unbind()
  • DhApi.isDhThread()
  • DhApiConfigValue.clearValue()
  • IDhApiRenderProxy.getDhFrameBufferId()
  • IDhApiWorldGenerator
    • generateChunks()
    • generateApiChunks()
    • EDhApiWorldGeneratorReturnType getReturnType()
  • IDhApiConfigValue
    • getApiValue()
    • clearValue()

• variables

  • DhApiRenderParam
    • EDhApiRenderPass renderPass
    • float nearClipPlane
    • float farClipPlane
  • DhApi.wrapperFactory