1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: MSW Implementation of wxDisplay class
4 // Author: Royce Mitchell III, Ryan Norton
5 // Modified by: VZ (resolutions enumeration/change support, DirectDraw, ...)
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ===========================================================================
14 // ===========================================================================
16 // ---------------------------------------------------------------------------
18 // ---------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "display.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
35 #include "wx/dynarray.h"
39 #include "wx/dynload.h"
41 #include "wx/display.h"
43 // the following define is necessary to access the multi-monitor function
44 // declarations in a manner safe to use w/ Windows 95
45 #define COMPILE_MULTIMON_STUBS
47 // if you don't have multimon.h you can download the file from:
49 // http://www.microsoft.com/msj/0697/monitor/monitortextfigs.htm#fig4
53 // as (m)any standard header(s), this one doesn't compile without warnings
55 #pragma warning(disable:4706)
61 #pragma warning(default:4706)
66 // we don't want to link with ddraw.lib which contains the real
67 // IID_IDirectDraw2 definition
68 const GUID wxIID_IDirectDraw2
=
69 { 0xB3A6F3E0, 0x2B43, 0x11CF, { 0xA2,0xDE,0x00,0xAA,0x00,0xB9,0x33,0x56 } };
71 // ----------------------------------------------------------------------------
73 // ----------------------------------------------------------------------------
76 #define WINFUNC(x) _T(#x) L"W"
78 #define WINFUNC(x) #x "A"
81 // ----------------------------------------------------------------------------
82 // typedefs for dynamically loaded Windows functions
83 // ----------------------------------------------------------------------------
85 typedef LONG (WINAPI
*ChangeDisplaySettingsEx_t
)(LPCTSTR lpszDeviceName
,
91 typedef BOOL (PASCAL
*DDEnumExCallback_t
)(GUID
*pGuid
,
92 LPTSTR driverDescription
,
97 typedef HRESULT (WINAPI
*DirectDrawEnumerateEx_t
)(DDEnumExCallback_t lpCallback
,
101 typedef HRESULT (WINAPI
*DirectDrawCreate_t
)(GUID
*lpGUID
,
102 LPDIRECTDRAW
*lplpDD
,
103 IUnknown
*pUnkOuter
);
105 // ----------------------------------------------------------------------------
107 // ----------------------------------------------------------------------------
112 // handle of this monitor used by MonitorXXX() functions, never NULL
115 // IDirectDraw object used to control this display, may be NULL
116 IDirectDraw2
*m_pDD2
;
118 // DirectDraw GUID for this display, only valid when using DirectDraw
121 // the entire area of this monitor in virtual screen coordinates
124 // the display device name for this monitor, empty initially and retrieved
125 // on demand by DoGetName()
128 wxDisplayInfo() { m_hmon
= NULL
; m_pDD2
= NULL
; }
129 ~wxDisplayInfo() { if ( m_pDD2
) m_pDD2
->Release(); }
132 WX_DECLARE_OBJARRAY(wxDisplayInfo
, wxDisplayInfoArray
);
133 #include "wx/arrimpl.cpp"
134 WX_DEFINE_OBJARRAY(wxDisplayInfoArray
);
136 // this module is used to cleanup gs_displays array
137 class wxDisplayModule
: public wxModule
140 virtual bool OnInit() { return true; }
141 virtual void OnExit();
143 DECLARE_DYNAMIC_CLASS(wxDisplayModule
)
146 IMPLEMENT_DYNAMIC_CLASS(wxDisplayModule
, wxModule
)
148 // ----------------------------------------------------------------------------
150 // ----------------------------------------------------------------------------
152 // do we use DirectX?
153 static bool gs_useDirectX
= false;
155 // dynamically resolved DirectDrawCreate()
156 static DirectDrawCreate_t gs_DirectDrawCreate
= NULL
;
158 // this is not really MT-unsafe as wxDisplay is only going to be used from the
159 // main thread, i.e. we consider that it's a GUI class and so don't protect it
160 static wxDisplayInfoArray
*gs_displays
= NULL
;
162 // ===========================================================================
164 // ===========================================================================
166 // ----------------------------------------------------------------------------
167 // callbacks for monitor/modes enumeration stuff
168 // ----------------------------------------------------------------------------
170 static BOOL CALLBACK
wxmswMonitorEnumProc (
171 HMONITOR hMonitor
, // handle to display monitor
172 HDC
WXUNUSED(hdcMonitor
), // handle to monitor-appropriate device context
173 LPRECT lprcMonitor
, // pointer to monitor intersection rectangle
174 LPARAM
WXUNUSED(dwData
) // data passed from EnumDisplayMonitors (unused)
177 wxDisplayInfo
*info
= new wxDisplayInfo();
179 // we need hMonitor to be able to map display id to it which is needed for
180 // MonitorXXX() functions, in particular MonitorFromPoint()
181 info
->m_hmon
= hMonitor
;
183 // we also store the display geometry
184 info
->m_rect
.SetX ( lprcMonitor
->left
);
185 info
->m_rect
.SetY ( lprcMonitor
->top
);
186 info
->m_rect
.SetWidth ( lprcMonitor
->right
- lprcMonitor
->left
);
187 info
->m_rect
.SetHeight ( lprcMonitor
->bottom
- lprcMonitor
->top
);
189 // now add this monitor to the array
190 gs_displays
->Add(info
);
192 // continue the enumeration
197 wxDDEnumExCallback(GUID
*pGuid
,
198 LPTSTR
WXUNUSED(driverDescription
),
200 LPVOID
WXUNUSED(lpContext
),
205 wxDisplayInfo
*info
= new wxDisplayInfo();
208 info
->m_guid
= *pGuid
;
209 info
->m_devName
= driverName
;
211 gs_displays
->Add(info
);
213 //else: we're called for the primary monitor, skip it
215 // continue the enumeration
219 HRESULT WINAPI
wxDDEnumModesCallback(LPDDSURFACEDESC lpDDSurfaceDesc
,
222 // we need at least the mode size
223 static const DWORD FLAGS_REQUIRED
= DDSD_HEIGHT
| DDSD_WIDTH
;
224 if ( (lpDDSurfaceDesc
->dwFlags
& FLAGS_REQUIRED
) == FLAGS_REQUIRED
)
226 wxArrayVideoModes
* const modes
= (wxArrayVideoModes
*)lpContext
;
228 modes
->Add(wxVideoMode(lpDDSurfaceDesc
->dwWidth
,
229 lpDDSurfaceDesc
->dwHeight
,
230 lpDDSurfaceDesc
->ddpfPixelFormat
.dwRGBBitCount
,
231 lpDDSurfaceDesc
->dwRefreshRate
));
234 // continue the enumeration
238 // ----------------------------------------------------------------------------
240 // ----------------------------------------------------------------------------
242 // initialize gs_displays using DirectX functions
243 static bool DoInitDirectX()
246 // suppress the errors if ddraw.dll is not found
247 wxLog::EnableLogging(false);
250 wxDynamicLibrary
dllDX(_T("ddraw.dll"));
253 wxLog::EnableLogging();
256 if ( !dllDX
.IsLoaded() )
259 DirectDrawEnumerateEx_t pDDEnumEx
= (DirectDrawEnumerateEx_t
)
260 dllDX
.GetSymbol(WINFUNC(DirectDrawEnumerateEx
));
264 // we'll also need DirectDrawCreate() later, resolve it right now
265 gs_DirectDrawCreate
= (DirectDrawCreate_t
)
266 dllDX
.GetSymbol(_T("DirectDrawCreate"));
267 if ( !gs_DirectDrawCreate
)
270 if ( (*pDDEnumEx
)(wxDDEnumExCallback
,
272 DDENUM_ATTACHEDSECONDARYDEVICES
) != DD_OK
)
277 // ok, it seems like we're going to use DirectDraw and so we're going to
278 // need ddraw.dll all the time, don't unload it
284 // initialize gs_displays using the standard Windows functions
285 static void DoInitStdWindows()
287 // enumerate all displays
288 if ( !::EnumDisplayMonitors(NULL
, NULL
, wxmswMonitorEnumProc
, 0) )
290 wxLogLastError(wxT("EnumDisplayMonitors"));
292 // TODO: still create at least one (valid) entry in gs_displays for the
297 // this function must be called before accessing gs_displays array as it
298 // creates and initializes it
299 static void InitDisplays()
304 gs_displays
= new wxDisplayInfoArray();
306 if ( !gs_useDirectX
|| !DoInitDirectX() )
308 // either we were told not to try to use DirectX or fall back to std
309 // functions if DirectX method failed
310 gs_useDirectX
= false;
316 // convert a DEVMODE to our wxVideoMode
317 wxVideoMode
ConvertToVideoMode(const DEVMODE
& dm
)
319 // note that dmDisplayFrequency may be 0 or 1 meaning "standard one" and
320 // although 0 is ok for us we don't want to return modes with 1hz refresh
321 return wxVideoMode(dm
.dmPelsWidth
,
324 dm
.dmDisplayFrequency
> 1 ? dm
.dmDisplayFrequency
: 0);
327 // emulation of ChangeDisplaySettingsEx() for Win95
328 LONG WINAPI
ChangeDisplaySettingsExForWin95(LPCTSTR
WXUNUSED(lpszDeviceName
),
332 LPVOID
WXUNUSED(lParam
))
334 return ::ChangeDisplaySettings(lpDevMode
, dwFlags
);
337 // ----------------------------------------------------------------------------
339 // ----------------------------------------------------------------------------
341 void wxDisplayModule::OnExit()
346 // ---------------------------------------------------------------------------
348 // ---------------------------------------------------------------------------
351 void wxDisplay::UseDirectX(bool useDX
)
353 wxCHECK_RET( !gs_displays
, _T("it is too late to call UseDirectX") );
355 gs_useDirectX
= useDX
;
358 // helper of GetFromPoint() and GetFromWindow()
359 static int DisplayFromHMONITOR(HMONITOR hmon
)
363 const size_t count
= wxDisplay::GetCount();
365 for ( size_t n
= 0; n
< count
; n
++ )
367 if ( hmon
== (*gs_displays
)[n
].m_hmon
)
376 size_t wxDisplayBase::GetCount()
380 // I'm not sure if they really always return the same thing and if this is
381 // not true I'd like to know in which situation does it happen
382 wxASSERT_MSG( gs_displays
->GetCount() == (size_t)::GetSystemMetrics(SM_CMONITORS
),
383 _T("So how many displays does this system have?") );
385 return gs_displays
->GetCount();
389 int wxDisplayBase::GetFromPoint ( const wxPoint
& pt
)
395 return DisplayFromHMONITOR(::MonitorFromPoint(pt2
, MONITOR_DEFAULTTONULL
));
399 int wxDisplayBase::GetFromWindow(wxWindow
*window
)
401 return DisplayFromHMONITOR
403 ::MonitorFromWindow(GetHwndOf(window
), MONITOR_DEFAULTTONULL
)
407 // ----------------------------------------------------------------------------
408 // wxDisplay ctor/dtor
409 // ----------------------------------------------------------------------------
411 wxDisplay::wxDisplay ( size_t n
)
412 : wxDisplayBase ( n
)
414 // if we do this in ctor we won't have to call it from all the member
420 wxDisplayInfo
& dpyInfo
= (*gs_displays
)[n
];
422 LPDIRECTDRAW2
& pDD2
= dpyInfo
.m_pDD2
;
425 if ( !gs_DirectDrawCreate
)
432 HRESULT hr
= (*gs_DirectDrawCreate
)(&dpyInfo
.m_guid
, &pDD
, NULL
);
434 if ( FAILED(hr
) || !pDD
)
437 wxLogApiError(_T("DirectDrawCreate"), hr
);
439 else // got IDirectDraw, we want IDirectDraw2
441 hr
= pDD
->QueryInterface(wxIID_IDirectDraw2
, (void **)&pDD2
);
442 if ( FAILED(hr
) || !pDD2
)
444 wxLogApiError(_T("IDirectDraw::QueryInterface(IDD2)"), hr
);
450 //else: DirectDraw object corresponding to our display already exists
452 // increment its ref count to account for Release() in dtor
454 // NB: pDD2 will be only really Release()d when gs_displays is
455 // destroyed which is ok as we don't want to recreate DD objects
461 wxDisplay::~wxDisplay()
463 wxDisplayInfo
& dpyInfo
= (*gs_displays
)[m_index
];
465 LPDIRECTDRAW2
& pDD2
= dpyInfo
.m_pDD2
;
472 // ----------------------------------------------------------------------------
473 // wxDisplay simple accessors
474 // ----------------------------------------------------------------------------
476 bool wxDisplay::IsOk() const
478 return m_index
< GetCount() &&
479 (!gs_useDirectX
|| (*gs_displays
)[m_index
].m_pDD2
);
482 wxRect
wxDisplay::GetGeometry() const
484 wxDisplayInfo
& dpyInfo
= (*gs_displays
)[m_index
];
485 wxRect
& rect
= dpyInfo
.m_rect
;
489 wxZeroMemory(monInfo
);
490 monInfo
.cbSize
= sizeof(monInfo
);
492 if ( !::GetMonitorInfo(dpyInfo
.m_hmon
, &monInfo
) )
494 wxLogLastError(_T("GetMonitorInfo"));
498 wxCopyRECTToRect(monInfo
.rcMonitor
, rect
);
505 wxString
wxDisplay::GetName() const
507 wxDisplayInfo
& dpyInfo
= (*gs_displays
)[m_index
];
508 if ( dpyInfo
.m_devName
.empty() )
510 MONITORINFOEX monInfo
;
511 wxZeroMemory(monInfo
);
512 monInfo
.cbSize
= sizeof(monInfo
);
514 // NB: Cast from MONITORINFOEX* to MONITORINFO* is done because
515 // Mingw headers - unlike the ones from Microsoft's Platform SDK -
516 // don't derive the former from the latter in C++ mode and so
517 // the pointer's type is not converted implicitly.
518 if ( !::GetMonitorInfo(dpyInfo
.m_hmon
, (LPMONITORINFO
)&monInfo
) )
520 wxLogLastError(_T("GetMonitorInfo"));
524 dpyInfo
.m_devName
= monInfo
.szDevice
;
528 return dpyInfo
.m_devName
;
531 wxString
wxDisplay::GetNameForEnumSettings() const
534 const bool isWin95
= wxGetOsVersion(&major
, &minor
) == wxWIN95
&&
535 major
== 4 && minor
== 0;
537 // the first parameter of EnumDisplaySettings() must be NULL under Win95
538 // according to MSDN but GetMonitorInfo() stub in multimon.h still returns
539 // something even in this case, so we have to correct this manually
547 // ----------------------------------------------------------------------------
548 // determine if this is the primary display
549 // ----------------------------------------------------------------------------
551 bool wxDisplay::IsPrimary() const
553 wxDisplayInfo
& dpyInfo
= (*gs_displays
)[m_index
];
555 MONITORINFOEX monInfo
;
556 wxZeroMemory(monInfo
);
557 monInfo
.cbSize
= sizeof(monInfo
);
559 // NB: Cast from MONITORINFOEX* to MONITORINFO* is done because
560 // Mingw headers - unlike the ones from Microsoft's Platform SDK -
561 // don't derive the former from the latter in C++ mode and so
562 // the pointer's type is not converted implicitly.
563 if ( !::GetMonitorInfo(dpyInfo
.m_hmon
, (LPMONITORINFO
)&monInfo
) )
565 wxLogLastError(_T("GetMonitorInfo"));
568 return (monInfo
.dwFlags
& MONITORINFOF_PRIMARY
) == MONITORINFOF_PRIMARY
;
571 // ----------------------------------------------------------------------------
572 // video modes enumeration
573 // ----------------------------------------------------------------------------
576 wxDisplay::DoGetModesDirectX(const wxVideoMode
& WXUNUSED(modeMatch
)) const
578 wxArrayVideoModes modes
;
580 IDirectDraw2
*pDD
= (*gs_displays
)[m_index
].m_pDD2
;
584 HRESULT hr
= pDD
->EnumDisplayModes
587 NULL
, // all modes (TODO: use modeMatch!)
588 &modes
, // callback parameter
589 wxDDEnumModesCallback
594 wxLogApiError(_T("IDirectDraw::EnumDisplayModes"), hr
);
602 wxDisplay::DoGetModesWindows(const wxVideoMode
& modeMatch
) const
604 wxArrayVideoModes modes
;
606 const wxString name
= GetNameForEnumSettings();
608 const wxChar
* const deviceName
= name
.empty() ? NULL
: name
.c_str();
611 for ( int iModeNum
= 0;
612 ::EnumDisplaySettings(deviceName
, iModeNum
, &dm
);
615 const wxVideoMode mode
= ConvertToVideoMode(dm
);
616 if ( mode
.Matches(modeMatch
) )
625 wxArrayVideoModes
wxDisplay::GetModes(const wxVideoMode
& modeMatch
) const
627 return gs_useDirectX
? DoGetModesDirectX(modeMatch
)
628 : DoGetModesWindows(modeMatch
);
631 wxVideoMode
wxDisplay::GetCurrentMode() const
635 const wxString name
= GetNameForEnumSettings();
638 if ( !::EnumDisplaySettings(name
.empty() ? NULL
: name
.c_str(),
639 ENUM_CURRENT_SETTINGS
,
642 wxLogLastError(_T("EnumDisplaySettings(ENUM_CURRENT_SETTINGS)"));
646 mode
= ConvertToVideoMode(dm
);
652 // ----------------------------------------------------------------------------
653 // video mode switching
654 // ----------------------------------------------------------------------------
656 bool wxDisplay::DoChangeModeDirectX(const wxVideoMode
& mode
)
658 IDirectDraw2
*pDD
= (*gs_displays
)[m_index
].m_pDD2
;
662 wxWindow
*winTop
= wxTheApp
->GetTopWindow();
663 wxCHECK_MSG( winTop
, false, _T("top level window required for DirectX") );
665 HRESULT hr
= pDD
->SetCooperativeLevel
668 DDSCL_EXCLUSIVE
| DDSCL_FULLSCREEN
672 wxLogApiError(_T("IDirectDraw::SetCooperativeLevel"), hr
);
677 hr
= pDD
->SetDisplayMode(mode
.w
, mode
.h
, mode
.bpp
, mode
.refresh
, 0);
680 wxLogApiError(_T("IDirectDraw::SetDisplayMode"), hr
);
689 bool wxDisplay::DoChangeModeWindows(const wxVideoMode
& mode
)
691 // prepare ChangeDisplaySettingsEx() parameters
696 if ( mode
== wxDefaultVideoMode
)
698 // reset the video mode to default
702 else // change to the given mode
704 wxCHECK_MSG( mode
.w
&& mode
.h
, false,
705 _T("at least the width and height must be specified") );
708 dm
.dmSize
= sizeof(dm
);
709 dm
.dmFields
= DM_PELSWIDTH
| DM_PELSHEIGHT
;
710 dm
.dmPelsWidth
= mode
.w
;
711 dm
.dmPelsHeight
= mode
.h
;
715 dm
.dmFields
|= DM_BITSPERPEL
;
716 dm
.dmBitsPerPel
= mode
.bpp
;
721 dm
.dmFields
|= DM_DISPLAYFREQUENCY
;
722 dm
.dmDisplayFrequency
= mode
.refresh
;
727 flags
= CDS_FULLSCREEN
;
731 // get pointer to the function dynamically
733 // we're only called from the main thread, so it's ok to use static
735 static ChangeDisplaySettingsEx_t pfnChangeDisplaySettingsEx
= NULL
;
736 if ( !pfnChangeDisplaySettingsEx
)
738 wxDynamicLibrary
dllUser32(_T("user32.dll"));
739 if ( dllUser32
.IsLoaded() )
741 pfnChangeDisplaySettingsEx
= (ChangeDisplaySettingsEx_t
)
742 dllUser32
.GetSymbol(WINFUNC(ChangeDisplaySettingsEx
));
744 //else: huh, no user32.dll??
746 if ( !pfnChangeDisplaySettingsEx
)
748 // we must be under Win95 and so there is no multiple monitors
750 pfnChangeDisplaySettingsEx
= ChangeDisplaySettingsExForWin95
;
754 // do change the mode
755 switch ( pfnChangeDisplaySettingsEx
757 GetName(), // display name
758 pDevMode
, // dev mode or NULL to reset
761 NULL
// pointer to video parameters (not used)
764 case DISP_CHANGE_SUCCESSFUL
:
767 // If we have a top-level, full-screen frame, emulate
768 // the DirectX behavior and resize it. This makes this
769 // API quite a bit easier to use.
770 wxWindow
*winTop
= wxTheApp
->GetTopWindow();
771 wxFrame
*frameTop
= wxDynamicCast(winTop
, wxFrame
);
772 if (frameTop
&& frameTop
->IsFullScreen())
774 wxVideoMode current
= GetCurrentMode();
775 frameTop
->SetClientSize(current
.w
, current
.h
);
780 case DISP_CHANGE_BADMODE
:
781 // don't complain about this, this is the only "expected" error
785 wxFAIL_MSG( _T("unexpected ChangeDisplaySettingsEx() return value") );
791 bool wxDisplay::ChangeMode(const wxVideoMode
& mode
)
793 return gs_useDirectX
? DoChangeModeDirectX(mode
)
794 : DoChangeModeWindows(mode
);
797 #endif // wxUSE_DISPLAY