Scaled resolutions on retina screens on macOS

Joshua_Bodine · July 9, 2017, 6:24pm

A few months ago I started getting reports of our game (BZFlag) failing to launch on certain mac computers. When I investigated it, I found that our code kept trying to create a fullscreen window at a certain resolution, but another resolution would be returned instead, so it was stuck in an endless cycle. As I dug deeper, what I discovered is that under certain conditions (retina display, with a non-standard scaling option under System Preferences -> Displays), SDL_GetCurrentDisplayMode() returns a resolution that isn’t actually supported by the display. What follows is that we cannot pass that resolution to SDL_CreateWindow() and get what we asked for.

I wrote a test application that queries SDL for the current display mode and every other possible display mode using SDL_GetNumDisplayModes() and SDL_GetDisplayMode(), and attempts to create a fullscreen window with SDL_CreateWindow() using each resolution. I then ran the test application on an Apple MacBook Pro retina 13" at all four scaling settings, with the following results:

skye:Desktop josh$ "Larger Text" skye:Desktop josh$ ./a.out Current Resolution 1024 x 640 FAIL, got 1024 x 768 Resolution 2560 x 1600 PASS Resolution 2048 x 1280 PASS Resolution 1650 x 1050 PASS Resolution 1440 x 900 PASS Resolution 1280 x 800 PASS Resolution 1152 x 720 PASS Resolution 1024 x 768 PASS Resolution 840 x 524 PASS Resolution 800 x 600 PASS Resolution 640 x 480 PASS skye:Desktop josh$ "Default" skye:Desktop josh$ ./a.out Current Resolution 1280 x 800 PASS Resolution 2560 x 1600 PASS Resolution 2048 x 1280 PASS Resolution 1650 x 1050 PASS Resolution 1440 x 900 PASS Resolution 1280 x 800 PASS Resolution 1152 x 720 PASS Resolution 1024 x 768 PASS Resolution 840 x 524 PASS Resolution 800 x 600 PASS Resolution 640 x 480 PASS skye:Desktop josh$ "In Between" skye:Desktop josh$ ./a.out Current Resolution 1440 x 900 PASS Resolution 2560 x 1600 PASS Resolution 2048 x 1280 PASS Resolution 1650 x 1050 PASS Resolution 1440 x 900 PASS Resolution 1280 x 800 PASS Resolution 1152 x 720 PASS Resolution 1024 x 768 PASS Resolution 840 x 524 PASS Resolution 800 x 600 PASS Resolution 640 x 480 PASS skye:Desktop josh$ "More Space" skye:Desktop josh$ ./a.out Current Resolution 1680 x 1050 FAIL, got 2048 x 1280 Resolution 2560 x 1600 PASS Resolution 2048 x 1280 PASS Resolution 1650 x 1050 PASS Resolution 1440 x 900 PASS Resolution 1280 x 800 PASS Resolution 1152 x 720 PASS Resolution 1024 x 768 PASS Resolution 840 x 524 PASS Resolution 800 x 600 PASS Resolution 640 x 480 PASS

So it seems that what is being returned by SDL_GetCurrentDisplayMode() under certain scaling modes is not a resolution that the display can actually be put into. I poked around in SDL’s code for this function, and as far as I can tell it pulls this information straight from the operating system.

So my question is, is this the expected behavior for SDL_GetCurrentDisplayMode()? Is there a better way to get the true resolution currently in use when a retina display is in one of those scaling modes? Or if this is not the expected behavior, is the problem in SDL or more likely in the macOS operating system code? For reference, I demonstrated this issue on macOS Sierra 10.12.5 and SDL 2.0.5.

Eric_Wasylishen · July 10, 2017, 5:51pm

Hi,
There might be some helpful info in MacBook Pro with Retina display - strange behaviour

Specifically, it’s not clear that passing the fullscreen resolution to SDL_CreateWindow() is correct - the docs at https://wiki.libsdl.org/SDL_CreateWindow specifically state that the width/height params are ignored if you call it with SDL_WINDOW_FULLSCREEN (even though they are not ignored in practice).

It might be worth seeing if you can reproduce the problem by using SDL_SetCurrentDisplayMode instead of SDL_CreateWindow() .

I have a retina display Mac as well so would be interested in looking at this, mind posting the code for your test program?

Joshua_Bodine · July 11, 2017, 7:49pm

Sure, the source code is below. I compiled it using g++ --std=c++11 -F /Library/Frameworks -framework SDL2 displaytest.cpp

I couldn’t find a function SDL_SetCurrentDisplayMode(). Did you mean I should use SDL_SetWindowDisplayMode() after creating the window some other way?

displaytest.cpp (1.8 KB)

Eric_Wasylishen · July 11, 2017, 8:04pm

