ADLX SDK v1.0

Author: ericjunwei

SDK/ADLXHelper/Windows/C/ADLXHelper.h

@@ -23,12 +23,10 @@
 * N/A
 *
 * @retvalues
-* @ENG_START_DOX
 * If __ADLXHelper_Initialize__ is successfully executed, __ADLX_OK__ is returned.<br>
 * If __ADLXHelper_Initialize__ is not successfully executed, an error code is returned.<br>
 * If ADLX was previously successfully initialized with any of the initialization functions, __ADLX_ALREADY_INITIALIZED__ is returned.<br>
 * Refer to @ref ADLX_RESULT for success codes and error codes.
-* @ENG_END_DOX
 *
 * @detaileddesc
 * @ENG_START_DOX
@@ -55,12 +53,10 @@ ADLX_RESULT             ADLXHelper_Initialize();
 * N/A
 *
 * @retvalues
-* @ENG_START_DOX
 * If __ADLXHelper_InitializeWithIncompatibleDriver__ is successfully executed, __ADLX_OK__ is returned.<br>
 * If __ADLXHelper_InitializeWithIncompatibleDriver__ is not successfully executed, an error code is returned.<br>
 * If ADLX was previously successfully initialized with any of the initialization functions, __ADLX_ALREADY_INITIALIZED__ is returned.<br>
 * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
-* @ENG_END_DOX
 *
 * @detaileddesc
 * @ENG_START_DOX
@@ -88,12 +84,10 @@ ADLX_RESULT             ADLXHelper_InitializeWithIncompatibleDriver();
 * @paramrow{2.,[in],adlMainMemoryFree,@ref ADLX_ADL_Main_Memory_Free,@ENG_START_DOX The callback handler of the memory deallocation function. @ENG_END_DOX}
 *
 * @retvalues
-* @ENG_START_DOX
 * If __ADLXHelper_InitializeWithCallerAdl__ is successfully executed, __ADLX_OK__ is returned.<br>
 * If __ADLXHelper_InitializeWithCallerAdl__ is not successfully executed, an error code is returned.<br>
 * If ADLX was previously successfully initialized with any of the Initialize versions, __ADLX_ALREADY_INITIALIZED__ is returned.<br>
 * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
-* @ENG_END_DOX
 *
 * @detaileddesc
 * @ENG_START_DOX
