1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: MSW Implementation of wxDisplay class
4 // Author: Royce Mitchell III
5 // Modified by: VZ (resolutions enumeration/change support, DirectDraw, ...)
6 // Ryan Norton (IsPrimary override)
9 // Copyright: (c) wxWidgets team
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
13 // ===========================================================================
15 // ===========================================================================
17 // ---------------------------------------------------------------------------
19 // ---------------------------------------------------------------------------
21 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
22 #pragma implementation "display.h"
25 // For compilers that support precompilation, includes "wx.h".
26 #include "wx/wxprec.h"
36 #include "wx/dynarray.h"
40 #include "wx/dynload.h"
42 #include "wx/display.h"
44 // the following define is necessary to access the multi-monitor function
45 // declarations in a manner safe to use w/ Windows 95
46 #define COMPILE_MULTIMON_STUBS
48 // if you don't have multimon.h you can download the file from:
50 // http://www.microsoft.com/msj/0697/monitor/monitortextfigs.htm#fig4
54 // as (m)any standard header(s), this one doesn't compile without warnings
56 #pragma warning(disable:4706)
59 // with mingw32, we must include windows.h first and it doesn't hurt with other
66 #pragma warning(default:4706)
71 // we don't want to link with ddraw.lib which contains the real
72 // IID_IDirectDraw2 definition
73 const GUID wxIID_IDirectDraw2
=
74 { 0xB3A6F3E0, 0x2B43, 0x11CF, { 0xA2,0xDE,0x00,0xAA,0x00,0xB9,0x33,0x56 } };
76 // ----------------------------------------------------------------------------
78 // ----------------------------------------------------------------------------
81 #define WINFUNC(x) _T(#x) L"W"
83 #define WINFUNC(x) #x "A"
86 // ----------------------------------------------------------------------------
87 // typedefs for dynamically loaded Windows functions
88 // ----------------------------------------------------------------------------
90 typedef LONG (WINAPI
*ChangeDisplaySettingsEx_t
)(LPCTSTR lpszDeviceName
,
96 typedef BOOL (PASCAL
*DDEnumExCallback_t
)(GUID
*pGuid
,
97 LPTSTR driverDescription
,
102 typedef HRESULT (WINAPI
*DirectDrawEnumerateEx_t
)(DDEnumExCallback_t lpCallback
,
106 typedef HRESULT (WINAPI
*DirectDrawCreate_t
)(GUID
*lpGUID
,
107 LPDIRECTDRAW
*lplpDD
,
108 IUnknown
*pUnkOuter
);
110 // ----------------------------------------------------------------------------
112 // ----------------------------------------------------------------------------
117 // handle of this monitor used by MonitorXXX() functions, never NULL
120 // IDirectDraw object used to control this display, may be NULL
121 IDirectDraw2
*m_pDD2
;
123 // DirectDraw GUID for this display, only valid when using DirectDraw
126 // the entire area of this monitor in virtual screen coordinates
129 // the display device name for this monitor, empty initially and retrieved
130 // on demand by DoGetName()
133 wxDisplayInfo() { m_hmon
= NULL
; m_pDD2
= NULL
; }
134 ~wxDisplayInfo() { if ( m_pDD2
) m_pDD2
->Release(); }
137 WX_DECLARE_OBJARRAY(wxDisplayInfo
, wxDisplayInfoArray
);
138 #include "wx/arrimpl.cpp"
139 WX_DEFINE_OBJARRAY(wxDisplayInfoArray
);
141 // this module is used to cleanup gs_displays array
142 class wxDisplayModule
: public wxModule
145 virtual bool OnInit() { return true; }
146 virtual void OnExit();
148 DECLARE_DYNAMIC_CLASS(wxDisplayModule
)
151 IMPLEMENT_DYNAMIC_CLASS(wxDisplayModule
, wxModule
)
153 // ----------------------------------------------------------------------------
155 // ----------------------------------------------------------------------------
157 // do we use DirectX?
158 static bool gs_useDirectX
= false;
160 // dynamically resolved DirectDrawCreate()
161 static DirectDrawCreate_t gs_DirectDrawCreate
= NULL
;
163 // this is not really MT-unsafe as wxDisplay is only going to be used from the
164 // main thread, i.e. we consider that it's a GUI class and so don't protect it
165 static wxDisplayInfoArray
*gs_displays
= NULL
;
167 // ===========================================================================
169 // ===========================================================================
171 // ----------------------------------------------------------------------------
172 // callbacks for monitor/modes enumeration stuff
173 // ----------------------------------------------------------------------------
175 static BOOL CALLBACK
wxmswMonitorEnumProc (
176 HMONITOR hMonitor
, // handle to display monitor
177 HDC
WXUNUSED(hdcMonitor
), // handle to monitor-appropriate device context
178 LPRECT lprcMonitor
, // pointer to monitor intersection rectangle
179 LPARAM
WXUNUSED(dwData
) // data passed from EnumDisplayMonitors (unused)
182 wxDisplayInfo
*info
= new wxDisplayInfo();
184 // we need hMonitor to be able to map display id to it which is needed for
185 // MonitorXXX() functions, in particular MonitorFromPoint()
186 info
->m_hmon
= hMonitor
;
188 // we also store the display geometry
189 info
->m_rect
.SetX ( lprcMonitor
->left
);
190 info
->m_rect
.SetY ( lprcMonitor
->top
);
191 info
->m_rect
.SetWidth ( lprcMonitor
->right
- lprcMonitor
->left
);
192 info
->m_rect
.SetHeight ( lprcMonitor
->bottom
- lprcMonitor
->top
);
194 // now add this monitor to the array
195 gs_displays
->Add(info
);
197 // continue the enumeration
202 wxDDEnumExCallback(GUID
*pGuid
,
203 LPTSTR
WXUNUSED(driverDescription
),
205 LPVOID
WXUNUSED(lpContext
),
210 wxDisplayInfo
*info
= new wxDisplayInfo();
213 info
->m_guid
= *pGuid
;
214 info
->m_devName
= driverName
;
216 gs_displays
->Add(info
);
218 //else: we're called for the primary monitor, skip it
220 // continue the enumeration
224 HRESULT WINAPI
wxDDEnumModesCallback(LPDDSURFACEDESC lpDDSurfaceDesc
,
227 // we need at least the mode size
228 static const DWORD FLAGS_REQUIRED
= DDSD_HEIGHT
| DDSD_WIDTH
;
229 if ( (lpDDSurfaceDesc
->dwFlags
& FLAGS_REQUIRED
) == FLAGS_REQUIRED
)
231 wxArrayVideoModes
* const modes
= (wxArrayVideoModes
*)lpContext
;
233 modes
->Add(wxVideoMode(lpDDSurfaceDesc
->dwWidth
,
234 lpDDSurfaceDesc
->dwHeight
,
235 lpDDSurfaceDesc
->ddpfPixelFormat
.dwRGBBitCount
,
236 lpDDSurfaceDesc
->dwRefreshRate
));
239 // continue the enumeration
243 // ----------------------------------------------------------------------------
245 // ----------------------------------------------------------------------------
247 // initialize gs_displays using DirectX functions
248 static bool DoInitDirectX()
251 // suppress the errors if ddraw.dll is not found
252 wxLog::EnableLogging(false);
255 wxDynamicLibrary
dllDX(_T("ddraw.dll"));
258 wxLog::EnableLogging();
261 if ( !dllDX
.IsLoaded() )
264 DirectDrawEnumerateEx_t pDDEnumEx
= (DirectDrawEnumerateEx_t
)
265 dllDX
.GetSymbol(WINFUNC(DirectDrawEnumerateEx
));
269 // we'll also need DirectDrawCreate() later, resolve it right now
270 gs_DirectDrawCreate
= (DirectDrawCreate_t
)
271 dllDX
.GetSymbol(_T("DirectDrawCreate"));
272 if ( !gs_DirectDrawCreate
)
275 if ( (*pDDEnumEx
)(wxDDEnumExCallback
,
277 DDENUM_ATTACHEDSECONDARYDEVICES
) != DD_OK
)
282 // ok, it seems like we're going to use DirectDraw and so we're going to
283 // need ddraw.dll all the time, don't unload it
289 // initialize gs_displays using the standard Windows functions
290 static void DoInitStdWindows()
292 // enumerate all displays
293 if ( !::EnumDisplayMonitors(NULL
, NULL
, wxmswMonitorEnumProc
, 0) )
295 wxLogLastError(wxT("EnumDisplayMonitors"));
297 // TODO: still create at least one (valid) entry in gs_displays for the
302 // this function must be called before accessing gs_displays array as it
303 // creates and initializes it
304 static void InitDisplays()
309 gs_displays
= new wxDisplayInfoArray();
311 if ( !gs_useDirectX
|| !DoInitDirectX() )
313 // either we were told not to try to use DirectX or fall back to std
314 // functions if DirectX method failed
315 gs_useDirectX
= false;
321 // convert a DEVMODE to our wxVideoMode
322 wxVideoMode
ConvertToVideoMode(const DEVMODE
& dm
)
324 // note that dmDisplayFrequency may be 0 or 1 meaning "standard one" and
325 // although 0 is ok for us we don't want to return modes with 1hz refresh
326 return wxVideoMode(dm
.dmPelsWidth
,
329 dm
.dmDisplayFrequency
> 1 ? dm
.dmDisplayFrequency
: 0);
332 // emulation of ChangeDisplaySettingsEx() for Win95
333 LONG WINAPI
ChangeDisplaySettingsExForWin95(LPCTSTR
WXUNUSED(lpszDeviceName
),
337 LPVOID
WXUNUSED(lParam
))
339 return ::ChangeDisplaySettings(lpDevMode
, dwFlags
);
342 // ----------------------------------------------------------------------------
344 // ----------------------------------------------------------------------------
346 void wxDisplayModule::OnExit()
351 // ---------------------------------------------------------------------------
353 // ---------------------------------------------------------------------------
356 void wxDisplay::UseDirectX(bool useDX
)
358 wxCHECK_RET( !gs_displays
, _T("it is too late to call UseDirectX") );
360 gs_useDirectX
= useDX
;
363 // helper of GetFromPoint() and GetFromWindow()
364 static int DisplayFromHMONITOR(HMONITOR hmon
)
368 const size_t count
= wxDisplay::GetCount();
370 for ( size_t n
= 0; n
< count
; n
++ )
372 if ( hmon
== (*gs_displays
)[n
].m_hmon
)
381 size_t wxDisplayBase::GetCount()
385 //RN: FIXME: This is wrong - the display info array should reload after every call
386 //to GetCount() - otherwise it will not be accurate.
387 //The user can change the number of displays in display properties/settings
388 //after GetCount or similar is called and really mess this up...
389 //wxASSERT_MSG( gs_displays->GetCount() == (size_t)::GetSystemMetrics(SM_CMONITORS),
390 // _T("So how many displays does this system have?") );
392 return gs_displays
->GetCount();
396 int wxDisplayBase::GetFromPoint ( const wxPoint
& pt
)
402 return DisplayFromHMONITOR(::MonitorFromPoint(pt2
, MONITOR_DEFAULTTONULL
));
406 int wxDisplayBase::GetFromWindow(wxWindow
*window
)
408 return DisplayFromHMONITOR
410 ::MonitorFromWindow(GetHwndOf(window
), MONITOR_DEFAULTTONULL
)
414 // ----------------------------------------------------------------------------
415 // wxDisplay ctor/dtor
416 // ----------------------------------------------------------------------------
418 wxDisplay::wxDisplay ( size_t n
)
419 : wxDisplayBase ( n
)
421 // if we do this in ctor we won't have to call it from all the member
427 wxDisplayInfo
& dpyInfo
= (*gs_displays
)[n
];
429 LPDIRECTDRAW2
& pDD2
= dpyInfo
.m_pDD2
;
432 if ( !gs_DirectDrawCreate
)
439 HRESULT hr
= (*gs_DirectDrawCreate
)(&dpyInfo
.m_guid
, &pDD
, NULL
);
441 if ( FAILED(hr
) || !pDD
)
444 wxLogApiError(_T("DirectDrawCreate"), hr
);
446 else // got IDirectDraw, we want IDirectDraw2
448 hr
= pDD
->QueryInterface(wxIID_IDirectDraw2
, (void **)&pDD2
);
449 if ( FAILED(hr
) || !pDD2
)
451 wxLogApiError(_T("IDirectDraw::QueryInterface(IDD2)"), hr
);
457 //else: DirectDraw object corresponding to our display already exists
459 // increment its ref count to account for Release() in dtor
461 // NB: pDD2 will be only really Release()d when gs_displays is
462 // destroyed which is ok as we don't want to recreate DD objects
468 wxDisplay::~wxDisplay()
470 wxDisplayInfo
& dpyInfo
= (*gs_displays
)[m_index
];
472 LPDIRECTDRAW2
& pDD2
= dpyInfo
.m_pDD2
;
479 // ----------------------------------------------------------------------------
480 // wxDisplay simple accessors
481 // ----------------------------------------------------------------------------
483 bool wxDisplay::IsOk() const
485 return m_index
< GetCount() &&
486 (!gs_useDirectX
|| (*gs_displays
)[m_index
].m_pDD2
);
489 wxRect
wxDisplay::GetGeometry() const
491 wxDisplayInfo
& dpyInfo
= (*gs_displays
)[m_index
];
492 wxRect
& rect
= dpyInfo
.m_rect
;
496 wxZeroMemory(monInfo
);
497 monInfo
.cbSize
= sizeof(monInfo
);
499 if ( !::GetMonitorInfo(dpyInfo
.m_hmon
, &monInfo
) )
501 wxLogLastError(_T("GetMonitorInfo"));
505 wxCopyRECTToRect(monInfo
.rcMonitor
, rect
);
512 wxString
wxDisplay::GetName() const
514 wxDisplayInfo
& dpyInfo
= (*gs_displays
)[m_index
];
515 if ( dpyInfo
.m_devName
.empty() )
517 MONITORINFOEX monInfo
;
518 wxZeroMemory(monInfo
);
519 monInfo
.cbSize
= sizeof(monInfo
);
521 // NB: Cast from MONITORINFOEX* to MONITORINFO* is done because
522 // Mingw headers - unlike the ones from Microsoft's Platform SDK -
523 // don't derive the former from the latter in C++ mode and so
524 // the pointer's type is not converted implicitly.
525 if ( !::GetMonitorInfo(dpyInfo
.m_hmon
, (LPMONITORINFO
)&monInfo
) )
527 wxLogLastError(_T("GetMonitorInfo"));
531 dpyInfo
.m_devName
= monInfo
.szDevice
;
535 return dpyInfo
.m_devName
;
538 wxString
wxDisplay::GetNameForEnumSettings() const
541 const bool isWin95
= wxGetOsVersion(&major
, &minor
) == wxWIN95
&&
542 major
== 4 && minor
== 0;
544 // the first parameter of EnumDisplaySettings() must be NULL under Win95
545 // according to MSDN but GetMonitorInfo() stub in multimon.h still returns
546 // something even in this case, so we have to correct this manually
554 // ----------------------------------------------------------------------------
555 // determine if this is the primary display
556 // ----------------------------------------------------------------------------
558 bool wxDisplay::IsPrimary() const
560 wxDisplayInfo
& dpyInfo
= (*gs_displays
)[m_index
];
562 MONITORINFOEX monInfo
;
563 wxZeroMemory(monInfo
);
564 monInfo
.cbSize
= sizeof(monInfo
);
566 // NB: Cast from MONITORINFOEX* to MONITORINFO* is done because
567 // Mingw headers - unlike the ones from Microsoft's Platform SDK -
568 // don't derive the former from the latter in C++ mode and so
569 // the pointer's type is not converted implicitly.
570 if ( !::GetMonitorInfo(dpyInfo
.m_hmon
, (LPMONITORINFO
)&monInfo
) )
572 wxLogLastError(_T("GetMonitorInfo"));
575 return (monInfo
.dwFlags
& MONITORINFOF_PRIMARY
) == MONITORINFOF_PRIMARY
;
578 // ----------------------------------------------------------------------------
579 // video modes enumeration
580 // ----------------------------------------------------------------------------
583 wxDisplay::DoGetModesDirectX(const wxVideoMode
& WXUNUSED(modeMatch
)) const
585 wxArrayVideoModes modes
;
587 IDirectDraw2
*pDD
= (*gs_displays
)[m_index
].m_pDD2
;
591 HRESULT hr
= pDD
->EnumDisplayModes
594 NULL
, // all modes (TODO: use modeMatch!)
595 &modes
, // callback parameter
596 wxDDEnumModesCallback
601 wxLogApiError(_T("IDirectDraw::EnumDisplayModes"), hr
);
609 wxDisplay::DoGetModesWindows(const wxVideoMode
& modeMatch
) const
611 wxArrayVideoModes modes
;
613 const wxString name
= GetNameForEnumSettings();
615 const wxChar
* const deviceName
= name
.empty() ? NULL
: name
.c_str();
618 for ( int iModeNum
= 0;
619 ::EnumDisplaySettings(deviceName
, iModeNum
, &dm
);
622 const wxVideoMode mode
= ConvertToVideoMode(dm
);
623 if ( mode
.Matches(modeMatch
) )
632 wxArrayVideoModes
wxDisplay::GetModes(const wxVideoMode
& modeMatch
) const
634 return gs_useDirectX
? DoGetModesDirectX(modeMatch
)
635 : DoGetModesWindows(modeMatch
);
638 wxVideoMode
wxDisplay::GetCurrentMode() const
642 const wxString name
= GetNameForEnumSettings();
645 if ( !::EnumDisplaySettings(name
.empty() ? NULL
: name
.c_str(),
646 ENUM_CURRENT_SETTINGS
,
649 wxLogLastError(_T("EnumDisplaySettings(ENUM_CURRENT_SETTINGS)"));
653 mode
= ConvertToVideoMode(dm
);
659 // ----------------------------------------------------------------------------
660 // video mode switching
661 // ----------------------------------------------------------------------------
663 bool wxDisplay::DoChangeModeDirectX(const wxVideoMode
& mode
)
665 IDirectDraw2
*pDD
= (*gs_displays
)[m_index
].m_pDD2
;
669 wxWindow
*winTop
= wxTheApp
->GetTopWindow();
670 wxCHECK_MSG( winTop
, false, _T("top level window required for DirectX") );
672 HRESULT hr
= pDD
->SetCooperativeLevel
675 DDSCL_EXCLUSIVE
| DDSCL_FULLSCREEN
679 wxLogApiError(_T("IDirectDraw::SetCooperativeLevel"), hr
);
684 hr
= pDD
->SetDisplayMode(mode
.w
, mode
.h
, mode
.bpp
, mode
.refresh
, 0);
687 wxLogApiError(_T("IDirectDraw::SetDisplayMode"), hr
);
696 bool wxDisplay::DoChangeModeWindows(const wxVideoMode
& mode
)
698 // prepare ChangeDisplaySettingsEx() parameters
703 if ( mode
== wxDefaultVideoMode
)
705 // reset the video mode to default
709 else // change to the given mode
711 wxCHECK_MSG( mode
.w
&& mode
.h
, false,
712 _T("at least the width and height must be specified") );
715 dm
.dmSize
= sizeof(dm
);
716 dm
.dmFields
= DM_PELSWIDTH
| DM_PELSHEIGHT
;
717 dm
.dmPelsWidth
= mode
.w
;
718 dm
.dmPelsHeight
= mode
.h
;
722 dm
.dmFields
|= DM_BITSPERPEL
;
723 dm
.dmBitsPerPel
= mode
.bpp
;
728 dm
.dmFields
|= DM_DISPLAYFREQUENCY
;
729 dm
.dmDisplayFrequency
= mode
.refresh
;
734 flags
= CDS_FULLSCREEN
;
738 // get pointer to the function dynamically
740 // we're only called from the main thread, so it's ok to use static
742 static ChangeDisplaySettingsEx_t pfnChangeDisplaySettingsEx
= NULL
;
743 if ( !pfnChangeDisplaySettingsEx
)
745 wxDynamicLibrary
dllUser32(_T("user32.dll"));
746 if ( dllUser32
.IsLoaded() )
748 pfnChangeDisplaySettingsEx
= (ChangeDisplaySettingsEx_t
)
749 dllUser32
.GetSymbol(WINFUNC(ChangeDisplaySettingsEx
));
751 //else: huh, no user32.dll??
753 if ( !pfnChangeDisplaySettingsEx
)
755 // we must be under Win95 and so there is no multiple monitors
757 pfnChangeDisplaySettingsEx
= ChangeDisplaySettingsExForWin95
;
761 // do change the mode
762 switch ( pfnChangeDisplaySettingsEx
764 GetName(), // display name
765 pDevMode
, // dev mode or NULL to reset
768 NULL
// pointer to video parameters (not used)
771 case DISP_CHANGE_SUCCESSFUL
:
774 // If we have a top-level, full-screen frame, emulate
775 // the DirectX behavior and resize it. This makes this
776 // API quite a bit easier to use.
777 wxWindow
*winTop
= wxTheApp
->GetTopWindow();
778 wxFrame
*frameTop
= wxDynamicCast(winTop
, wxFrame
);
779 if (frameTop
&& frameTop
->IsFullScreen())
781 wxVideoMode current
= GetCurrentMode();
782 frameTop
->SetClientSize(current
.w
, current
.h
);
787 case DISP_CHANGE_BADMODE
:
788 // don't complain about this, this is the only "expected" error
792 wxFAIL_MSG( _T("unexpected ChangeDisplaySettingsEx() return value") );
798 bool wxDisplay::ChangeMode(const wxVideoMode
& mode
)
800 return gs_useDirectX
? DoChangeModeDirectX(mode
)
801 : DoChangeModeWindows(mode
);
804 #endif // wxUSE_DISPLAY