Skip to content

Commit a33f91e

Browse files
ericjunweiericjunwei
committed
ADLX update
1 parent dbe9b24 commit a33f91e

73 files changed

Lines changed: 1086 additions & 1033 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎SDK/Include/I3DSettings.h‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2109,8 +2109,10 @@ namespace adlx
21092109
* @addinfo
21102110
* @ENG_START_DOX
21112111
* Radeon Super Resolution is an upscaling feature for faster game frame rates. <br>
2112-
* __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>
2113-
* 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.
2112+
*
2113+
* __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.
2114+
*
2115+
* 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>
21142116
* @ENG_END_DOX
21152117
*
21162118
*@requirements
@@ -2139,8 +2141,10 @@ namespace adlx
21392141
* @addinfo
21402142
* @ENG_START_DOX
21412143
* Radeon Super Resolution is an upscaling feature for faster game frame rates. <br>
2142-
* __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>
2143-
* Radeon Super Resolution requires @ref DOX_IADLXDisplayGPUScaling "GPU scaling". By enabling Radeon Super Resolution, GPU scaling is automatically enabled.
2144+
*
2145+
* __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.
2146+
*
2147+
* 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>
21442148
21452149
* @ENG_END_DOX
21462150
*

‎SDK/Include/IDisplaySettings.h‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1008,19 +1008,19 @@ namespace adlx
10081008
virtual ADLX_RESULT ADLX_STD_CALL IsSupportedPixelFormat (ADLX_PIXEL_FORMAT pixelFormat, adlx_bool* supportd) = 0;
10091009
/**
10101010
*@page DOX_IADLXDisplayPixelFormat_IsSupportedRGB444Full IsSupportedRGB444Full
1011-
*@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
1011+
*@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
10121012
*
10131013
*@syntax
10141014
*@codeStart
10151015
* @ref ADLX_RESULT IsSupportedRGB444Full (adlx_bool* supported)
10161016
*@codeEnd
10171017
*
10181018
*@params
1019-
* @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}
1019+
* @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}
10201020
*
10211021
*@retvalues
1022-
*@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>
1023-
* 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>
1022+
*@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>
1023+
* 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>
10241024
* Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
10251025
*
10261026
*@requirements
@@ -1030,19 +1030,19 @@ namespace adlx
10301030
virtual ADLX_RESULT ADLX_STD_CALL IsSupportedRGB444Full (adlx_bool* supportd) = 0;
10311031
/**
10321032
*@page DOX_IADLXDisplayPixelFormat_IsSupportedYCbCr444 IsSupportedYCbCr444
1033-
*@ENG_START_DOX @brief Checks if the given pixel format/YCbCr 4:4:4 is supported on a display. @ENG_END_DOX
1033+
*@ENG_START_DOX @brief Checks if the YCbCr 4:4:4 pixel format is supported on a display. @ENG_END_DOX
10341034
*
10351035
*@syntax
10361036
*@codeStart
10371037
* @ref ADLX_RESULT IsSupportedYCbCr444 (adlx_bool* supported)
10381038
*@codeEnd
10391039
*
10401040
*@params
1041-
* @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}
1041+
* @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}
10421042
*
10431043
*@retvalues
1044-
*@ENG_START_DOX If the support state of the pixel format/YCbCr 4:4:4 is successfully returned, __ADLX_OK__ is returned. <br>
1045-
* If the support state of the pixel format/YCbCr 4:4:4 is not successfully returned, an error code is returned. <br>
1044+
*@ENG_START_DOX If the support state of the YCbCr 4:4:4 pixel format is successfully returned, __ADLX_OK__ is returned. <br>
1045+
* If the support state of the YCbCr 4:4:4 pixel format is not successfully returned, an error code is returned. <br>
10461046
* Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
10471047
*
10481048
*@requirements
@@ -1052,19 +1052,19 @@ namespace adlx
10521052
virtual ADLX_RESULT ADLX_STD_CALL IsSupportedYCbCr444 (adlx_bool* supportd) = 0;
10531053
/**
10541054
*@page DOX_IADLXDisplayPixelFormat_IsSupportedYCbCr422 IsSupportedYCbCr422
1055-
*@ENG_START_DOX @brief Checks if the given pixel format/YCbCr 4:2:2 is supported on a display. @ENG_END_DOX
1055+
*@ENG_START_DOX @brief Checks if the YCbCr 4:2:2 pixel format is supported on a display. @ENG_END_DOX
10561056
*
10571057
*@syntax
10581058
*@codeStart
10591059
* @ref ADLX_RESULT IsSupportedYCbCr422 (adlx_bool* supported)
10601060
*@codeEnd
10611061
*
10621062
*@params
1063-
* @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}
1063+
* @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}
10641064
*
10651065
*@retvalues
1066-
*@ENG_START_DOX If the support state of the pixel format/YCbCr 4:2:2 is successfully returned, __ADLX_OK__ is returned. <br>
1067-
* If the support state of the pixel format/YCbCr 4:2:2 is not successfully returned, an error code is returned. <br>
1066+
*@ENG_START_DOX If the support state of the YCbCr 4:2:2 pixel format is successfully returned, __ADLX_OK__ is returned. <br>
1067+
* If the support state of the YCbCr 4:2:2 pixel format is not successfully returned, an error code is returned. <br>
10681068
* Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
10691069
*
10701070
*@requirements
@@ -1074,19 +1074,19 @@ namespace adlx
10741074
virtual ADLX_RESULT ADLX_STD_CALL IsSupportedYCbCr422 (adlx_bool* supportd) = 0;
10751075
/**
10761076
*@page DOX_IADLXDisplayPixelFormat_IsSupportedRGB444Limited IsSupportedRGB444Limited
1077-
*@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
1077+
*@ENG_START_DOX @brief Checks if the RGB 4:4:4 Studio (Limited RGB) pixel format is supported on a display. @ENG_END_DOX
10781078
*
10791079
*@syntax
10801080
*@codeStart
10811081
* @ref ADLX_RESULT IsSupportedRGB444Limited (adlx_bool* supported)
10821082
*@codeEnd
10831083
*
10841084
*@params
1085-
* @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}
1085+
* @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}
10861086
*
10871087
*@retvalues
1088-
*@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>
1089-
* 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>
1088+
*@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>
1089+
* 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>
10901090
* Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
10911091
*
10921092
*@requirements
@@ -1096,19 +1096,19 @@ namespace adlx
10961096
virtual ADLX_RESULT ADLX_STD_CALL IsSupportedRGB444Limited (adlx_bool* supportd) = 0;
10971097
/**
10981098
*@page DOX_IADLXDisplayPixelFormat_IsSupportedYCbCr420 IsSupportedYCbCr420
1099-
*@ENG_START_DOX @brief Checks if the given pixel format/YCbCr 4:2:0 is supported on a display. @ENG_END_DOX
1099+
*@ENG_START_DOX @brief Checks if the YCbCr 4:2:0 pixel format is supported on a display. @ENG_END_DOX
11001100
*
11011101
*@syntax
11021102
*@codeStart
11031103
* @ref ADLX_RESULT IsSupportedYCbCr420 (adlx_bool* supported)
11041104
*@codeEnd
11051105
*
11061106
*@params
1107-
* @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}
1107+
* @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}
11081108
*
11091109
*@retvalues
1110-
*@ENG_START_DOX If the support state of the pixel format/YCbCr 4:2:0 is successfully returned, __ADLX_OK__ is returned. <br>
1111-
* If the support state of the pixel format/YCbCr 4:2:0 is not successfully returned, an error code is returned. <br>
1110+
*@ENG_START_DOX If the support state of the YCbCr 4:2:0 pixel format is successfully returned, __ADLX_OK__ is returned. <br>
1111+
* If the support state of the YCbCr 4:2:0 pixel format is not successfully returned, an error code is returned. <br>
11121112
* Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
11131113
*
11141114
*@requirements

‎SDK/Include/IGPUManualPowerTuning.h‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,8 @@ namespace adlx
104104
*@page DOX_IADLXManualPowerTuning_IsSupportedTDCLimit IsSupportedTDCLimit
105105
*@ENG_START_DOX
106106
*@brief Checks if Thermal Design Current (TDC) limit is supported on a GPU.
107-
*@ENG_END_DOX
107+
*@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.
108+
*@ENG_END_DOX
108109
*
109110
*@syntax
110111
*@codeStart
@@ -136,7 +137,8 @@ namespace adlx
136137
*@page DOX_IADLXManualPowerTuning_GetTDCLimitRange GetTDCLimitRange
137138
*@ENG_START_DOX
138139
*@brief Gets the manual power tuning minimum Thermal Design Current (TDC) range, maximum TDC range, and step TDC range on a GPU.
139-
*@ENG_END_DOX
140+
*@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.
141+
*@ENG_END_DOX
140142
*
141143
*@syntax
142144
*@codeStart
@@ -163,8 +165,9 @@ namespace adlx
163165
*@page DOX_IADLXManualPowerTuning_GetTDCLimit GetTDCLimit
164166
*@ENG_START_DOX
165167
*@brief Gets the current Thermal Design Current (TDC) limit of a GPU.
166-
*@ENG_END_DOX
167-
*
168+
*@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.
169+
*@ENG_END_DOX
170+
*
168171
*@syntax
169172
*@codeStart
170173
* @ref ADLX_RESULT GetTDCLimit (adlx_int* curVal)
@@ -195,7 +198,8 @@ namespace adlx
195198
*@page DOX_IADLXManualPowerTuning_SetTDCLimit SetTDCLimit
196199
*@ENG_START_DOX
197200
*@brief Sets the Thermal Design Current (TDC) limit of a GPU.
198-
*@ENG_END_DOX
201+
*@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.
202+
*@ENG_END_DOX
199203
*
200204
*@syntax
201205
*@codeStart

‎SDK/Include/IPerformanceMonitoring.h‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -856,8 +856,10 @@ namespace adlx
856856
virtual ADLX_RESULT ADLX_STD_CALL GPUVRAMClockSpeed (adlx_int* data) = 0;
857857
/**
858858
*@page DOX_IADLXGPUMetrics_GPUTemperature GPUTemperature
859-
*@ENG_START_DOX @brief Gets the GPU temperature of a GPU metric sample. @ENG_END_DOX
860-
*
859+
*@ENG_START_DOX @brief Gets the GPU temperature of a GPU metric sample.
860+
*@details GPUTemperature reports the average temperature measured at the edge of the die of the GPU. This is sometimes referred to as ‘Edge Temperature’.
861+
*@ENG_END_DOX
862+
*
861863
*@syntax
862864
*@codeStart
863865
* @ref ADLX_RESULT GPUTemperature (adlx_double* data)
@@ -871,16 +873,21 @@ namespace adlx
871873
* If the GPU temperature is not successfully returned, an error code is returned. <br>
872874
* Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
873875
*
874-
*
876+
*@addinfo
877+
* @ENG_START_DOX Related method: @ref DOX_IADLXGPUMetrics_GPUHotspotTemperature @ENG_END_DOX
878+
*
875879
*@requirements
876880
*@DetailsTable{#include "IPerformanceMonitoring.h", @ADLX_First_Ver}
877881
*
878882
*/
879883
virtual ADLX_RESULT ADLX_STD_CALL GPUTemperature (adlx_double* data) = 0;
880884
/**
881885
*@page DOX_IADLXGPUMetrics_GPUHotspotTemperature GPUHotspotTemperature
882-
*@ENG_START_DOX @brief Gets the GPU hotspot temperature of a GPU metric sample. @ENG_END_DOX
883-
*
886+
*@ENG_START_DOX
887+
*@brief Gets the GPU hotspot temperature of a GPU metric sample.
888+
*@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’.
889+
*@ENG_END_DOX
890+
*
884891
*@syntax
885892
*@codeStart
886893
* @ref ADLX_RESULT GPUHotspotTemperature (adlx_double* data)
@@ -894,7 +901,9 @@ namespace adlx
894901
* If the GPU hotspot temperature is not successfully returned, an error code is returned. <br>
895902
* Refer to @ref ADLX_RESULT for success codes and error codes. @ENG_END_DOX
896903
*
897-
*
904+
*@addinfo
905+
* @ENG_START_DOX Related method: @ref DOX_IADLXGPUMetrics_GPUTemperature @ENG_END_DOX
906+
*
898907
*@requirements
899908
*@DetailsTable{#include "IPerformanceMonitoring.h", @ADLX_First_Ver}
900909
*

0 commit comments

Comments
 (0)