API Migration
Major Changes
- Added new WorldSplineGraph class.
- Added new SplineGraph class.
- Added new TileSet class.
- Added new TileSetFile class.
- Removed shadow radius parameter from all corresponding classes.
Camera Class
Console Class
Dataset Class
| UNIGINE 2.4.1 | UNIGINE 2.5 |
|---|---|
| getRasterImage() | Changed the set of arguments. |
| getRasterImageAllBands() | Changed the set of arguments. |
| calcVectorBoundEnvelope2D() | Removed. See calcVectorBounds(). |
New Functions
Editor Class
Image Class
ivec3 Class
ivec4 Class
Engine Class
| UNIGINE 2.4.1 | UNIGINE 2.5 |
|---|---|
| message() | Changed the set of arguments. |
| error() | Changed the set of arguments. |
FieldShoreline Class
Light Class
| UNIGINE 2.4.1 | UNIGINE 2.5 |
|---|---|
| getShadowOffset() | Removed. |
| setShadowOffset() | Removed. |
New Functions
- setShadowScreenSpace()
- getShadowScreenSpace()
- setShadowScreenSpaceNoiseRay()
- getShadowScreenSpaceNoiseRay()
- setShadowScreenSpaceNoiseStep()
- getShadowScreenSpaceNoiseStep()
- setShadowScreenSpaceNumRays()
- getShadowScreenSpaceNumRays()
- setShadowScreenSpaceNumSteps()
- getShadowScreenSpaceNumSteps()
- setShadowScreenSpaceSoftness()
- getShadowScreenSpaceSoftness()
- setShadowScreenSpaceStepSize()
- getShadowScreenSpaceStepSize()
- getShadowScreenSpaceThreshold()
- setShadowScreenSpaceThreshold()
LightEnvironmentProbe Class
LightWorld Class
| UNIGINE 2.4.1 | UNIGINE 2.5 |
|---|---|
| getShadowCascadeOffset() | Removed. |
| setShadowCascadeOffset() | Removed. |
Material Class
Mesh Class
Node Class
ObjectGrass Class
| UNIGINE 2.4.1 | UNIGINE 2.5 |
|---|---|
| setShadowRadius() | Removed. |
| getShadowRadius() | Removed. |
ObjectTerrain Class
| UNIGINE 2.4.1 | UNIGINE 2.5 |
|---|---|
| setShadowRadius() | Removed. |
| getShadowRadius() | Removed. |
ObjectMeshClutter Class
| UNIGINE 2.4.1 | UNIGINE 2.5 |
|---|---|
| setShadowRadius() | Removed. |
| getShadowRadius() | Removed. |
ObjectMeshCluster Class
| UNIGINE 2.4.1 | UNIGINE 2.5 |
|---|---|
| setShadowRadius() | Removed. |
| getShadowRadius() | Removed. |
ObjectTerrainGlobal Class
Player Class
Render Class
| UNIGINE 2.4.1 | UNIGINE 2.5 |
|---|---|
| getAlphaFade() | Renamed. See isAlphaFade(). |
| getAuxiliary() | Renamed. See isAuxiliary(). |
| setBloomEnabled() | Renamed. See setBloom(). |
| isBloomEnabled() | Renamed. See isBloom(). |
| setCrossEnabled() | Renamed. See setCross(). |
| isCrossEnabled() | Renamed. See isCross(). |
| getDOF() | Renamed. See isDOF(). |
| getGeometryShader() | Removed. |
| setLensEnabled() | Renamed. See setLens(). |
| isLensEnabled() | Renamed. See isLens(). |
| getMotionBlur() | Renamed. See isMotionBlur(). |
| setMotionBlurDepthFalloff() | Removed. |
| getMotionBlurDepthFalloff() | Removed. |
| getParallax() | Renamed. See isParallax(). |
| getRefraction() | Renamed. See isRefraction(). |
| getShadowShafts() | Renamed. See isShadowShafts(). |
| setSSREnabled() | Renamed. See setSSR(). |
| isSSREnabled() | Renamed. See isSSR(). |
| setSSRNoise() | Removed. |
| isSSRNoise() | Removed. |
| setSSRScale() | Removed. |
| getSSRScale() | Removed. |
| setSSRStretching() | Removed. |
| getSSRStretching() | Removed. |
| setSunShaftsEnabled() | Renamed. See setSunShafts(). |
| isSunShaftsEnabled() | Renamed. See isSunShafts(). |
| compressBCTexture() | Renamed. See compressTexture(). |
| getTessellation() | Removed. |
| getTessellation() | Removed. |
| isDepthZeroToOne() | Removed. |
| getTessellationDistance() | Removed. |
| setTessellationFactor() | Removed. |
| getTessellationFactor() | Removed. |
| setTessellationScale() | Removed. |
| getTessellationScale() | Removed. |
New Functions
- compressImage()
- setAlphaFade()
- isAlphaFade()
- getAnimationOldTime()
- setAntialiasing()
- setAuxiliary()
- isAuxiliary()
- setBentNormalRayTracing()
- isBentNormalRayTracing()
- setBentNormalRayTracingDenoise()
- isBentNormalRayTracingDenoise()
- setBentNormalRayTracingThreshold()
- getBentNormalRayTracingThreshold()
- setBloom()
- isBloom()
- setBloomPasses()
- getBloomPasses()
- setBloomResolution()
- getBloomResolution()
- setCloudsGroundShadows()
- isCloudsGroundShadows()
- setCloudsSamplesCount()
- getCloudsSamplesCount()
- setCloudsShadowShafts()
- isCloudsShadowShafts()
- setCloudsSimplifiedDepthTest()
- isCloudsSimplifiedDepthTest()
- setCloudsSoftIntersection()
- getCloudsSoftIntersection()
- setCloudsTransparentOrder()
- isCloudsTransparentOrder()
- setGBufferAO()
- isGBufferAO()
- setGBufferLightmap()
- isGBufferLightmap()
- setGBufferMaterial()
- isGBufferMaterial()
- setGBufferMicrofiber()
- isGBufferMicrofiber()
- setGBufferSpecular()
- isGBufferSpecular()
- setGBufferTranslucent()
- isGBufferTranslucent()
- setGBufferVelocity()
- isGBufferVelocity()
- setDebug()
- isDebug()
- setDebugMaterials()
- getDebugMaterials()
- setDeferredMaterial()
- getDeferredMaterial()
- setDecals()
- isDecals()
- setDOF()
- isDOF()
- setDOFBokehMode()
- getDOFBokehMode()
- setDOFFocusImprovement()
- isDOFFocusImprovement()
- setDOFIncreasedAccuracy()
- isDOFIncreasedAccuracy()
- setDOFQuality()
- getDOFQuality()
- setDOFResolution()
- getDOFResolution()
- setEnvironment()
- isEnvironment()
- setEnvironmentCubemapBlendMode()
- getEnvironmentCubemapBlendMode()
- setFieldPrecision()
- isFieldPrecision()
- setFieldHeightResolution()
- getFieldHeightResolution()
- setFieldShorelineResolution()
- getFieldShorelineResolution()
- setFilmic()
- isFilmic()
- setLens()
- isLens()
- setLightsForwardPerObjectEnv()
- getLightsForwardPerObjectEnv()
- setLightsForwardPerObjectOmni()
- getLightsForwardPerObjectOmni()
- setLightsForwardPerObjectProj()
- getLightsForwardPerObjectProj()
- setLightsForwardPerObjectWorld()
- getLightsForwardPerObjectWorld()
- setLightsMaxPerBatch()
- getLightsMaxPerBatch()
- setLightsSpecular()
- isLightsSpecular()
- setLightsTileGridSize()
- getLightsTileGridSize()
- setMotionBlur()
- isMotionBlur()
- setMotionBlurNeatSilhouettes()
- isMotionBlurNeatSilhouettes()
- setMotionBlurNoiseIntensity()
- getMotionBlurNoiseIntensity()
- setMotionBlurNumSteps()
- getMotionBlurNumSteps()
- setOccluders()
- isOccluders()
- setOcclusionQueries()
- isOcclusionQueries()
- setOcclusionQueriesNumFrames()
- getOcclusionQueriesNumFrames()
- setPanorama()
- getPanorama()
- setParallax()
- isParallax()
- setReflectionDynamic()
- isReflectionDynamic()
- setReflectionDynamicBlur()
- isReflectionDynamicBlur()
- setReflectionLods()
- isReflectionLods()
- setRefraction()
- isRefraction()
- setScreenPrecision()
- isScreenPrecision()
- setShadersQuality()
- setShadows()
- isShadows()
- setShadowsAlphaTest()
- isShadowsAlphaTest()
- setShadowsOmniJitter()
- isShadowsOmniJitter()
- setShadowsPrecision()
- isShadowsPrecision()
- setShadowsScreenSpace()
- isShadowsScreenSpace()
- setShadowsSoft()
- isShadowsSoft()
- setShadowsSoftQuality()
- getShadowsSoftQuality()
- setShadowsWorldLerpCascades()
- isShadowsWorldLerpCascades()
- setShadowShafts()
- isShadowShafts()
- setSharpen()
- isSharpen()
- setShowAlphaTest()
- isShowAlphaTest()
- setShowAmbient()
- isShowAmbient()
- setShowCascades()
- isShowCascades()
- setShowDecals()
- isShowDecals()
- setShowDynamic()
- isShowDynamic()
- setShowGeodeticPivot()
- isShowGeodeticPivot()
- setShowMipmaps()
- isShowMipmaps()
- setShowOccluder()
- isShowOccluder()
- setShowQueries()
- isShowQueries()
- setShowScissors()
- isShowScissors()
- setShowTextures()
- getShowTextures()
- setShowTexturesNumber()
- getShowTexturesNumber()
- setShowTexturesOffset()
- getShowTexturesOffset()
- setShowTransparent()
- isShowTransparent()
- setShowTriangles()
- getShowTriangles()
- setSkipPostMaterials()
- isSkipPostMaterials()
- setSkipRenderMaterials()
- isSkipRenderMaterials()
- setSkipTransparent()
- isSkipTransparent()
- setSkipTransparentAmbient()
- isSkipTransparentAmbient()
- setSkipTransparentDeferred()
- isSkipTransparentDeferred()
- isSkipTransparentLight()
- setSkipTransparentLight()
- setSkipTransparentMultipleEnvProbes()
- isSkipTransparentMultipleEnvProbes()
- setSSAO()
- isSSAO()
- setSSAOCavity()
- isSSAOCavity()
- setSSAOCavityIntensity()
- getSSAOCavityIntensity()
- setSSAOCavityRadius()
- getSSAOCavityRadius()
- setSSAOIntensityReflection()
- getSSAOIntensityReflection()
- isSSAONoise()
- setSSAONoise()
- setSSAOQuality()
- getSSAOQuality()
- setSSAORayTracing()
- isSSAORayTracing()
- setSSAORayTracingDenoise()
- isSSAORayTracingDenoise()
- setSSAORayTracingThreshold()
- getSSAORayTracingThreshold()
- setSSAOResolution()
- getSSAOResolution()
- setSSGI()
- isSSGI()
- setSSGIQuality()
- getSSGIQuality()
- setSSGIRayTracing()
- isSSGIRayTracing()
- setSSGIRayTracingDenoise()
- isSSGIRayTracingDenoise()
- setSSGIRayTracingThreshold()
- getSSGIRayTracingThreshold()
- setSSGIResolution()
- getSSGIResolution()
- setSSGIResolutionColor()
- getSSGIResolutionColor()
- setSSR()
- isSSR()
- setSSRDenoise()
- isSSRDenoise()
- setSSRIncreasedAccuracy()
- isSSRIncreasedAccuracy()
- setSSRNoiseRay()
- getSSRNoiseRay()
- setSSRNoiseStep()
- getSSRNoiseStep()
- setSSRResolutionColor()
- getSSRResolutionColor()
- setSSRResolutionDepth()
- getSSRResolutionDepth()
- setSSRStepSize()
- getSSRStepSize()
- setSSRThreshold()
- getSSRThreshold()
- setSSRThresholdOcclusion()
- getSSRThresholdOcclusion()
- setSSRTGI()
- isSSRTGI()
- setSSRTGIFastTracing()
- isSSRTGIFastTracing()
- setSSRTGIIncreasedAccuracy()
- isSSRTGIIncreasedAccuracy()
- setSSRTGINoiseRay()
- getSSRTGINoiseRay()
- setSSRTGINumRays()
- getSSRTGINumRays()
- setSSRTGINumSteps()
- getSSRTGINumSteps()
- setSSRTGIResolution()
- getSSRTGIResolution()
- setSSRTGIResolutionDepth()
- getSSRTGIResolutionDepth()
- setSSRTGIStepSize()
- getSSRTGIStepSize()
- setSSRTGIUpscaling()
- isSSRTGIUpscaling()
- setSSS()
- isSSS()
- setSSSQuality()
- getSSSQuality()
- setSSSResolution()
- getSSSResolution()
- setStereo()
- getStereo()
- setSunShafts()
- isSunShafts()
- setSupersampling()
- getSupersampling()
- setTAAColorClamping()
- isTAAColorClamping()
- setTAAVelocityClamping()
- isTAAVelocityClamping()
- setTAAFixFlicker()
- isTAAFixFlicker()
- setTerrainAnisotropy()
- getTerrainAnisotropy()
- setTerrainRefinedAlbedo()
- isTerrainRefinedAlbedo()
- setTerrainRefinedMask()
- isTerrainRefinedMask()
- setTerrainRefinedNormal()
- isTerrainRefinedNormal()
- setTexturesAnisotropy()
- getTexturesAnisotropy()
- setTexturesFilter()
- getTexturesFilter()
- setTexturesMaxResolution()
- getTexturesMaxResolution()
- setTexturesMinResolution()
- getTexturesMinResolution()
- setTexturesQuality()
- setTransparentBlur()
- isTransparentBlur()
- setVirtualResolution()
- getVirtualResolution()
- setVREmulation()
- getVREmulation()
- setWaterAnisotropy()
- getWaterAnisotropy()
- setWaterEnvironmentProbes()
- isWaterEnvironmentProbes()
- setWaterFragmentDiscard()
- isWaterFragmentDiscard()
- setWaterLights()
- isWaterLights()
- setWaterOpacityDepth()
- isWaterOpacityDepth()
- setWaterRefractionQuality()
- getWaterRefractionQuality()
- setWaterShafts()
- isWaterShafts()
- setWaterShorelineWetness()
- isWaterShorelineWetness()
- setWaterSSR()
- isWaterSSR()
- setWaterSSRIncreasedAccuracy()
- isWaterSSRIncreasedAccuracy()
- setWaterSSRQuality()
- getWaterSSRQuality()
- convertImageSpecularToMetalness()
- convertColorSpecularToMetalness()
- renderPostMaterial()
- renderPostMaterial()
- renderPostMaterial()
- renderPostMaterial()
- renderPostMaterial()
- renderPostMaterial()
- PASS_TRANSPARENT_BLUR
Renderer Class
New Functions
- clearStates()
- clearShader()
- setBlendFunc()
- setBufferMask()
- setCameraPosition()
- setDepthFunc()
- hasGeodeticPivot()
- getHeight()
- getWidth()
- getObjects()
- setObliqueFrustum()
- isObliqueFrustum()
- setObliqueFrustumPlane()
- getObliqueFrustumPlane()
- setOldModelview()
- getOldModelview()
- setOldProjection()
- getOldProjection()
- getProjectionWithoutTAA()
- setPolygonCull()
- setPolygonOffset()
- setShaderParameters()
- setShaderParameters()
- setShaderParameters()
- setShaderParameters()
- setShaderParameters()
- isShadow()
- checkSkipFlags()
- getSkipFlags()
- isStereo()
- getStereoMode()
- getTextureAutoExposure()
- getTextureAuxiliary()
- getTextureBentNormal()
- getTextureClouds()
- getTextureColor()
- getTextureColorOld()
- getTextureColorOldReprojection()
- getTextureColorOpacity()
- getTextureCurrentDepth()
- getTextureDOFMask()
- getTextureEnvironmentProbes()
- getTextureGBufferAlbedo()
- getTextureGBufferGeodeticFlatPosition()
- getTextureGBufferLightmap()
- getTextureGBufferMaterialMask()
- getTextureGBufferNormal()
- getTextureGBufferShading()
- getTextureGBufferVelocity()
- getTextureLights()
- getTextureOpacityDepth()
- getTextureRefraction()
- getTextureSSR()
- getTextureSSAO()
- getTextureSSGI()
- getTextureTransparentBlur()
- getTextureRender()
- getPostTextureRender()
- getViewport()
- useDynamicReflections()
- useOcclusionQueries()
- usePostEffects()
- useShadows()
- useTAA()
- useVelocityBuffer()
- useVisualizer()
- RENDER_STEREO_VERTICAL
- RENDER_STEREO_HORIZONTAL
- RENDER_STEREO_DEFAULT
Sounds Class
Variable Class
vec4 Class
Viewport Class
New Functions
- addCallback()
- clearCallbacks()
- removeCallback()
- setRenderMode()
- getRenderMode()
- appendSkipFlags()
- removeSkipFlags()
- renderNodes()
- renderNodesImage2D()
- renderNodesImage2D()
- renderNodesTexture2D()
- NUM_CALLBACKS
- CALLBACK_ALL
- CALLBACK_BEGIN
- CALLBACK_END
- CALLBACK_BEGIN_ADAPTIVE_EXPOSURE
- CALLBACK_END_ADAPTIVE_EXPOSURE
- CALLBACK_BEGIN_AUXILIARY_BUFFER
- CALLBACK_END_AUXILIARY_BUFFER
- CALLBACK_BEGIN_CAMERA_EFFECTS
- CALLBACK_END_CAMERA_EFFECTS
- CALLBACK_BEGIN_CLOUDS
- CALLBACK_END_CLOUDS
- CALLBACK_BEGIN_COMPOSITE_DEFERRED
- CALLBACK_END_COMPOSITE_DEFERRED
- CALLBACK_BEGIN_DEBUG_MATERIALS
- CALLBACK_END_DEBUG_MATERIALS
- CALLBACK_BEGIN_OPACITY_DECALS
- CALLBACK_END_OPACITY_DECALS
- CALLBACK_BEGIN_OPACITY_ENVIRONMENT_PROBES
- CALLBACK_END_OPACITY_ENVIRONMENT_PROBES
- CALLBACK_BEGIN_OPACITY_GBUFFER
- CALLBACK_END_OPACITY_GBUFFER
- CALLBACK_BEGIN_OPACITY_LIGHTS
- CALLBACK_END_OPACITY_LIGHTS
- CALLBACK_BEGIN_POST_MATERIALS
- CALLBACK_END_POST_MATERIALS
- CALLBACK_BEGIN_REFRACTION_BUFFER
- CALLBACK_END_REFRACTION_BUFFER
- CALLBACK_BEGIN_SRGB_CORRECTION
- CALLBACK_END_SRGB_CORRECTION
- CALLBACK_BEGIN_SSAO
- CALLBACK_END_SSAO
- CALLBACK_BEGIN_SSGI
- CALLBACK_END_SSGI
- CALLBACK_BEGIN_SSR
- CALLBACK_END_SSR
- CALLBACK_BEGIN_SSRTGI
- CALLBACK_END_SSRTGI
- CALLBACK_BEGIN_TRANSPARENT_BLUR_BUFFER
- CALLBACK_END_TRANSPARENT_BLUR_BUFFER
- CALLBACK_BEGIN_TAA
- CALLBACK_END_TAA
- CALLBACK_BEGIN_TRANSPARENT
- CALLBACK_END_TRANSPARENT
- CALLBACK_BEGIN_VISUALIZER
- CALLBACK_END_VISUALIZER
- CALLBACK_BEGIN_WATER
- CALLBACK_END_WATER
- CALLBACK_BEGIN_WATER_DECALS
- CALLBACK_END_WATER_DECALS
- RENDER_DEPTH
- RENDER_DEPTH_GBUFFER
- RENDER_DEPTH_GBUFFER_FINAL
Utils Class
WorldCluster Class
| UNIGINE 2.4.1 | UNIGINE 2.5 |
|---|---|
| setShadowRadius() | Removed. |
| getShadowRadius() | Removed. |
Xml Class
Last update: 2017-07-03
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)