API Migration
Major Changes#
- ...
Breaking Changes#
CustomSystemProxy Class#
New methods should be implemented in case you inherit from the CustomSystemProxy Class.
Dir Class#
FileSystem Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| createMount( const char *, const char *, int, const Vector<String> &, const Vector<String> &, const Vector<String> &, bool ) | Set of arguments changed. |
New Functions
FileSystemMount Class#
GeodeticPivot Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| toWorld( const Math::dvec3 &, GeodeticPivot::UP_AXIS ) | Set of arguments changed. |
| toWorldPreserveRotation( const Math::mat4 &, const Math::dvec3 &, GeodeticPivot::UP_AXIS ) | Set of arguments changed. |
| toWorldPreserveRotation( const Math::dmat4 &, const Math::dvec3 &, GeodeticPivot::UP_AXIS ) | Set of arguments changed. |
New Functions
InputGamePad Class#
InputJoystick Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| playForceFeedbackEffectConstant( float ) | Set of arguments changed. |
| playForceFeedbackEffectRamp( float, unsigned long long ) | Set of arguments changed. |
| playForceFeedbackEffectSineWave( float, unsigned int ) | Set of arguments changed. |
| playForceFeedbackEffectSquareWave( float, unsigned int ) | Set of arguments changed. |
| playForceFeedbackEffectTriangleWave( float, unsigned int ) | Set of arguments changed. |
| playForceFeedbackEffectSawtoothDownWave( float, unsigned int ) | Set of arguments changed. |
| playForceFeedbackEffectSawtoothUpWave( float, unsigned int ) | Set of arguments changed. |
New Functions
- playForceFeedbackEffectDamper( float, float, float, float )
- playForceFeedbackEffectFriction( float, float, float, float )
- playForceFeedbackEffectSpring( float, float, float, float, float, float )
- playForceFeedbackEffectSawtoothDownWave( float, float, float, int, unsigned int, unsigned int, unsigned int, unsigned int )
- playForceFeedbackEffectSawtoothUpWave( float, float, float, int, unsigned int, unsigned int, unsigned int, unsigned int )
- playForceFeedbackEffectTriangleWave( float, float, float, int, unsigned int, unsigned int, unsigned int, unsigned int )
- playForceFeedbackEffectSquareWave( float, float, float, int, unsigned int, unsigned int, unsigned int, unsigned int )
- playForceFeedbackEffectSineWave( float, float, float, int, unsigned int, unsigned int, unsigned int, unsigned int )
Json Class#
Landscape Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| getTemporaryTexture( const Math::ivec2 & ) | Removed. Landscape textures should now be created using the corresponding constructor LandscapeTextures::create( const Math::ivec2 & ). |
| releaseTemporaryTexture( const Ptr<LandscapeTextures> & ) | Removed. Landscape textures are now removed via the destructor of the LandscapeTextures class. |
New Functions
- asyncResetModifications( const UGUID & )
- asyncResetModifications( int, const UGUID & )
- asyncTextureDraw( const UGUID &, const Math::ivec2 &, const Math::ivec2 &, int, const Vector<Math::WorldBoundBox> &, const Vector<Math::WorldBoundBox> & )
- asyncTextureDraw( int, const UGUID &, const Math::ivec2 &, const Math::ivec2 &, int, const Vector<Math::WorldBoundBox> &, const Vector<Math::WorldBoundBox> & )
LandscapeMapFileSettings Class#
LandscapeMapFileSettings Class#
Light Class#
LightEnvironmentProbe Class#
LightVoxelProbe Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| setAmbientCubicFiltering( bool ) | Renamed as setDiffuseCubicFiltering( bool ). |
| isAmbientCubicFiltering( ) | Renamed as isDiffuseCubicFiltering( ). |
| setAmbientBias( float ) | Renamed as setDiffuseNormalBias( float ). |
| getAmbientBias( ) | Renamed as getDiffuseNormalBias( ). |
| setReflectionEnabled( bool ) | Renamed as setSpecularEnabled( bool ). |
| isReflectionEnabled( ) | Renamed as isSpecularEnabled( ). |
| setReflectionBias( float ) | Renamed as setSpecularReflectionBias( float ). |
| getReflectionBias( ) | Renamed as getSpecularReflectionBias( ). |
| setReflectionCubicFiltering( bool ) | Renamed as setSpecularCubicFiltering( bool ). |
| isReflectionCubicFiltering( ) | Renamed as isSpecularCubicFiltering( ). |
| setReflectionVisibilityRoughnessMin( float ) | Renamed as getSpecularVisibilityRoughnessMin( float ). |
| getReflectionVisibilityRoughnessMin( ) | Renamed as getSpecularVisibilityRoughnessMin( ). |
| setReflectionVisibilityRoughnessMax( float ) | Renamed as getSpecularVisibilityRoughnessMax( float ). |
| getReflectionVisibilityRoughnessMax( ) | Renamed as getSpecularVisibilityRoughnessMax( ). |
New Functions
- getDiffuseTangentBias( )
- setDiffuseTangentBias( float )
- setDiffuseTranslucentIndirect( float )
- getDiffuseTranslucentIndirect( )
- setDiffuseTranslucentSoftIndirect( float )
- getDiffuseTranslucentSoftIndirect( )
- setSpecularNormalBias( float )
- getSpecularNormalBias( )
- setSpecularTangentBias( float )
- getSpecularTangentBias( )
Material Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| TEXTURE_SOURCE_WBUFFER_WATER | Replaced with TEXTURE_SOURCE_WBUFFER_FOAM instead. |
New Functions
Mesh Class#
ObjectLandscapeTerrain Class#
ObjectMeshSkinned Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| getBoneSkiningTransform( int ) | Renamed as getBoneSkinningTransform( int ). |
PackageUng Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| PackageUng( const char *, const char * ) | Set of arguments changed. |
| clone( ) | Removed. |
| getCompressionType( ) | Removed. Use getCompressExtension( int ) instead. |
| getFileName( int ) | Removed. Use getFilePath( int ) instead. |
| removeFile( const char * ) | Removed. |
| removeFile( int ) | Removed. |
New Functions
Property Class#
PropertyParameter Class#
Render Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| getD3D11Factory( ) | Removed. |
| getD3D11Device( ) | Removed. |
| getD3D11Context( ) | Removed. |
| getD3D11Context( ) | Removed. |
| setSSRTGINoiseStep ( float ) | Removed. |
| getSSRTGINoiseStep ( ) | Removed. |
New Functions
- RENDER_VR_EMULATION_MODE_DISABLED
- RENDER_VR_EMULATION_MODE_VIVE
- RENDER_VR_EMULATION_MODE_VIVE_PRO
- RENDER_VR_EMULATION_MODE_VIVE_PRO_2
- RENDER_VR_EMULATION_MODE_VIVE_FOCUS_3
- RENDER_VR_EMULATION_MODE_VIVE_FOCUS_VISION
- RENDER_VR_EMULATION_MODE_VIVE_XR_ELITE
- RENDER_VR_EMULATION_MODE_OCULUS_RIFT
- RENDER_VR_EMULATION_MODE_QUEST_2
- RENDER_VR_EMULATION_MODE_QUEST_3S
- RENDER_VR_EMULATION_MODE_QUEST_3
- RENDER_VR_EMULATION_MODE_QUEST_PRO
- RENDER_VR_EMULATION_MODE_PICO_4
- RENDER_VR_EMULATION_MODE_VALVE_INDEX
- RENDER_VR_EMULATION_MODE_VARJO_VR_3
- RENDER_VR_EMULATION_MODE_VARJO_VR_4
- RENDER_VR_EMULATION_NUM_MODES
- RENDER_DLSS_PRESET_H
- RENDER_DLSS_PRESET_I
- RENDER_DLSS_PRESET_J
- RENDER_DLSS_PRESET_K
- isUpscaleModeSupported( Render::RENDER_UPSCALE_MODE )
- isReflectionDynamicAlphaFade( )
- setReflectionDynamicAlphaFade( bool )
- isSharpenDiagonalSamples( )
- setSharpenDiagonalSamples( bool )
- getSharpenBlurRadius( )
- setSharpenBlurRadius( int )
- getSharpenBlurDarkColorThresholdBias( )
- setSharpenBlurDarkColorThresholdBias( float )
- getSharpenBlurColorThreshold( )
- setSharpenBlurColorThreshold( float )
- getSharpenBlurSigma( )
- setSharpenBlurSigma( float )
- getEventBeginWaterGBuffer( )
- getEventEndWaterGBuffer( )
RenderState Class#
RenderTarget Class#
Profiler Class#
Shader Class#
StructuredBuffer Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| getD3D11ShaderResourceView( ) | Removed. |
| getD3D11UnorderedAccessView( ) | Removed. |
| isUsageCPUResource( ) | Removed. Use isUsageRender( ) instead. |
| isUsageGPUResource( ) | Removed. Use isUsageRender( ) instead. |
New Functions
Texture Class#
Unsupported texture formats (RGB8/RGB16/RGB32, R24B8, D24) were removed, see replacement details below.
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| create( const Ptr<Image> &, int, int, int ) | Set of arguments changed. |
| getD3D11DepthStencilView( ) | Removed. |
| getD3D11DepthStencilView( int ) | Removed. |
| getD3D11RenderTargetView( int ) | Removed. |
| getD3D11RenderTargetView( ) | Removed. |
| getD3D11ShaderResourceView( ) | Removed. |
| getD3D11Texture( ) | Removed. |
| getD3D11UnorderedAccessView( int ) | Removed. |
| fromD3D11Texture2D( void *, int, int, int, int, int ) | Removed. |
| fromD3D11Texture2D( void *, int, int, int, int ) | Removed. |
| FORMAT_RGB8 | Removed. Use FORMAT_RGBA8 instead. |
| FORMAT_RGB16 | Removed. Use FORMAT_RGBA16 instead. |
| FORMAT_RGB16U | Removed. Use FORMAT_RGBA16U instead. |
| FORMAT_RGB16F | Removed. Use FORMAT_RGBA16F instead. |
| FORMAT_RGB32U | Removed. Use FORMAT_RGBA32U instead. |
| FORMAT_RGB32F | Removed. Use FORMAT_RGBA32F instead. |
| FORMAT_R24B8 | Removed. Use FORMAT_R32F instead. |
| FORMAT_D24 | Removed. Use FORMAT_D32F instead (in case the Stencil was used, replace with FORMAT_D24S8/FORMAT_D32FS8). |
VR Class#
New Functions
- getInputRuntimeVersion( )
- setRenderWhileHMDIdle( bool )
- isRenderWhileHMDIdle( )
- hasFeatureNativePeripheralRendering( )
- setPeripheralRenderingFocusDeadzone( float )
- getPeripheralRenderingFocusDeadzone( )
- setPeripheralRenderingFocusScale( const Math::vec2 & )
- getPeripheralRenderingFocusScale( )
- setPeripheralRenderingFOVScale( const Math::vec2 & )
- getPeripheralRenderingFOVScale( )
- setPeripheralRenderingBorderWidth( float )
- getPeripheralRenderingBorderWidth( )
- setPeripheralRenderingDebugEnabled( bool )
- isPeripheralRenderingDebugEnabled( )
VREyeTracking Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| getRawCaptureTime( llong ) | Renamed as getCaptureTime( llong ) |
New Functions
VRHand Class#
| UNIGINE 2.19.1 | UNIGINE 2.20 |
|---|---|
| isActive( ) | Renamed as isTracking( ). |
VRHandTracking Class#
VRMixedReality Class#
Viewport Class#
ViewportData Class#
Visualizer Class#
New Functions
- renderSolidMesh( const char *, const Math::Mat4 &, const Math::vec4 &, float, bool )
- renderSolidMesh( const UGUID &, const Math::Mat4 &, const Math::vec4 &, float, bool )
- renderSolidMesh( const Ptr<MeshRender> &, const Math::Mat4 &, const Math::vec4 &, float, bool )
- renderMesh( const char *, const Math::Mat4 &, const Math::vec4 &, float, bool )
- renderMesh( const UGUID &, const Math::Mat4 &, const Math::vec4 &, float, bool )
- renderMesh( const Ptr<MeshRender> &, const Math::Mat4 &, const Math::vec4 &, float, bool )
Widget Class#
WidgetTreeBox Class#
WidgetVBox Class#
New Functions
- getBackgroundCustomFilter( )
- setBackgroundCustomFilter( int )
- isBackgroundCustomFilterEnabled( )
- setBackgroundCustomFilterEnabled( bool )
- getBackground9SliceScale( )
- setBackground9SliceScale( float )
- getBackground9SliceOffsets( )
- setBackground9SliceOffsets( float, float, float, float )
- isBackground9Sliced( )
- setBackground9Sliced( bool )
- getBackgroundRender( )
- setBackgroundRender( const Ptr<Texture> &, int )
- getBackgroundTexture( )
- setBackgroundTexture( const char * )
- getBackgroundImage( )
- setBackgroundImage( const Ptr<Image> &, int )
IG::Manager Class#
IG::Entity Class#
The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2025-06-09
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)