ADLX update

GPUOpen-LibrariesAndSDKs · Dec 12, 2022 · a33f91e · a33f91e
1 parent dbe9b24
commit a33f91e
Show file tree

Hide file tree

Showing 73 changed files with 1,086 additions and 1,033 deletions.
diff --git a/SDK/Include/I3DSettings.h b/SDK/Include/I3DSettings.h
@@ -2109,8 +2109,10 @@ namespace adlx
         * @addinfo
         * @ENG_START_DOX
         * Radeon Super Resolution is an upscaling feature for faster game frame rates. <br>
-        * __Note:__ On some AMD GPUs, Radeon Super Resolution is mutually exclusive with @ref DOX_IADLX3DChill "AMD Radeon Chill",  @ref DOX_IADLX3DBoost "AMD Radeon Boost", @ref DOX_IADLX3DImageSharpening "AMD Radeon Image Sharpening", @ref DOX_IADLXDisplayIntegerScaling "Integer Display Scaling", and @ref DOX_IADLXDisplayScalingMode_GetMode "Center Scaling". If either of the mutually exclusive features is enabled, Radeon Super Resolution is automatically disabled.<br>
-        * Radeon Super Resolution requires @ref DOX_IADLXDisplayGPUScaling "GPU scaling". By enabling Radeon Super Resolution, GPU scaling is automatically enabled. By disabling GPU scaling when Radeon Super Resolution is enabled, Radeon Super Resolution is automatically disabled.
+        *
+        * __Note:__ @ref DOX_IADLXDisplayGPUScaling "GPU scaling" is a requirement for Radeon Super Resolution. When Radeon Super Resolution is enabled, GPU scaling is automatically enabled. If GPU scaling is disabled while Radeon Super Resolution is enabled, Radeon Super Resolution is automatically disabled.
+        *
+        * On some AMD GPUs, Radeon Super Resolution is mutually exclusive with @ref DOX_IADLX3DChill "AMD Radeon Chill", @ref DOX_IADLX3DBoost "AMD Radeon Boost", @ref DOX_IADLX3DImageSharpening "AMD Radeon Image Sharpening", @ref DOX_IADLXDisplayIntegerScaling "Integer Display Scaling", and @ref DOX_IADLXDisplayScalingMode_GetMode "Center Scaling". When Radeon Super Resolution is enabled, the mutually exclusive features are automatically disabled.<br>
         * @ENG_END_DOX
         *
         *@requirements
@@ -2139,8 +2141,10 @@ namespace adlx
         * @addinfo
         * @ENG_START_DOX
         * Radeon Super Resolution is an upscaling feature for faster game frame rates. <br>
-        * __Note:__ On some AMD GPUs, Radeon Super Resolution is mutually exclusive with @ref DOX_IADLX3DChill "AMD Radeon Chill", @ref DOX_IADLX3DBoost "AMD Radeon Boost", @ref DOX_IADLX3DImageSharpening "AMD Radeon Image Sharpening", @ref DOX_IADLXDisplayIntegerScaling "Integer Display Scaling", and @ref DOX_IADLXDisplayScalingMode_GetMode "Center Scaling". If Radeon Super Resolution is enabled, all the mutually exclusive features are automatically disabled. However, the configurations of the disabled feature is preserved.<br>
-        * Radeon Super Resolution requires @ref DOX_IADLXDisplayGPUScaling "GPU scaling". By enabling Radeon Super Resolution, GPU scaling is automatically enabled.
+        *
+        * __Note:__ @ref DOX_IADLXDisplayGPUScaling "GPU scaling" is a requirement for Radeon Super Resolution. When Radeon Super Resolution is enabled, GPU scaling is automatically enabled. If GPU scaling is disabled while Radeon Super Resolution is enabled, Radeon Super Resolution is automatically disabled.
+        *
+        * On some AMD GPUs, Radeon Super Resolution is mutually exclusive with @ref DOX_IADLX3DChill "AMD Radeon Chill", @ref DOX_IADLX3DBoost "AMD Radeon Boost", @ref DOX_IADLX3DImageSharpening "AMD Radeon Image Sharpening", @ref DOX_IADLXDisplayIntegerScaling "Integer Display Scaling", and @ref DOX_IADLXDisplayScalingMode_GetMode "Center Scaling". When Radeon Super Resolution is enabled, the mutually exclusive features are automatically disabled.<br>
 
         * @ENG_END_DOX
         *

