Add screen_get_refresh_rate to DisplayServer #47246

jordi-star · 2021-03-22T01:42:23Z

Closes godotengine/godot-proposals#1284.

Allows you to get the Screen's refresh rate by using DisplayServer.screen_get_refresh_rate()

Since 3.2 doesn't use DisplayServer, I would imagine this can't be cherry-picked. I've already made a 3.x version that uses OS instead. I will make a separate PR for the 3.x branch if this gets merged.

platform/windows/display_server_windows.h

jordi-star · 2021-03-22T04:27:25Z

Added documentation and fixed issues with the method being missing in iOS and Android builds.

bruvzg · 2021-03-22T09:11:22Z

platform/android/display_server_android.cpp

@@ -138,6 +138,11 @@ Size2i DisplayServerAndroid::screen_get_size(int p_screen) const {
 	return OS_Android::get_singleton()->get_display_size();
 }

+float DisplayServerAndroid::screen_get_refresh_rate(int p_screen) const {
+	// Most Android devices have 60hz displays.


Quick search on gsmarena.com and, half of the last year released €200+ devices have 90+ Hz screens.

https://developer.android.com/reference/android/view/Display#getMode()
https://developer.android.com/reference/android/view/Display.Mode#getRefreshRate()

bruvzg · 2021-03-22T09:32:12Z

platform/osx/display_server_osx.mm

@@ -2285,6 +2285,13 @@ static void displays_arrangement_changed(CGDirectDisplayID display_id, CGDisplay
 	return Size2i();
 }

+float DisplayServerOSX::screen_get_refresh_rate(int p_screen) const {
+	_THREAD_SAFE_METHOD_
+	// There's no way to get the screen refresh rate using AppKit


Internal displays are 60Hz, external can have any refresh rate.

API to get refresh rate. https://developer.apple.com/documentation/coregraphics/1454661-cgdisplaymodegetrefreshrate

Enumeration example:

NSArray *screenArray = [NSScreen screens]; for (int i = 0; i < [screenArray count]; i++) { NSDictionary *description = [[screenArray objectAtIndex:i] deviceDescription]; double rate = CGDisplayModeGetRefreshRate(CGDisplayCopyDisplayMode([[description objectForKey:@"NSScreenNumber"] unsignedIntValue])); if (rate == 0) { rate = 60.f; } printf("refresh rate [%d]: %f\n", i, rate); }

Since this was posted, note that internal displays can now be 120 Hz in the new 14" and 16" MacBook Pros. This isn't always the case though, as they can be configured to run at a lower refresh rate to save on battery (as low as 47.95 Hz).

bruvzg · 2021-03-22T09:52:38Z

platform/windows/display_server_windows.cpp

+float DisplayServerWindows::screen_get_refresh_rate(int p_screen) const {
+	_THREAD_SAFE_METHOD_
+
+	DEVMODE data;
+	memset(&data, 0, sizeof(data));
+	EnumDisplaySettingsA(NULL, ENUM_CURRENT_SETTINGS, &data);
+	return data.dmDisplayFrequency;
+}
+


I guess it should get the current display refresh rate, not the main one. Also, setting xxSize field value is usually required for the most Windows API functions.

Something like (not tested):

Suggested change

float DisplayServerWindows::screen_get_refresh_rate(int p_screen) const {

_THREAD_SAFE_METHOD_

DEVMODE data;

memset(&data, 0, sizeof(data));

EnumDisplaySettingsA(NULL, ENUM_CURRENT_SETTINGS, &data);

return data.dmDisplayFrequency;

}

typedef struct {

int count;

int screen;

float rate;

} EnumRefData;

static BOOL CALLBACK _MonitorEnumProcRef(HMONITOR hMonitor, HDC hdcMonitor, LPRECT lprcMonitor, LPARAM dwData) {

EnumRefData *data = (EnumRefData *)dwData;

if (data->count == data->screen) {

MONITORINFOEXW mi;

memset(&mi, 0, sizeof(mi);

mi.cbSize = sizeof(mi);

GetMonitorInfoW(hMonitor, &mi);

DEVMODE dm;

memset(&dm, 0, sizeof(dm));

dm.dmSize = sizeof(dm);

EnumDisplaySettingsW(mi.szDevice, ENUM_CURRENT_SETTINGS, &dm);

data->rate = dm.dmDisplayFrequency;

}

data->count++;

return TRUE;

}

float DisplayServerWindows::screen_get_refresh_rate(int p_screen) const {

_THREAD_SAFE_METHOD_

EnumRefData data = { 0, p_screen == SCREEN_OF_MAIN_WINDOW ? window_get_current_screen() : p_screen, 0 };

EnumDisplayMonitors(nullptr, nullptr, _MonitorEnumProcRef, (LPARAM)&data);

return data.rate;

}

bruvzg · 2021-03-22T10:00:09Z

platform/osx/display_server_osx.mm

+float DisplayServerOSX::screen_get_refresh_rate(int p_screen) const {
+	_THREAD_SAFE_METHOD_
+	// There's no way to get the screen refresh rate using AppKit
+	// and most if not all Apple devices have 60hz displays anyways.
+	return 60.0;
+}
+


Suggested change

float DisplayServerOSX::screen_get_refresh_rate(int p_screen) const {

_THREAD_SAFE_METHOD_

// There's no way to get the screen refresh rate using AppKit

// and most if not all Apple devices have 60hz displays anyways.

return 60.0;

}

float DisplayServerOSX::screen_get_refresh_rate(int p_screen) const {

NSArray *screenArray = [NSScreen screens];

int id = (p_screen == SCREEN_OF_MAIN_WINDOW) ? window_get_current_screen() : p_screen;

NSDictionary *description = [[screenArray objectAtIndex:id] deviceDescription];

CGDisplayModeRef mode = CGDisplayCopyDisplayMode([[description objectForKey:@"NSScreenNumber"] unsignedIntValue]);

double rate = CGDisplayModeGetRefreshRate(mode);

CGDisplayModeRelease(mode);

return (rate > 0) ? rate : 60.f;

}

Thanks for the review, I'll definitely implement these changes later today. Apologies for the inconvenience.

For now, I'll mark this as a draft until I get everything working.

m4gr3d · 2021-04-02T22:50:42Z

doc/classes/DisplayServer.xml

+			</argument>
+			<description>
+				Return's the screen refresh rate.
+				[b]Note:[/b] On macOS and iPhone, this will always be 60.


I would use this is instead of this will always be since it could change in the future.

This line won't be in the final merged version of this PR, since I'm adding support for getting the refresh rate through AppKit

I would also replace "iPhone" with "iOS", since Godot also supports iPadOS and in the future, tvOS (Apple TV).

The iPad Pro already has a 120 Hz refresh rate.

Edit: The iPhone 13 Pro and iPhone 13 Pro Max have 120 Hz refresh rate as well, unless the battery saver mode is enabled.

platform/android/display_server_android.cpp

m4gr3d · 2021-04-02T22:54:59Z

platform/linuxbsd/display_server_x11.cpp

+	//invalid screen?
+	ERR_FAIL_INDEX_V(p_screen, get_screen_count(), 0);
+
+	float refresh_rate = 60.0; //Default to 60 hz if the engine was unable to get the refresh rate.


Is there a place you can store the default value (maybe in display_server.h) and just reference it?

I would do that, but it looks like most other places that have a default value do it hard coded like this. Plus, I don't see many benefits to adding it to display_server.h since it most likely won't be changed any time soon, and if it is, it would be a very quick change.

… constructor.

jordi-star requested review from a team as code owners March 22, 2021 01:42

Calinou added enhancement platform:linuxbsd platform:macos platform:windows topic:porting topic:rendering labels Mar 22, 2021

Calinou added this to the 4.0 milestone Mar 22, 2021

jordi-star marked this pull request as draft March 22, 2021 02:50

LikeLakers2 reviewed Mar 22, 2021

View reviewed changes

platform/windows/display_server_windows.h Outdated Show resolved Hide resolved

jordi-star force-pushed the os-screen-refresh-rate-4 branch 4 times, most recently from 848ceb2 to 021a154 Compare March 22, 2021 03:33

Add screen_get_refresh_rate to DisplayServer

e81ad86

jordi-star force-pushed the os-screen-refresh-rate-4 branch from 021a154 to e81ad86 Compare March 22, 2021 03:47

jordi-star marked this pull request as ready for review March 22, 2021 04:24

jordi-star requested review from a team as code owners March 22, 2021 04:24

jordi-star removed request for a team March 22, 2021 04:25

bruvzg reviewed Mar 22, 2021

View reviewed changes

jordi-star marked this pull request as draft March 22, 2021 13:45

jordi-star added 4 commits March 26, 2021 14:47

Test getting Display.Mode from JNI

595664a

Test: Fix compile issues for Android

7822169

Attempt to fix get_jni_env error

098e46c

Add return value

db9dce5

m4gr3d requested changes Apr 2, 2021

View reviewed changes

m4gr3d added platform:android platform:ios labels Apr 2, 2021

jordi-star force-pushed the os-screen-refresh-rate-4 branch from db9dce5 to e81ad86 Compare April 2, 2021 23:41

jordi-star added 4 commits April 2, 2021 18:43

Add android get screen refresh rate

06bd329

Fix android compilation error involving env in the GodotIOJavaWrapper…

ca84936

… constructor.

Remove incorrect note in server_get_refresh_rate documentation

89a4a4e

Fix formatting eror in GodotJavaIOWrapper

2963fd7

jordi-star mentioned this pull request Jan 28, 2022

Add screen_get_refresh_rate to DisplayServer #57335

Merged

jordi-star closed this Jan 28, 2022

akien-mga added the archived label Jan 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add screen_get_refresh_rate to DisplayServer #47246

Add screen_get_refresh_rate to DisplayServer #47246

jordi-star commented Mar 22, 2021 •

edited

Loading

jordi-star commented Mar 22, 2021

bruvzg Mar 22, 2021

bruvzg Mar 22, 2021

Calinou Nov 2, 2021 •

edited

Loading

bruvzg Mar 22, 2021

bruvzg Mar 22, 2021

jordi-star Mar 22, 2021 •

edited

Loading

m4gr3d Apr 2, 2021

jordi-star Apr 2, 2021

Calinou Apr 3, 2021 •

edited

Loading

m4gr3d Apr 2, 2021

jordi-star Apr 2, 2021 •

edited

Loading

-float DisplayServerWindows::screen_get_refresh_rate(int p_screen) const {
-	_THREAD_SAFE_METHOD_
-	DEVMODE data;
-	memset(&data, 0, sizeof(data));
-	EnumDisplaySettingsA(NULL, ENUM_CURRENT_SETTINGS, &data);
-	return data.dmDisplayFrequency;
-}
+typedef struct {
+	int count;
+	int screen;
+	float rate;
+} EnumRefData;
+static BOOL CALLBACK _MonitorEnumProcRef(HMONITOR hMonitor, HDC hdcMonitor, LPRECT lprcMonitor, LPARAM dwData) {
+	EnumRefData *data = (EnumRefData *)dwData;
+	if (data->count == data->screen) {
+		MONITORINFOEXW mi;
+		memset(&mi, 0, sizeof(mi);
+		mi.cbSize = sizeof(mi);
+		GetMonitorInfoW(hMonitor, &mi);
+		DEVMODE dm;
+		memset(&dm, 0, sizeof(dm));
+		dm.dmSize = sizeof(dm);
+		EnumDisplaySettingsW(mi.szDevice, ENUM_CURRENT_SETTINGS, &dm);
+		data->rate = dm.dmDisplayFrequency;
+	}
+	data->count++;
+	return TRUE;
+}
+float DisplayServerWindows::screen_get_refresh_rate(int p_screen) const {
+	_THREAD_SAFE_METHOD_
+	EnumRefData data = { 0, p_screen == SCREEN_OF_MAIN_WINDOW ? window_get_current_screen() : p_screen, 0 };
+	EnumDisplayMonitors(nullptr, nullptr, _MonitorEnumProcRef, (LPARAM)&data);
+	return data.rate;
+}

-float DisplayServerOSX::screen_get_refresh_rate(int p_screen) const {
-	_THREAD_SAFE_METHOD_
-	// There's no way to get the screen refresh rate using AppKit
-	// and most if not all Apple devices have 60hz displays anyways.
-	return 60.0;
-}
+float DisplayServerOSX::screen_get_refresh_rate(int p_screen) const {
+	NSArray *screenArray = [NSScreen screens];
+	int id = (p_screen == SCREEN_OF_MAIN_WINDOW) ? window_get_current_screen() : p_screen;
+	NSDictionary *description = [[screenArray objectAtIndex:id] deviceDescription];
+	CGDisplayModeRef mode = CGDisplayCopyDisplayMode([[description objectForKey:@"NSScreenNumber"] unsignedIntValue]);
+	double rate = CGDisplayModeGetRefreshRate(mode);
+	CGDisplayModeRelease(mode);
+	return (rate > 0) ? rate : 60.f;
+}

Add screen_get_refresh_rate to DisplayServer #47246

Add screen_get_refresh_rate to DisplayServer #47246

Conversation

jordi-star commented Mar 22, 2021 • edited Loading

jordi-star commented Mar 22, 2021

bruvzg Mar 22, 2021

Choose a reason for hiding this comment

bruvzg Mar 22, 2021

Choose a reason for hiding this comment

Calinou Nov 2, 2021 • edited Loading

Choose a reason for hiding this comment

bruvzg Mar 22, 2021

Choose a reason for hiding this comment

bruvzg Mar 22, 2021

Choose a reason for hiding this comment

jordi-star Mar 22, 2021 • edited Loading

Choose a reason for hiding this comment

m4gr3d Apr 2, 2021

Choose a reason for hiding this comment

jordi-star Apr 2, 2021

Choose a reason for hiding this comment

Calinou Apr 3, 2021 • edited Loading

Choose a reason for hiding this comment

m4gr3d Apr 2, 2021

Choose a reason for hiding this comment

jordi-star Apr 2, 2021 • edited Loading

Choose a reason for hiding this comment

jordi-star commented Mar 22, 2021 •

edited

Loading

Calinou Nov 2, 2021 •

edited

Loading

jordi-star Mar 22, 2021 •

edited

Loading

Calinou Apr 3, 2021 •

edited

Loading

jordi-star Apr 2, 2021 •

edited

Loading