@@ -122,11 +116,9 @@ ADLX_RESULT             ADLXHelper_InitializeWithCallerAdl (adlx_handle adlConte
 * N/A
 *
 * @retvalues
-* @ENG_START_DOX
 * If __ADLXHelper_Terminate__ is successfully executed, __ADLX_OK__ is returned.<br>
 * If __ADLXHelper_Terminate__ is not successfully executed, an error code is returned.<br>
 * Refer to @ref ADLX_RESULT for success codes and error codes.
-* @ENG_END_DOX
 *
 * @detaileddesc
 * @ENG_START_DOX
@@ -154,11 +146,8 @@ ADLX_RESULT             ADLXHelper_Terminate();
 * N/A
 *
 * @retvalues
-* @ENG_START_DOX
 * If ADLX was successfully initialized before this function call, the @ref DOX_IADLXSystem interface is returned.<br>
 * If ADLX was not successfully initialized, __nullptr__ is returned.
-* @ENG_END_DOX
-*
 * @requirements
 * @DetailsTable{#include "ADLXHelper/Windows/C/ADLXHelper.h", @ADLX_First_Ver}
 */
@@ -178,13 +167,11 @@ IADLXSystem*            ADLXHelper_GetSystemServices ();
 * N/A
 *
 * @retvalues
-* @ENG_START_DOX
 * If ADLX was successfully initialized with ADL, a valid pointer of the @ref DOX_IADLMapping interface is returned.<br>
 * If ADLX was initialized under any of the following circumstances, __nullptr__ is returned.<br>
 * - ADLX initialization was with other initialization methods.<br>
 * - ADLX initialization was failed.<br>
 * - ADLX initialization was not called.<br>
-* @ENG_END_DOX
 *
 * @detaileddesc
 * @ENG_START_DOX
@@ -210,10 +197,7 @@ IADLMapping*            ADLXHelper_GetAdlMapping();
 * N/A
 *
 * @retvalues
-* @ENG_START_DOX
 * The full version of ADLX.
-* @ENG_END_DOX
-*
 * @requirements
 * @DetailsTable{#include "ADLXHelper/Windows/C/ADLXHelper.h", @ADLX_First_Ver}
 */
@@ -233,10 +217,7 @@ adlx_uint64             ADLXHelper_QueryFullVersion();
 * N/A
 *
 * @retvalues
-* @ENG_START_DOX
 * The version of ADLX.
-* @ENG_END_DOX
-*
 * @requirements
 * @DetailsTable{#include "ADLXHelper/Windows/C/ADLXHelper.h", @ADLX_First_Ver}
 */

SDK/ADLXHelper/Windows/Cpp/ADLXHelper.h

@@ -27,10 +27,7 @@ class ADLXHelper
     * N/A
     *
     * @retvalues
-    * @ENG_START_DOX
     * An ADLXHelper object.
-    * @ENG_END_DOX
-    *
     * @requirements
     * @DetailsTable{#include "ADLXHelper/Windows/Cpp/ADLXHelper.h", @ADLX_First_Ver}
     */
@@ -56,7 +53,6 @@ class ADLXHelper
     * @ENG_START_DOX
     * @details This method calls @ref page_cppHelpTerminate.
     * @ENG_END_DOX
-    *
     * @requirements
     * @DetailsTable{#include "ADLXHelper/Windows/Cpp/ADLXHelper.h", @ADLX_First_Ver}
     */
@@ -79,12 +75,10 @@ class ADLXHelper
     * @paramrow{2.,[in],adlMainMemoryFree,@ref ADLX_ADL_Main_Memory_Free,@ENG_START_DOX The callback handler of the memory deallocation. @ENG_END_DOX}
     *
     * @retvalues
-    * @ENG_START_DOX
     * If __InitializeWithCallerAdl__ is successfully executed, __ADLX_OK__ is returned.<br>
     * If __InitializeWithCallerAdl__ is not successfully executed, an error code is returned.<br>
     * If ADLX was previously successfully initialized with any of the Initialize versions, __ADLX_ALREADY_INITIALIZED__ is returned.<br>
     * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
-    * @ENG_END_DOX
     *
     * @detaileddesc
     * @ENG_START_DOX
@@ -114,19 +108,15 @@ class ADLXHelper
     * N/A
     *
     * @retvalues
-    * @ENG_START_DOX
     * If __Initialize__ is successfully executed, __ADLX_OK__ is returned.<br>
     * If __Initialize__ is not successfully executed, an error code is returned.<br>
     * If ADLX was previously successfully initialized with any of the initialization functions, __ADLX_ALREADY_INITIALIZED__ is returned.<br>
     * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
-    * @ENG_END_DOX
     *
     * @detaileddesc
-    * @ENG_START_DOX
     * @details
     * This method is used when an application does not use the ADL library and initializes ADLX with default parameters.<br>
     * For more information for initializing ADLX with default parameters, refer to @ref @adlx_gpu_support "ADLX GPU Support".<br>
-    * @ENG_END_DOX
     *
     * @requirements
     * @DetailsTable{#include "ADLXHelper/Windows/Cpp/ADLXHelper.h", @ADLX_First_Ver}
@@ -147,19 +137,15 @@ class ADLXHelper
     * N/A
     *
     * @retvalues
-    * @ENG_START_DOX
     * If __InitializeWithIncompatibleDriver__ is successfully executed, __ADLX_OK__ is returned.<br>
     * If __InitializeWithIncompatibleDriver__ is not successfully executed, an error code is returned.<br>
     * If ADLX was previously successfully initialized with any of the Initialize versions, __ADLX_ALREADY_INITIALIZED__ is returned.<br>
     * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
-    * @ENG_END_DOX
     *
     * @detaileddesc
-    * @ENG_START_DOX
     * @details
     * This method is used when an application does not use the ADL library and initializes ADLX to consider AMD GPUs using legacy AMD graphics driver.<br>
     * For more information for initializing ADLX with a legacy driver, refer to @ref @adlx_gpu_support "ADLX GPU Support".<br>
-    * @ENG_END_DOX
     *
     * @requirements
     * @DetailsTable{#include "ADLXHelper/Windows/Cpp/ADLXHelper.h", @ADLX_First_Ver}
@@ -184,18 +170,14 @@ class ADLXHelper
     * N/A
     *
     * @retvalues
-    * @ENG_START_DOX
     * If __Terminate__ is successfully executed, __ADLX_OK__ is returned.<br>
     * If __Terminate__ is not successfully executed, an error code is returned.<br>
     * Refer to @ref ADLX_RESULT for success codes and error codes.
-    * @ENG_END_DOX
     *
     * @detaileddesc
-    * @ENG_START_DOX
     * @details
     * Any interface obtained from ADLX that is not released becomes invalid.<br>
     * Any attempt of calling ADLX interface after termination could result in errors such as exceptions or crashes.<br>
-    * @ENG_END_DOX
     *
     * @requirements
     *
@@ -219,9 +201,7 @@ class ADLXHelper
     * N/A
     *
     * @retvalues
-    * @ENG_START_DOX
     * The full version of ADLX.
-    * @ENG_END_DOX
     *
     * @requirements
     * @DetailsTable{#include "ADLXHelper/Windows/Cpp/ADLXHelper.h", @ADLX_First_Ver}
@@ -242,9 +222,7 @@ class ADLXHelper
     * N/A
     *
     * @retvalues
-    * @ENG_START_DOX
     * The version of ADLX.
-    * @ENG_END_DOX
     *
     * @requirements
     * @DetailsTable{#include "ADLXHelper/Windows/Cpp/ADLXHelper.h", @ADLX_First_Ver}
@@ -265,10 +243,8 @@ class ADLXHelper
     * N/A
     *
     * @retvalues
-    * @ENG_START_DOX
     * If ADLX was successfully initialized before this method call, the @ref DOX_IADLXSystem interface is returned.<br>
     * If ADLX was not successfully initialized, __nullptr__ is returned.
-    * @ENG_END_DOX
     *
     * @requirements
     * @DetailsTable{#include "ADLXHelper/Windows/Cpp/ADLXHelper.h", @ADLX_First_Ver}
@@ -289,19 +265,15 @@ class ADLXHelper
     * N/A
     *
     * @retvalues
-    * @ENG_START_DOX
     * If ADLX was successfully initialized with ADL, a valid pointer of the @ref DOX_IADLMapping interface is returned.<br>
     * If ADLX was initialized under any of the following circumstances, __nullptr__ is returned.<br>
     * - ADLX initialization was with other initialization methods.<br>
     * - ADLX initialization was failed.<br>
     * - ADLX initialization was not called.<br>
-    * @ENG_END_DOX
     *
     * @detaileddesc
-    * @ENG_START_DOX
     * @details
     * __GetAdlMapping__ is used to convert data between ADL and ADLX in applications where ADLX was initialized with @ref page_cppHelpInitializeWithCallerAdl.
-    * @ENG_END_DOX
     *
     * @requirements
     * @DetailsTable{#include "ADLXHelper/Windows/Cpp/ADLXHelper.h", @ADLX_First_Ver}

SDK/Include/ADLX.h

@@ -187,17 +187,17 @@ extern "C"
     * If the full version is successfully returned, __ADLX_OK__ is returned.<br>
     * If the full version is not successfully returned, an error code is returned.<br>
     * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
+    * @ENG_END_DOX
     * @detaileddesc
     * The pointer of the function is returned by the @ref adlx_get_proc_address using the @ref ADLX_QUERY_FULL_VERSION_FUNCTION_NAME as the function name.
-    * @ENG_END_DOX
     * @requirements
     * @DetailsTable{#include "ADLX.h", @ADLX_First_Ver}
     */
 
     /**
     * @typedef ADLXQueryFullVersion_Fn
     * @ingroup ADLXDefs
-    * @ENG_START_DOX The typedef of QueryFullVersion function. @ENG_END_DOX
+    * The typedef of QueryFullVersion function.
     * @definition
     *  @codeStart
     *   typedef @ref ADLX_RESULT (ADLX_CDECL_CALL *QueryFullVersion_Fn)(adlx_uint64* fullVersion)
@@ -223,17 +223,17 @@ extern "C"
     * If the version is successfully returned, __ADLX_OK__ is returned.<br>
     * If the version is not successfully returned, an error code is returned.<br>
     * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
+    * @ENG_END_DOX
     * @detaileddesc
     * The pointer of the function is returned by the @ref adlx_get_proc_address using the @ref ADLX_QUERY_VERSION_FUNCTION_NAME as the function name.
-    * @ENG_END_DOX
     * @requirements
     * @DetailsTable{#include "ADLX.h", @ADLX_First_Ver}
     */
 
     /**
     * @typedef ADLXQueryVersion_Fn
     * @ingroup ADLXDefs
-    * @ENG_START_DOX The typedef of QueryVersion function. @ENG_END_DOX
+    * The typedef of QueryVersion function.
     * @definition
     *  @codeStart
     *   typedef @ref ADLX_RESULT (ADLX_CDECL_CALL *QueryVersion_Fn)(const char** version)
@@ -260,17 +260,17 @@ extern "C"
     * If ADLX was successfully initialized, __ADLX_OK__ is returned.<br>
     * If ADLX was not successfully initialized, an error code is returned.<br>
     * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
+    * @ENG_END_DOX
     * @detaileddesc
     * The pointer of the function is returned by the @ref adlx_get_proc_address using the @ref ADLX_INIT_FUNCTION_NAME or @ref ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME as the function name.
-    * @ENG_END_DOX
     * @requirements
     * @DetailsTable{#include "ADLX.h", @ADLX_First_Ver}
     */
 
     /**
     * @typedef ADLXInitialize_Fn
     * @ingroup ADLXDefs
-    * @ENG_START_DOX The typedef of ADLXInitialize function. @ENG_END_DOX
+    * The typedef of ADLXInitialize function.
     * @definition
     *  @codeStart
     *  typedef @ref ADLX_RESULT (ADLX_CDECL_CALL *ADLXInitialize_Fn)(adlx_uint64 version, @ref DOX_IADLXSystem** ppSystem)
@@ -300,17 +300,17 @@ extern "C"
     * If ADLX was successfully initialized, __ADLX_OK__ is returned.<br>
     * If ADLX was not successfully initialized, an error code is returned.<br>
     * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
+    * @ENG_END_DOX
     * @detaileddesc
     * The pointer of the function is returned by the @ref adlx_get_proc_address using the @ref ADLX_INIT_WITH_CALLER_ADL_FUNCTION_NAME as the function name.
-    * @ENG_END_DOX
     * @requirements
     * @DetailsTable{#include "ADLX.h", @ADLX_First_Ver}
     */
 
     /**
     * @typedef ADLXInitializeWithCallerAdl_Fn
     * @ingroup ADLXDefs
-    * @ENG_START_DOX The typedef of ADLXInitializeWithCallerAdl function. @ENG_END_DOX
+    * The typedef of ADLXInitializeWithCallerAdl function.
     * @definition
     *  @codeStart
     *   typedef @ref ADLX_RESULT (ADLX_CDECL_CALL *ADLXInitializeWithCallerAdl_Fn)(adlx_uint64 version, @ref DOX_IADLXSystem** ppSystem, @ref DOX_IADLMapping** ppAdlMapping, adlx_handle adlContext, @ref ADLX_ADL_Main_Memory_Free adlMainMemoryFree)
@@ -336,17 +336,17 @@ extern "C"
     * If the function is successfully executed, __ADLX_OK__ is returned.<br>
     * If the function is not successfully executed, an error code is returned.<br>
     * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
+    * @ENG_END_DOX
     * @detaileddesc
     * The pointer of the function is returned by the @ref adlx_get_proc_address using the @ref ADLX_TERMINATE_FUNCTION_NAME as the function name.
-    * @ENG_END_DOX
     * @requirements
     * @DetailsTable{#include "ADLX.h", @ADLX_First_Ver}
     */
 
     /**
     * @typedef ADLXTerminate_Fn
     * @ingroup ADLXDefs
-    * @ENG_START_DOX The typedef of ADLXTerminate function. @ENG_END_DOX
+    * The typedef of ADLXTerminate function.
     * @definition
     *  @codeStart
     *   typedef ADLX_RESULT (ADLX_CDECL_CALL *ADLXTerminate_Fn)()

SDK/Include/ADLXDefines.h

@@ -886,21 +886,6 @@ typedef enum
 } ADLX_3DLUT_COLORSPACE;
 #pragma endregion ADLX_3DLUT_COLORSPACE
 
-#pragma region ADLX_ANTILAG_STATE
-/**
- * @enum ADLX_ANTILAG_STATE
- * @ingroup enumerations
- * @ENG_START_DOX
- * @brief Indicates the state of Anti Lag.
- * @ENG_END_DOX
- */
-typedef enum
-{
-    ANTILAG = 0,                        /**< @ENG_START_DOX The Antilag level is AntiLag. @ENG_END_DOX */
-    ANTILAGNEXT,                        /**< @ENG_START_DOX The Antilag level is AntiLag Next. @ENG_END_DOX */
-} ADLX_ANTILAG_STATE;
-#pragma endregion ADLX_ANTILAG_STATE
-
 #pragma endregion ADLX data types
 
 //-------------------------------------------------------------------------------------------------
@@ -1225,7 +1210,6 @@ namespace adlx
     }; //IADLXInterfacePtr_T
 
     typedef IADLXInterfacePtr_T<IADLXInterface> IADLXInterfacePtr;
-
 }   // namespace adlx
 #endif //__cplusplus
 #pragma endregion IADLXInterfacePtr