diff --git a/SDK/Include/IDisplaySettings.h b/SDK/Include/IDisplaySettings.h
@@ -1008,19 +1008,19 @@ namespace adlx
         virtual ADLX_RESULT ADLX_STD_CALL IsSupportedPixelFormat (ADLX_PIXEL_FORMAT pixelFormat, adlx_bool* supportd) = 0;
         /**
         *@page DOX_IADLXDisplayPixelFormat_IsSupportedRGB444Full IsSupportedRGB444Full
-        *@ENG_START_DOX @brief Checks if the given pixel format/RGB 4:4:4 PC Standard (Full RGB) is supported on a display. @ENG_END_DOX
+        *@ENG_START_DOX @brief Checks if the RGB 4:4:4 PC Standard (Full RGB) pixel format is supported on a display. @ENG_END_DOX
         *
         *@syntax
         *@codeStart
         * @ref ADLX_RESULT    IsSupportedRGB444Full (adlx_bool* supported)
         *@codeEnd
         *
         *@params
-        * @paramrow{1.,[out],supported,adlx_bool*,@ENG_START_DOX The pointer to a variable where the support state of the pixel format/RGB 4:4:4 PC Standard (Full RGB) is returned. The variable is __true__ if the pixel format/RGB 4:4:4 PC Standard (Full RGB) is supported. The variable is __false__ if pixel format/RGB 4:4:4 PC Standard (Full RGB) is not supported. @ENG_END_DOX}
+        * @paramrow{1.,[out],supported,adlx_bool*,@ENG_START_DOX The pointer to a variable where the support state of the RGB 4:4:4 PC Standard (Full RGB) pixel format is returned. The variable is __true__ if the RGB 4:4:4 PC Standard (Full RGB) pixel format is supported. The variable is __false__ if the RGB 4:4:4 PC Standard (Full RGB) pixel format is not supported. @ENG_END_DOX}
         *
         *@retvalues
-		*@ENG_START_DOX  If the support state of the pixel format/RGB 4:4:4 PC Standard (Full RGB) is successfully returned, __ADLX_OK__ is returned. <br>
-        * If the support state of the pixel format/RGB 4:4:4 PC Standard (Full RGB) is not successfully returned, an error code is returned. <br>
+		*@ENG_START_DOX  If the support state of the RGB 4:4:4 PC Standard (Full RGB) pixel format is successfully returned, __ADLX_OK__ is returned. <br>
+        * If the support state of the RGB 4:4:4 PC Standard (Full RGB) pixel format is not successfully returned, an error code is returned. <br>
         * Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
         *
         *@requirements
@@ -1030,19 +1030,19 @@ namespace adlx
         virtual ADLX_RESULT ADLX_STD_CALL IsSupportedRGB444Full (adlx_bool* supportd) = 0;
         /**
         *@page DOX_IADLXDisplayPixelFormat_IsSupportedYCbCr444 IsSupportedYCbCr444
-        *@ENG_START_DOX @brief Checks if the given pixel format/YCbCr 4:4:4 is supported on a display. @ENG_END_DOX
+        *@ENG_START_DOX @brief Checks if the YCbCr 4:4:4 pixel format is supported on a display. @ENG_END_DOX
         *
         *@syntax
         *@codeStart
         * @ref ADLX_RESULT    IsSupportedYCbCr444 (adlx_bool* supported)
         *@codeEnd
         *
         *@params
-        * @paramrow{1.,[out],supported,adlx_bool*,@ENG_START_DOX The pointer to a variable where the support state of the pixel format/YCbCr 4:4:4 is returned. The variable is __true__ if the pixel format/YCbCr 4:4:4 is supported. The variable is __false__ if pixel format/YCbCr 4:4:4 is not supported. @ENG_END_DOX}
+        * @paramrow{1.,[out],supported,adlx_bool*,@ENG_START_DOX The pointer to a variable where the support state of the YCbCr 4:4:4 pixel format is returned. The variable is __true__ if the YCbCr 4:4:4 pixel format is supported. The variable is __false__ if the YCbCr 4:4:4 pixel format is not supported. @ENG_END_DOX}
         *
         *@retvalues
-		*@ENG_START_DOX  If the support state of the pixel format/YCbCr 4:4:4 is successfully returned, __ADLX_OK__ is returned. <br>
-        * If the support state of the pixel format/YCbCr 4:4:4 is not successfully returned, an error code is returned. <br>
+		*@ENG_START_DOX  If the support state of the YCbCr 4:4:4 pixel format is successfully returned, __ADLX_OK__ is returned. <br>
+        * If the support state of the YCbCr 4:4:4 pixel format is not successfully returned, an error code is returned. <br>
         * Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
         *
         *@requirements
@@ -1052,19 +1052,19 @@ namespace adlx
         virtual ADLX_RESULT ADLX_STD_CALL IsSupportedYCbCr444 (adlx_bool* supportd) = 0;
         /**
         *@page DOX_IADLXDisplayPixelFormat_IsSupportedYCbCr422 IsSupportedYCbCr422
-        *@ENG_START_DOX @brief Checks if the given pixel format/YCbCr 4:2:2 is supported on a display. @ENG_END_DOX
+        *@ENG_START_DOX @brief Checks if the YCbCr 4:2:2 pixel format is supported on a display. @ENG_END_DOX
         *
         *@syntax
         *@codeStart
         * @ref ADLX_RESULT    IsSupportedYCbCr422 (adlx_bool* supported)
         *@codeEnd
         *
         *@params
-        * @paramrow{1.,[out],supported,adlx_bool*,@ENG_START_DOX The pointer to a variable where the support state of the pixel format/YCbCr 4:2:2 is returned. The variable is __true__ if the pixel format/YCbCr 4:2:2 is supported. The variable is __false__ if pixel format/YCbCr 4:2:2 is not supported. @ENG_END_DOX}
+        * @paramrow{1.,[out],supported,adlx_bool*,@ENG_START_DOX The pointer to a variable where the support state of the YCbCr 4:2:2 pixel format is returned. The variable is __true__ if the YCbCr 4:2:2 pixel format is supported. The variable is __false__ if the YCbCr 4:2:2 pixel format is not supported. @ENG_END_DOX}
         *
         *@retvalues
-		*@ENG_START_DOX  If the support state of the pixel format/YCbCr 4:2:2 is successfully returned, __ADLX_OK__ is returned. <br>
-        * If the support state of the pixel format/YCbCr 4:2:2 is not successfully returned, an error code is returned. <br>
+		*@ENG_START_DOX  If the support state of the YCbCr 4:2:2 pixel format is successfully returned, __ADLX_OK__ is returned. <br>
+        * If the support state of the YCbCr 4:2:2 pixel format is not successfully returned, an error code is returned. <br>
         * Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
         *
         *@requirements
@@ -1074,19 +1074,19 @@ namespace adlx
         virtual ADLX_RESULT ADLX_STD_CALL IsSupportedYCbCr422 (adlx_bool* supportd) = 0;
         /**
         *@page DOX_IADLXDisplayPixelFormat_IsSupportedRGB444Limited IsSupportedRGB444Limited
-        *@ENG_START_DOX @brief Checks if the given pixel format/RGB 4:4:4 Studio (Limited RGB) is supported on a display. @ENG_END_DOX
+        *@ENG_START_DOX @brief Checks if the RGB 4:4:4 Studio (Limited RGB) pixel format is supported on a display. @ENG_END_DOX
         *
         *@syntax
         *@codeStart
         * @ref ADLX_RESULT    IsSupportedRGB444Limited (adlx_bool* supported)
         *@codeEnd
         *
         *@params
-        * @paramrow{1.,[out],supported,adlx_bool*,@ENG_START_DOX The pointer to a variable where the support state of the pixel format/RGB 4:4:4 Studio (Limited RGB) is returned. The variable is __true__ if the pixel format/RGB 4:4:4 Studio (Limited RGB) is supported. The variable is __false__ if pixel format/RGB 4:4:4 Studio (Limited RGB) is not supported. @ENG_END_DOX}
+        * @paramrow{1.,[out],supported,adlx_bool*,@ENG_START_DOX The pointer to a variable where the support state of the RGB 4:4:4 Studio (Limited RGB) pixel format is returned. The variable is __true__ if the RGB 4:4:4 Studio (Limited RGB) pixel format is supported. The variable is __false__ if the RGB 4:4:4 Studio (Limited RGB) pixel format is not supported. @ENG_END_DOX}
         *
         *@retvalues
-		*@ENG_START_DOX  If the support state of the pixel format/RGB 4:4:4 Studio (Limited RGB) is successfully returned, __ADLX_OK__ is returned. <br>
-        * If the support state of the pixel format/RGB 4:4:4 Studio (Limited RGB) is not successfully returned, an error code is returned. <br>
+		*@ENG_START_DOX  If the support state of the RGB 4:4:4 Studio (Limited RGB) pixel format is successfully returned, __ADLX_OK__ is returned. <br>
+        * If the support state of the RGB 4:4:4 Studio (Limited RGB) pixel format is not successfully returned, an error code is returned. <br>
         * Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
         *
         *@requirements
@@ -1096,19 +1096,19 @@ namespace adlx
         virtual ADLX_RESULT ADLX_STD_CALL IsSupportedRGB444Limited (adlx_bool* supportd) = 0;
         /**
         *@page DOX_IADLXDisplayPixelFormat_IsSupportedYCbCr420 IsSupportedYCbCr420
-        *@ENG_START_DOX @brief Checks if the given pixel format/YCbCr 4:2:0 is supported on a display. @ENG_END_DOX
+        *@ENG_START_DOX @brief Checks if the YCbCr 4:2:0 pixel format is supported on a display. @ENG_END_DOX
         *
         *@syntax
         *@codeStart
         * @ref ADLX_RESULT    IsSupportedYCbCr420 (adlx_bool* supported)
         *@codeEnd
         *
         *@params
-        * @paramrow{1.,[out],supported,adlx_bool*,@ENG_START_DOX The pointer to a variable where the support state of the pixel format/YCbCr 4:2:0 is returned. The variable is __true__ if the pixel format/YCbCr 4:2:0 is supported. The variable is __false__ if pixel format/YCbCr 4:2:0 is not supported. @ENG_END_DOX}
+        * @paramrow{1.,[out],supported,adlx_bool*,@ENG_START_DOX The pointer to a variable where the support state of the YCbCr 4:2:0 pixel format is returned. The variable is __true__ if the YCbCr 4:2:0 pixel format is supported. The variable is __false__ if the YCbCr 4:2:0 pixel format is not supported. @ENG_END_DOX}
         *
         *@retvalues
-		*@ENG_START_DOX  If the support state of the pixel format/YCbCr 4:2:0 is successfully returned, __ADLX_OK__ is returned. <br>
-        * If the support state of the pixel format/YCbCr 4:2:0 is not successfully returned, an error code is returned. <br>
+		*@ENG_START_DOX  If the support state of the YCbCr 4:2:0 pixel format is successfully returned, __ADLX_OK__ is returned. <br>
+        * If the support state of the YCbCr 4:2:0 pixel format is not successfully returned, an error code is returned. <br>
         * Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
         *
         *@requirements

diff --git a/SDK/Include/IGPUManualPowerTuning.h b/SDK/Include/IGPUManualPowerTuning.h
@@ -104,7 +104,8 @@ namespace adlx
         *@page DOX_IADLXManualPowerTuning_IsSupportedTDCLimit IsSupportedTDCLimit
         *@ENG_START_DOX
         *@brief Checks if Thermal Design Current (TDC) limit is supported on a GPU.
-        *@ENG_END_DOX
+        *@details Thermal Design Current (TDC) functionality is not currently implemented in a production application. Usecase validation for these methods should be performed by application developers.
+		*@ENG_END_DOX
         *
         *@syntax
         *@codeStart
@@ -136,7 +137,8 @@ namespace adlx
         *@page DOX_IADLXManualPowerTuning_GetTDCLimitRange GetTDCLimitRange
         *@ENG_START_DOX
         *@brief Gets the manual power tuning minimum Thermal Design Current (TDC) range, maximum TDC range, and step TDC range on a GPU.
-        *@ENG_END_DOX
+        *@details Thermal Design Current (TDC) functionality is not currently implemented in a production application. Usecase validation for these methods should be performed by application developers.
+		*@ENG_END_DOX
         *
         *@syntax
         *@codeStart
@@ -163,8 +165,9 @@ namespace adlx
         *@page DOX_IADLXManualPowerTuning_GetTDCLimit GetTDCLimit
         *@ENG_START_DOX
         *@brief Gets the current Thermal Design Current (TDC) limit of a GPU.
-        *@ENG_END_DOX
-        *
+        *@details Thermal Design Current (TDC) functionality is not currently implemented in a production application. Usecase validation for these methods should be performed by application developers.
+		*@ENG_END_DOX
+		*
         *@syntax
         *@codeStart
         * @ref ADLX_RESULT    GetTDCLimit (adlx_int* curVal)
@@ -195,7 +198,8 @@ namespace adlx
         *@page DOX_IADLXManualPowerTuning_SetTDCLimit SetTDCLimit
         *@ENG_START_DOX
         *@brief Sets the Thermal Design Current (TDC) limit of a GPU.
-        *@ENG_END_DOX
+        *@details Thermal Design Current (TDC) functionality is not currently implemented in a production application. Usecase validation for these methods should be performed by application developers.
+		*@ENG_END_DOX
         *
         *@syntax
         *@codeStart

diff --git a/SDK/Include/IPerformanceMonitoring.h b/SDK/Include/IPerformanceMonitoring.h
@@ -856,8 +856,10 @@ namespace adlx
         virtual ADLX_RESULT ADLX_STD_CALL GPUVRAMClockSpeed (adlx_int* data) = 0;
         /**
         *@page DOX_IADLXGPUMetrics_GPUTemperature GPUTemperature
-        *@ENG_START_DOX @brief Gets the GPU temperature of a GPU metric sample. @ENG_END_DOX
-        *
+        *@ENG_START_DOX @brief Gets the GPU temperature of a GPU metric sample.
+        *@details GPUTemperature reports the average temperature measured at the edge of the die of the GPU. This is sometimes referred to as ‘Edge Temperature’. 
+		*@ENG_END_DOX
+		*
         *@syntax
         *@codeStart
         * @ref ADLX_RESULT    GPUTemperature (adlx_double* data)
@@ -871,16 +873,21 @@ namespace adlx
         * If the GPU temperature is not successfully returned, an error code is returned. <br>
         * Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
         *
-        *
+        *@addinfo
+		*  @ENG_START_DOX Related method: @ref DOX_IADLXGPUMetrics_GPUHotspotTemperature @ENG_END_DOX
+		*
         *@requirements
         *@DetailsTable{#include "IPerformanceMonitoring.h", @ADLX_First_Ver}
         *
         */
         virtual ADLX_RESULT ADLX_STD_CALL GPUTemperature (adlx_double* data) = 0;
         /**
         *@page DOX_IADLXGPUMetrics_GPUHotspotTemperature GPUHotspotTemperature
-        *@ENG_START_DOX @brief Gets the GPU hotspot temperature of a GPU metric sample. @ENG_END_DOX
-        *
+        *@ENG_START_DOX
+        *@brief Gets the GPU hotspot temperature of a GPU metric sample.
+		*@details GPUHotspotTemperature reports the highest temperature measured on the die of the GPU from a collection of junction temperature sensors on the die. This is sometimes referred to as ‘Junction Temperature’.
+		*@ENG_END_DOX
+		*
         *@syntax
         *@codeStart
         * @ref ADLX_RESULT    GPUHotspotTemperature (adlx_double* data)
@@ -894,7 +901,9 @@ namespace adlx
         * If the GPU hotspot temperature is not successfully returned, an error code is returned. <br>
         * Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
         *
-        *
+        *@addinfo
+		*  @ENG_START_DOX Related method: @ref DOX_IADLXGPUMetrics_GPUTemperature @ENG_END_DOX
+		*
         *@requirements
         *@DetailsTable{#include "IPerformanceMonitoring.h", @ADLX_First_Ver}
         *