Deprecated and Experimental Compiler Warnings

instant3Dhub: Deprecated and Experimental Compiler Warnings

instant3Dhub

Detailed Description

Macros marking deprecated and experimental APIs and for controlling warning levels.

Macros
#define	INSTANT3DHUB_DEPRECATED(Version, Message)

#define	I3DH_VALIDATE_EXPERIMENTAL_API 1

#define	INSTANT3DHUB_EXPERIMENTAL(Version, Message)

#define	PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS PRAGMA_DISABLE_DEPRECATION_WARNINGS

#define	PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS PRAGMA_ENABLE_DEPRECATION_WARNINGS

Macro Definition Documentation

◆ I3DH_VALIDATE_EXPERIMENTAL_API

#define I3DH_VALIDATE_EXPERIMENTAL_API 1

Controls compiler warnings for experimental instant3Dhub Unreal Plugin APIs.

Available modes:

0: Off - No compiler warnings are generated when using experimental APIs.
1: Default - Usage of experimental APIs generates warnings. Warnings can be disabled on a case-by-case basis using PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS and PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS.

If not defined, the default mode is used.

Add the following line to your *.Build.cs file to disable warnings:

PrivateDefinitions.Add("I3DH_VALIDATE_EXPERIMENTAL_API=0");

◆ INSTANT3DHUB_DEPRECATED

#define INSTANT3DHUB_DEPRECATED	(		Version,
			Message )

Value:

[[deprecated(Message " - Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.")]]

Macro for marking up deprecated code, functions and types.

Features that are marked as deprecated are scheduled to be removed from the instant3Dhub plugin. If you are using a deprecated feature in your code, you should replace it before upgrading to the next release.

Note: This macro is intended for instant3Dhub plugin code only and should not be used in user code.

Parameters

Version	The plugin release number in which the feature was marked deprecated.
Message	A message containing upgrade notes.

◆ INSTANT3DHUB_EXPERIMENTAL

#define INSTANT3DHUB_EXPERIMENTAL	(		Version,
			Message )

Value:

[[deprecated(Message " - This API is experimental. As such, there is no guarantee that it won't change or be removed in future releases. Please use at your own risk.")]]

Macro for marking up experimental code, functions and types.

There is no guarantee that the API will not change or be removed in future instant3Dhub plugin releases. The API should be used at your own risk.

Note: This macro is intended for instant3Dhub plugin code only and should not be used in user code.

Parameters

Version	The plugin release number in which the feature was introduced. This does not give an indication for how long this API will exist as experimental. In a future release, this API may be removed or it may become officially supported.
Message	A message that may contain additional details about the usage of this experimental API.

◆ PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS

#define PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS PRAGMA_DISABLE_DEPRECATION_WARNINGS

Macro for temporarily disabling experimental warnings.

Example usage:

auto* HubConnector = ...;
PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS
HubConnector->GetAPI()->GetTransformAuthorityAPI()->SetWorldTransformWithAuthority(...);
PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS
// ... more code ...

◆ PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS

#define PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS PRAGMA_ENABLE_DEPRECATION_WARNINGS

Macro for re-enabling experimental warnings after PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS.

Example usage:

auto* HubConnector = ...;
PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS
HubConnector->GetAPI()->GetTransformAuthorityAPI()->SetWorldTransformWithAuthority(...);
PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS
// ... more code ...