Thanks, I’ll try it on my system (15" rMBP, 2880x1800). Yeah, sorry I meant SDL_SetWindowDisplayMode:
https://wiki.libsdl.org/SDL_SetWindowDisplayMode

Eric_Wasylishen · July 12, 2017, 7:09pm

Was able to reproduce and found a fix. The problem seems to have been code in SDL_cocoamodes.m using CGDisplayModeGetWidth which returns points instead of pixels when a scaled retina resolution is in use. That’s why you’re getting

Current Resolution 1024 x 640

for the “Larger Text” setting. The fix was just switching to CGDisplayModeGetPixelWidth/Height. I submitted a patch for this in the bugtracker:

github.com/libsdl-org/SDL

[patch] macOS fix SDL_GetCurrentDisplayMode returning points in a scaled retina resolution

opened 12:42AM - 11 Feb 21 UTC

closed 12:42AM - 11 Feb 21 UTC

SDLBugzilla

wontfix

# This bug report was migrated from our old Bugzilla tracker. These attachments… are available in the static archive: * [patch for SDL_GetCurrentDisplayMode (pixelsize.diff, text/plain, 2017-07-12 19:05:30 +0000, 1832 bytes)](https://bugzilla.libsdl.org/attachment.cgi?id=2796) **Reported in version:** HG 2.1 **Reported for operating system, platform:** Other, x86 # Comments on the original bug report: On 2017-07-12 19:05:30 +0000, Eric Wasylishen wrote: > Created attachment 2796 > patch for SDL_GetCurrentDisplayMode > > from the discussion here: https://discourse.libsdl.org/t/scaled-resolutions-on-retina-screens-on-macos/22781 > > When the system has a scaled retina mode active, (e.g. system preferences -> display -> resolution (scaled) -> Larger Text), SDL_GetCurrentDisplayMode was returning width/height in points, not pixels. > Afaik, we want it to always return pixels (I also updated the comments in the SDL_DisplayMode struct to clarify that the units are pixels). > > > This patch is just using the CGDisplayModeGetPixelWidth/Height introduced in 10.8, instead of CGDisplayModeGetWidth/Height as before. > There is a runtime check as well as a preprocessor check so we can still compile on 10.7 (although, it would be safer to drop support for compiling on 10.7, since a build made on 10.7 would lack the bug fix if it were run on 10.8+.) > > > To reproduce the issue, set the "Larger Text" scaling mode in system preferences, on a retina display. Run testdraw2 with "--info all". > Without this patch: > > INFO: Bounds: 1024x640 at 0,0 > INFO: Usable bounds: 1003x618 at 0,0 > INFO: DPI: 78.500000x78.500000 > INFO: Current mode: 1024x640@60Hz, 32 bits-per-pixel (SDL_PIXELFORMAT_ARGB8888) > > With this patch: > > INFO: Bounds: 1024x640 at 0,0 > INFO: Usable bounds: 1003x618 at 0,0 > INFO: DPI: 78.500000x78.500000 > INFO: Current mode: 2048x1280@60Hz, 32 bits-per-pixel (SDL_PIXELFORMAT_ARGB8888) On 2017-07-12 20:24:30 +0000, Alex Szpakowski wrote: > (In reply to Eric Wasylishen from comment # 0) > > When the system has a scaled retina mode active, (e.g. system preferences -> > > display -> resolution (scaled) -> Larger Text), SDL_GetCurrentDisplayMode > > was returning width/height in points, not pixels. > > Afaik, we want it to always return pixels (I also updated the comments in > > the SDL_DisplayMode struct to clarify that the units are pixels). > > SDL display modes are intentionally in points rather than pixels. It would be handy to have additional fields in the struct for pixel dimensions, though > > SDL window positions and dimensions are also in points rather than pixels (SDL_GL_GetDrawableSize and SDL_GetRendererOutputSize are the only two functions that explicitly return pixel dimensions, in SDL). So the coordinate space of display modes should match that of window sizes, right now. On 2017-07-12 23:20:46 +0000, Eric Wasylishen wrote: > Ah, I see. The reason I was thinking the width/height of the SDL_DisplayMode struct had to be pixels, is the fact that the window is stretched to fill the screen means the points part of the high-DPI equation cancels out. > > i.e. normally you have: > > window_pixels = window_points * (screen_pixels / screen_points) > > but if "window_points" is defined to be equal to "screen_points", as is the case in fullscreen, then you just have "window_pixels = screen_pixels". > > The only part where this argument breaks is mouse cursor size (or if somehow other windows were dragged on top of a SDL fullscreen window). On 2017-07-13 00:31:09 +0000, Alex Szpakowski wrote: > I committed a different change to fix the BZFlag issue: https://hg.libsdl.org/SDL/rev/1e26564c7288

slime · July 13, 2017, 12:30am

I’ve pushed what I believe to be a proper fix: https://hg.libsdl.org/SDL/rev/1e26564c7288

Let me know if it works for you!

Joshua_Bodine · July 13, 2017, 6:14pm

I appreciate the effort to fix this issue. I personally don’t own a retina mac (I had to borrow one for my testing), so if someone with better access to such a machine could help test the fix, that would be much appreciated. As long as SDL_GetCurrentDisplayMode() returns a resolution that the screen can actually be put into, that will solve the problem on our end.

Eric_Wasylishen · July 14, 2017, 8:07pm

I ran @Joshua_Bodine’s test program on current hg on all 5 scaling modes on my macbook pro, and everything reports “PASS” now.