Correct wxDC::GetContentScaleFactor() documentation

Document that it returns the same value as GetDPIScaleFactor() wxWindow
method and _not_ the wxWindow method with the same name.

This is very confusing, but there doesn't seem to be anything to be done
about it by now.

See #23441.
This commit is contained in:
Vadim Zeitlin 2023-04-13 15:07:32 +02:00
parent 030dd6d79b
commit 5e7b08f9ea

View file

@ -1511,10 +1511,16 @@ public:
/**
Returns the factor used for converting logical pixels to physical ones.
Returns the same value as wxWindow::GetContentScaleFactor() for the
Returns the same value as wxWindow::GetDPIScaleFactor() for the
device contexts associated with a window and the same value as
wxBitmap::GetScaleFactor() for the associated bitmap for wxMemoryDC.
@note Beware, this function does _not_ return the same value as
wxWindow::GetContentScaleFactor() for the device contexts associated
with the window. Unlike wxWindow method, it always returns the
effective scale factor instead of always returning 1 on platforms where
logical pixels are the same as physical ones, such as MSW.
@since 2.9.5
*/
double GetContentScaleFactor() const;