SA-MP/saco/d3d9/common/DXUT.cpp

5015 lines
216 KiB
C++

//--------------------------------------------------------------------------------------
// File: DXUT.cpp
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//--------------------------------------------------------------------------------------
#include "dxstdafx.h"
#define DXUT_MIN_WINDOW_SIZE_X 200
#define DXUT_MIN_WINDOW_SIZE_Y 200
#undef min // use __min instead inside this source file
#undef max // use __max instead inside this source file
//--------------------------------------------------------------------------------------
// multimon.h is a stub module that fakes multiple monitor apis on Win32 OSes without them.
// Only once source file should #define COMPILE_MULTIMON_STUBS
//--------------------------------------------------------------------------------------
#define COMPILE_MULTIMON_STUBS
#include <multimon.h>
//--------------------------------------------------------------------------------------
// Thread safety
//--------------------------------------------------------------------------------------
CRITICAL_SECTION g_cs;
bool g_bThreadSafe = true;
//--------------------------------------------------------------------------------------
// Automatically enters & leaves the CS upon object creation/deletion
//--------------------------------------------------------------------------------------
class DXUTLock
{
public:
inline DXUTLock() { if( g_bThreadSafe ) EnterCriticalSection( &g_cs ); }
inline ~DXUTLock() { if( g_bThreadSafe ) LeaveCriticalSection( &g_cs ); }
};
//--------------------------------------------------------------------------------------
// Helper macros to build member functions that access member variables with thread safety
//--------------------------------------------------------------------------------------
#define SET_ACCESSOR( x, y ) inline void Set##y( x t ) { DXUTLock l; m_state.m_##y = t; };
#define GET_ACCESSOR( x, y ) inline x Get##y() { DXUTLock l; return m_state.m_##y; };
#define GET_SET_ACCESSOR( x, y ) SET_ACCESSOR( x, y ) GET_ACCESSOR( x, y )
#define SETP_ACCESSOR( x, y ) inline void Set##y( x* t ) { DXUTLock l; m_state.m_##y = *t; };
#define GETP_ACCESSOR( x, y ) inline x* Get##y() { DXUTLock l; return &m_state.m_##y; };
#define GETP_SETP_ACCESSOR( x, y ) SETP_ACCESSOR( x, y ) GETP_ACCESSOR( x, y )
//--------------------------------------------------------------------------------------
// Stores timer callback info
//--------------------------------------------------------------------------------------
struct DXUT_TIMER
{
LPDXUTCALLBACKTIMER pCallbackTimer;
void* pCallbackUserContext;
float fTimeoutInSecs;
float fCountdown;
bool bEnabled;
};
//--------------------------------------------------------------------------------------
// Stores DXUT state and data access is done with thread safety (if g_bThreadSafe==true)
//--------------------------------------------------------------------------------------
class DXUTState
{
protected:
struct STATE
{
IDirect3D9* m_D3D; // the main D3D object
IDirect3DDevice9* m_D3DDevice; // the D3D rendering device
CD3DEnumeration* m_D3DEnumeration; // CD3DEnumeration object
DXUTDeviceSettings* m_CurrentDeviceSettings; // current device settings
D3DSURFACE_DESC m_BackBufferSurfaceDesc; // back buffer surface description
D3DCAPS9 m_Caps; // D3D caps for current device
HWND m_HWNDFocus; // the main app focus window
HWND m_HWNDDeviceFullScreen; // the main app device window in fullscreen mode
HWND m_HWNDDeviceWindowed; // the main app device window in windowed mode
HMONITOR m_AdapterMonitor; // the monitor of the adapter
HMENU m_Menu; // handle to menu
UINT m_FullScreenBackBufferWidthAtModeChange; // back buffer size of fullscreen mode right before switching to windowed mode. Used to restore to same resolution when toggling back to fullscreen
UINT m_FullScreenBackBufferHeightAtModeChange; // back buffer size of fullscreen mode right before switching to windowed mode. Used to restore to same resolution when toggling back to fullscreen
UINT m_WindowBackBufferWidthAtModeChange; // back buffer size of windowed mode right before switching to fullscreen mode. Used to restore to same resolution when toggling back to windowed mode
UINT m_WindowBackBufferHeightAtModeChange; // back buffer size of windowed mode right before switching to fullscreen mode. Used to restore to same resolution when toggling back to windowed mode
DWORD m_WindowedStyleAtModeChange; // window style
WINDOWPLACEMENT m_WindowedPlacement; // record of windowed HWND position/show state/etc
bool m_Minimized; // if true, the HWND is minimized
bool m_Maximized; // if true, the HWND is maximized
bool m_MinimizedWhileFullscreen; // if true, the HWND is minimized due to a focus switch away when fullscreen mode
bool m_IgnoreSizeChange; // if true, DXUT won't reset the device upon HWND size change
double m_Time; // current time in seconds
float m_ElapsedTime; // time elapsed since last frame
HINSTANCE m_HInstance; // handle to the app instance
double m_LastStatsUpdateTime; // last time the stats were updated
DWORD m_LastStatsUpdateFrames; // frames count since last time the stats were updated
float m_FPS; // frames per second
int m_CurrentFrameNumber; // the current frame number
HHOOK m_KeyboardHook; // handle to keyboard hook
bool m_AllowShortcutKeysWhenFullscreen; // if true, when fullscreen enable shortcut keys (Windows keys, StickyKeys shortcut, ToggleKeys shortcut, FilterKeys shortcut)
bool m_AllowShortcutKeysWhenWindowed; // if true, when windowed enable shortcut keys (Windows keys, StickyKeys shortcut, ToggleKeys shortcut, FilterKeys shortcut)
bool m_AllowShortcutKeys; // if true, then shortcut keys are currently disabled (Windows key, etc)
STICKYKEYS m_StartupStickyKeys; // StickyKey settings upon startup so they can be restored later
TOGGLEKEYS m_StartupToggleKeys; // ToggleKey settings upon startup so they can be restored later
FILTERKEYS m_StartupFilterKeys; // FilterKey settings upon startup so they can be restored later
bool m_HandleDefaultHotkeys; // if true, then DXUT will handle some default hotkeys
bool m_ShowMsgBoxOnError; // if true, then msgboxes are displayed upon errors
bool m_ClipCursorWhenFullScreen; // if true, then DXUT will keep the cursor from going outside the window when full screen
bool m_ShowCursorWhenFullScreen; // if true, then DXUT will show a cursor when full screen
bool m_ConstantFrameTime; // if true, then elapsed frame time will always be 0.05f seconds which is good for debugging or automated capture
float m_TimePerFrame; // the constant time per frame in seconds, only valid if m_ConstantFrameTime==true
bool m_WireframeMode; // if true, then D3DRS_FILLMODE==D3DFILL_WIREFRAME else D3DRS_FILLMODE==D3DFILL_SOLID
bool m_AutoChangeAdapter; // if true, then the adapter will automatically change if the window is different monitor
bool m_WindowCreatedWithDefaultPositions; // if true, then CW_USEDEFAULT was used and the window should be moved to the right adapter
int m_ExitCode; // the exit code to be returned to the command line
bool m_DXUTInited; // if true, then DXUTInit() has succeeded
bool m_WindowCreated; // if true, then DXUTCreateWindow() or DXUTSetWindow() has succeeded
bool m_DeviceCreated; // if true, then DXUTCreateDevice*() or DXUTSetDevice() has succeeded
bool m_DXUTInitCalled; // if true, then DXUTInit() was called
bool m_WindowCreateCalled; // if true, then DXUTCreateWindow() or DXUTSetWindow() was called
bool m_DeviceCreateCalled; // if true, then DXUTCreateDevice*() or DXUTSetDevice() was called
bool m_DeviceObjectsCreated; // if true, then DeviceCreated callback has been called (if non-NULL)
bool m_DeviceObjectsReset; // if true, then DeviceReset callback has been called (if non-NULL)
bool m_InsideDeviceCallback; // if true, then the framework is inside an app device callback
bool m_InsideMainloop; // if true, then the framework is inside the main loop
bool m_Active; // if true, then the app is the active top level window
bool m_TimePaused; // if true, then time is paused
bool m_RenderingPaused; // if true, then rendering is paused
int m_PauseRenderingCount; // pause rendering ref count
int m_PauseTimeCount; // pause time ref count
bool m_DeviceLost; // if true, then the device is lost and needs to be reset
bool m_NotifyOnMouseMove; // if true, include WM_MOUSEMOVE in mousecallback
bool m_Automation; // if true, automation is enabled
bool m_InSizeMove; // if true, app is inside a WM_ENTERSIZEMOVE
int m_OverrideAdapterOrdinal; // if != -1, then override to use this adapter ordinal
bool m_OverrideWindowed; // if true, then force to start windowed
bool m_OverrideFullScreen; // if true, then force to start full screen
int m_OverrideStartX; // if != -1, then override to this X position of the window
int m_OverrideStartY; // if != -1, then override to this Y position of the window
int m_OverrideWidth; // if != 0, then override to this width
int m_OverrideHeight; // if != 0, then override to this height
bool m_OverrideForceHAL; // if true, then force to HAL device (failing if one doesn't exist)
bool m_OverrideForceREF; // if true, then force to REF device (failing if one doesn't exist)
bool m_OverrideForcePureHWVP; // if true, then force to use pure HWVP (failing if device doesn't support it)
bool m_OverrideForceHWVP; // if true, then force to use HWVP (failing if device doesn't support it)
bool m_OverrideForceSWVP; // if true, then force to use SWVP
bool m_OverrideConstantFrameTime; // if true, then force to constant frame time
float m_OverrideConstantTimePerFrame; // the constant time per frame in seconds if m_OverrideConstantFrameTime==true
int m_OverrideQuitAfterFrame; // if != 0, then it will force the app to quit after that frame
LPDXUTCALLBACKISDEVICEACCEPTABLE m_IsDeviceAcceptableFunc; // is device acceptable callback
LPDXUTCALLBACKMODIFYDEVICESETTINGS m_ModifyDeviceSettingsFunc; // modify device settings callback
LPDXUTCALLBACKDEVICECREATED m_DeviceCreatedFunc; // device created callback
LPDXUTCALLBACKDEVICERESET m_DeviceResetFunc; // device reset callback
LPDXUTCALLBACKDEVICELOST m_DeviceLostFunc; // device lost callback
LPDXUTCALLBACKDEVICEDESTROYED m_DeviceDestroyedFunc; // device destroyed callback
LPDXUTCALLBACKFRAMEMOVE m_FrameMoveFunc; // frame move callback
LPDXUTCALLBACKFRAMERENDER m_FrameRenderFunc; // frame render callback
LPDXUTCALLBACKKEYBOARD m_KeyboardFunc; // keyboard callback
LPDXUTCALLBACKMOUSE m_MouseFunc; // mouse callback
LPDXUTCALLBACKMSGPROC m_WindowMsgFunc; // window messages callback
void* m_IsDeviceAcceptableFuncUserContext; // user context for is device acceptable callback
void* m_ModifyDeviceSettingsFuncUserContext; // user context for modify device settings callback
void* m_DeviceCreatedUserContext; // user context for device created callback
void* m_DeviceCreatedFuncUserContext; // user context for device created callback
void* m_DeviceResetFuncUserContext; // user context for device reset callback
void* m_DeviceLostFuncUserContext; // user context for device lost callback
void* m_DeviceDestroyedFuncUserContext; // user context for device destroyed callback
void* m_FrameMoveFuncUserContext; // user context for frame move callback
void* m_FrameRenderFuncUserContext; // user context for frame render callback
void* m_KeyboardFuncUserContext; // user context for keyboard callback
void* m_MouseFuncUserContext; // user context for mouse callback
void* m_WindowMsgFuncUserContext; // user context for window messages callback
bool m_Keys[256]; // array of key state
bool m_MouseButtons[5]; // array of mouse states
CGrowableArray<DXUT_TIMER>* m_TimerList; // list of DXUT_TIMER structs
TCHAR m_StaticFrameStats[256]; // static part of frames stats
TCHAR m_FrameStats[256]; // frame stats (fps, width, etc)
TCHAR m_DeviceStats[256]; // device stats (description, device type, etc)
TCHAR m_WindowTitle[256]; // window title
};
STATE m_state;
public:
DXUTState() { Create(); }
~DXUTState() { Destroy(); }
// MATCH
void Create()
{
// Make sure these are created before DXUTState so they
// destroyed last because DXUTState cleanup needs them
DXUTGetGlobalResourceCache();
ZeroMemory( &m_state, sizeof(STATE) );
g_bThreadSafe = true;
InitializeCriticalSection( &g_cs );
m_state.m_OverrideStartX = -1;
m_state.m_OverrideStartY = -1;
m_state.m_OverrideAdapterOrdinal = -1;
m_state.m_AutoChangeAdapter = true;
m_state.m_ShowMsgBoxOnError = true;
m_state.m_AllowShortcutKeysWhenWindowed = true;
m_state.m_Active = true;
}
void Destroy()
{
DXUTShutdown();
DeleteCriticalSection( &g_cs );
}
// Macros to define access functions for thread safe access into m_state
GET_SET_ACCESSOR( IDirect3D9*, D3D );
GET_SET_ACCESSOR( IDirect3DDevice9*, D3DDevice );
GET_SET_ACCESSOR( CD3DEnumeration*, D3DEnumeration );
GET_SET_ACCESSOR( DXUTDeviceSettings*, CurrentDeviceSettings );
GETP_SETP_ACCESSOR( D3DSURFACE_DESC, BackBufferSurfaceDesc );
GETP_SETP_ACCESSOR( D3DCAPS9, Caps );
GET_SET_ACCESSOR( HWND, HWNDFocus );
GET_SET_ACCESSOR( HWND, HWNDDeviceFullScreen );
GET_SET_ACCESSOR( HWND, HWNDDeviceWindowed );
GET_SET_ACCESSOR( HMONITOR, AdapterMonitor );
GET_SET_ACCESSOR( HMENU, Menu );
GET_SET_ACCESSOR( UINT, FullScreenBackBufferWidthAtModeChange );
GET_SET_ACCESSOR( UINT, FullScreenBackBufferHeightAtModeChange );
GET_SET_ACCESSOR( UINT, WindowBackBufferWidthAtModeChange );
GET_SET_ACCESSOR( UINT, WindowBackBufferHeightAtModeChange );
GETP_SETP_ACCESSOR( WINDOWPLACEMENT, WindowedPlacement );
GET_SET_ACCESSOR( DWORD, WindowedStyleAtModeChange );
GET_SET_ACCESSOR( bool, Minimized );
GET_SET_ACCESSOR( bool, Maximized );
GET_SET_ACCESSOR( bool, MinimizedWhileFullscreen );
GET_SET_ACCESSOR( bool, IgnoreSizeChange );
GET_SET_ACCESSOR( double, Time );
GET_SET_ACCESSOR( float, ElapsedTime );
GET_SET_ACCESSOR( HINSTANCE, HInstance );
GET_SET_ACCESSOR( double, LastStatsUpdateTime );
GET_SET_ACCESSOR( DWORD, LastStatsUpdateFrames );
GET_SET_ACCESSOR( float, FPS );
GET_SET_ACCESSOR( int, CurrentFrameNumber );
GET_SET_ACCESSOR( HHOOK, KeyboardHook );
GET_SET_ACCESSOR( bool, AllowShortcutKeysWhenFullscreen );
GET_SET_ACCESSOR( bool, AllowShortcutKeysWhenWindowed );
GET_SET_ACCESSOR( bool, AllowShortcutKeys );
GET_SET_ACCESSOR( STICKYKEYS, StartupStickyKeys );
GET_SET_ACCESSOR( TOGGLEKEYS, StartupToggleKeys );
GET_SET_ACCESSOR( FILTERKEYS, StartupFilterKeys );
GET_SET_ACCESSOR( bool, HandleDefaultHotkeys );
GET_SET_ACCESSOR( bool, ShowMsgBoxOnError );
GET_SET_ACCESSOR( bool, ClipCursorWhenFullScreen );
GET_SET_ACCESSOR( bool, ShowCursorWhenFullScreen );
GET_SET_ACCESSOR( bool, ConstantFrameTime );
GET_SET_ACCESSOR( float, TimePerFrame );
GET_SET_ACCESSOR( bool, WireframeMode );
GET_SET_ACCESSOR( bool, AutoChangeAdapter );
GET_SET_ACCESSOR( bool, WindowCreatedWithDefaultPositions );
GET_SET_ACCESSOR( int, ExitCode );
GET_SET_ACCESSOR( bool, DXUTInited );
GET_SET_ACCESSOR( bool, WindowCreated );
GET_SET_ACCESSOR( bool, DeviceCreated );
GET_SET_ACCESSOR( bool, DXUTInitCalled );
GET_SET_ACCESSOR( bool, WindowCreateCalled );
GET_SET_ACCESSOR( bool, DeviceCreateCalled );
GET_SET_ACCESSOR( bool, InsideDeviceCallback );
GET_SET_ACCESSOR( bool, InsideMainloop );
GET_SET_ACCESSOR( bool, DeviceObjectsCreated );
GET_SET_ACCESSOR( bool, DeviceObjectsReset );
GET_SET_ACCESSOR( bool, Active );
GET_SET_ACCESSOR( bool, RenderingPaused );
GET_SET_ACCESSOR( bool, TimePaused );
GET_SET_ACCESSOR( int, PauseRenderingCount );
GET_SET_ACCESSOR( int, PauseTimeCount );
GET_SET_ACCESSOR( bool, DeviceLost );
GET_SET_ACCESSOR( bool, NotifyOnMouseMove );
GET_SET_ACCESSOR( bool, Automation );
GET_SET_ACCESSOR( bool, InSizeMove );
GET_SET_ACCESSOR( int, OverrideAdapterOrdinal );
GET_SET_ACCESSOR( bool, OverrideWindowed );
GET_SET_ACCESSOR( bool, OverrideFullScreen );
GET_SET_ACCESSOR( int, OverrideStartX );
GET_SET_ACCESSOR( int, OverrideStartY );
GET_SET_ACCESSOR( int, OverrideWidth );
GET_SET_ACCESSOR( int, OverrideHeight );
GET_SET_ACCESSOR( bool, OverrideForceHAL );
GET_SET_ACCESSOR( bool, OverrideForceREF );
GET_SET_ACCESSOR( bool, OverrideForcePureHWVP );
GET_SET_ACCESSOR( bool, OverrideForceHWVP );
GET_SET_ACCESSOR( bool, OverrideForceSWVP );
GET_SET_ACCESSOR( bool, OverrideConstantFrameTime );
GET_SET_ACCESSOR( float, OverrideConstantTimePerFrame );
GET_SET_ACCESSOR( int, OverrideQuitAfterFrame );
GET_SET_ACCESSOR( LPDXUTCALLBACKISDEVICEACCEPTABLE, IsDeviceAcceptableFunc );
GET_SET_ACCESSOR( LPDXUTCALLBACKMODIFYDEVICESETTINGS, ModifyDeviceSettingsFunc );
GET_SET_ACCESSOR( LPDXUTCALLBACKDEVICECREATED, DeviceCreatedFunc );
GET_SET_ACCESSOR( LPDXUTCALLBACKDEVICERESET, DeviceResetFunc );
GET_SET_ACCESSOR( LPDXUTCALLBACKDEVICELOST, DeviceLostFunc );
GET_SET_ACCESSOR( LPDXUTCALLBACKDEVICEDESTROYED, DeviceDestroyedFunc );
GET_SET_ACCESSOR( LPDXUTCALLBACKFRAMEMOVE, FrameMoveFunc );
GET_SET_ACCESSOR( LPDXUTCALLBACKFRAMERENDER, FrameRenderFunc );
GET_SET_ACCESSOR( LPDXUTCALLBACKKEYBOARD, KeyboardFunc );
GET_SET_ACCESSOR( LPDXUTCALLBACKMOUSE, MouseFunc );
GET_SET_ACCESSOR( LPDXUTCALLBACKMSGPROC, WindowMsgFunc );
GET_SET_ACCESSOR( void*, IsDeviceAcceptableFuncUserContext );
GET_SET_ACCESSOR( void*, ModifyDeviceSettingsFuncUserContext );
GET_SET_ACCESSOR( void*, DeviceCreatedFuncUserContext );
GET_SET_ACCESSOR( void*, DeviceResetFuncUserContext );
GET_SET_ACCESSOR( void*, DeviceLostFuncUserContext );
GET_SET_ACCESSOR( void*, DeviceDestroyedFuncUserContext );
GET_SET_ACCESSOR( void*, FrameMoveFuncUserContext );
GET_SET_ACCESSOR( void*, FrameRenderFuncUserContext );
GET_SET_ACCESSOR( void*, KeyboardFuncUserContext );
GET_SET_ACCESSOR( void*, MouseFuncUserContext );
GET_SET_ACCESSOR( void*, WindowMsgFuncUserContext );
GET_SET_ACCESSOR( CGrowableArray<DXUT_TIMER>*, TimerList );
GET_ACCESSOR( bool*, Keys );
GET_ACCESSOR( bool*, MouseButtons );
GET_ACCESSOR( TCHAR*, StaticFrameStats );
GET_ACCESSOR( TCHAR*, FrameStats );
GET_ACCESSOR( TCHAR*, DeviceStats );
GET_ACCESSOR( TCHAR*, WindowTitle );
};
//--------------------------------------------------------------------------------------
// Global state class
//--------------------------------------------------------------------------------------
DXUTState& GetDXUTState()
{
// Using an accessor function gives control of the construction order
static DXUTState state;
return state;
}
//--------------------------------------------------------------------------------------
// Internal functions forward declarations
//--------------------------------------------------------------------------------------
typedef IDirect3D9* (WINAPI* LPDIRECT3DCREATE9)(UINT SDKVersion);
typedef DECLSPEC_IMPORT UINT (WINAPI* LPTIMEBEGINPERIOD)( UINT uPeriod );
int DXUTMapButtonToArrayIndex( BYTE vButton );
void DXUTParseCommandLine();
CD3DEnumeration* DXUTPrepareEnumerationObject( bool bEnumerate = false );
void DXUTBuildOptimalDeviceSettings( DXUTDeviceSettings* pOptimalDeviceSettings, DXUTDeviceSettings* pDeviceSettingsIn, DXUTMatchOptions* pMatchOptions );
bool DXUTDoesDeviceComboMatchPreserveOptions( CD3DEnumDeviceSettingsCombo* pDeviceSettingsCombo, DXUTDeviceSettings* pDeviceSettingsIn, DXUTMatchOptions* pMatchOptions );
float DXUTRankDeviceCombo( CD3DEnumDeviceSettingsCombo* pDeviceSettingsCombo, DXUTDeviceSettings* pDeviceSettingsIn, D3DDISPLAYMODE* pAdapterDesktopDisplayMode );
void DXUTBuildValidDeviceSettings( DXUTDeviceSettings* pDeviceSettings, CD3DEnumDeviceSettingsCombo* pBestDeviceSettingsCombo, DXUTDeviceSettings* pDeviceSettingsIn, DXUTMatchOptions* pMatchOptions );
HRESULT DXUTFindValidResolution( CD3DEnumDeviceSettingsCombo* pBestDeviceSettingsCombo, D3DDISPLAYMODE displayModeIn, D3DDISPLAYMODE* pBestDisplayMode );
HRESULT DXUTFindAdapterFormat( UINT AdapterOrdinal, D3DDEVTYPE DeviceType, D3DFORMAT BackBufferFormat, BOOL Windowed, D3DFORMAT* pAdapterFormat );
HRESULT DXUTChangeDevice( DXUTDeviceSettings* pNewDeviceSettings, IDirect3DDevice9* pd3dDeviceFromApp, bool bForceRecreate, bool bClipWindowToSingleAdapter );
void DXUTUpdateDeviceSettingsWithOverrides( DXUTDeviceSettings* pNewDeviceSettings );
HRESULT DXUTCreate3DEnvironment( IDirect3DDevice9* pd3dDeviceFromApp );
HRESULT DXUTReset3DEnvironment();
void DXUTRender3DEnvironment();
void DXUTCleanup3DEnvironment( bool bReleaseSettings = true );
void DXUTUpdateFrameStats();
void DXUTUpdateDeviceStats( D3DDEVTYPE DeviceType, DWORD BehaviorFlags, D3DADAPTER_IDENTIFIER9* pAdapterIdentifier );
void DXUTUpdateStaticFrameStats();
void DXUTHandleTimers();
bool DXUTGetCmdParam( TCHAR*& strCmdLine, TCHAR* strFlag, int nFlagLen );
void DXUTDisplayErrorMessage( HRESULT hr );
LRESULT CALLBACK DXUTStaticWndProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam );
void DXUTCheckForWindowSizeChange();
void DXUTCheckForWindowChangingMonitors();
UINT DXUTColorChannelBits( D3DFORMAT fmt );
UINT DXUTStencilBits( D3DFORMAT fmt );
UINT DXUTDepthBits( D3DFORMAT fmt );
HRESULT DXUTGetAdapterOrdinalFromMonitor( HMONITOR hMonitor, UINT* pAdapterOrdinal );
void DXUTAllowShortcutKeys( bool bAllowKeys );
void DXUTUpdateBackBufferDesc();
void DXUTInitHWCursor();
HRESULT DXUTSetDeviceCursor( IDirect3DDevice9* pd3dDevice, HCURSOR hCursor, bool bAddWatermark );
void DXUTGetDesktopResolution( UINT AdapterOrdinal, DWORD* pdwWidth, DWORD* pdwHeight );
//--------------------------------------------------------------------------------------
// External callback setup functions
//--------------------------------------------------------------------------------------
void DXUTSetCallbackDeviceCreated( LPDXUTCALLBACKDEVICECREATED pCallbackDeviceCreated, void* pUserContext ) { GetDXUTState().SetDeviceCreatedFunc( pCallbackDeviceCreated ); GetDXUTState().SetDeviceCreatedFuncUserContext( pUserContext ); }
void DXUTSetCallbackDeviceReset( LPDXUTCALLBACKDEVICERESET pCallbackDeviceReset, void* pUserContext ) { GetDXUTState().SetDeviceResetFunc( pCallbackDeviceReset ); GetDXUTState().SetDeviceResetFuncUserContext( pUserContext ); }
void DXUTSetCallbackDeviceLost( LPDXUTCALLBACKDEVICELOST pCallbackDeviceLost, void* pUserContext ) { GetDXUTState().SetDeviceLostFunc( pCallbackDeviceLost ); GetDXUTState().SetDeviceLostFuncUserContext( pUserContext ); }
void DXUTSetCallbackDeviceDestroyed( LPDXUTCALLBACKDEVICEDESTROYED pCallbackDeviceDestroyed, void* pUserContext ) { GetDXUTState().SetDeviceDestroyedFunc( pCallbackDeviceDestroyed ); GetDXUTState().SetDeviceDestroyedFuncUserContext( pUserContext ); }
void DXUTSetCallbackDeviceChanging( LPDXUTCALLBACKMODIFYDEVICESETTINGS pCallbackModifyDeviceSettings, void* pUserContext ) { GetDXUTState().SetModifyDeviceSettingsFunc( pCallbackModifyDeviceSettings ); GetDXUTState().SetModifyDeviceSettingsFuncUserContext( pUserContext ); }
void DXUTSetCallbackFrameMove( LPDXUTCALLBACKFRAMEMOVE pCallbackFrameMove, void* pUserContext ) { GetDXUTState().SetFrameMoveFunc( pCallbackFrameMove ); GetDXUTState().SetFrameMoveFuncUserContext( pUserContext ); }
void DXUTSetCallbackFrameRender( LPDXUTCALLBACKFRAMERENDER pCallbackFrameRender, void* pUserContext ) { GetDXUTState().SetFrameRenderFunc( pCallbackFrameRender ); GetDXUTState().SetFrameRenderFuncUserContext( pUserContext ); }
void DXUTSetCallbackKeyboard( LPDXUTCALLBACKKEYBOARD pCallbackKeyboard, void* pUserContext ) { GetDXUTState().SetKeyboardFunc( pCallbackKeyboard ); GetDXUTState().SetKeyboardFuncUserContext( pUserContext ); }
void DXUTSetCallbackMouse( LPDXUTCALLBACKMOUSE pCallbackMouse, bool bIncludeMouseMove, void* pUserContext ) { GetDXUTState().SetMouseFunc( pCallbackMouse ); GetDXUTState().SetNotifyOnMouseMove( bIncludeMouseMove ); GetDXUTState().SetMouseFuncUserContext( pUserContext ); }
void DXUTSetCallbackMsgProc( LPDXUTCALLBACKMSGPROC pCallbackMsgProc, void* pUserContext ) { GetDXUTState().SetWindowMsgFunc( pCallbackMsgProc ); GetDXUTState().SetWindowMsgFuncUserContext( pUserContext ); }
//--------------------------------------------------------------------------------------
// Optionally parses the command line and sets if default hotkeys are handled
//
// Possible command line parameters are:
// -adapter:# forces app to use this adapter # (fails if the adapter doesn't exist)
// -windowed forces app to start windowed
// -fullscreen forces app to start full screen
// -forcehal forces app to use HAL (fails if HAL doesn't exist)
// -forceref forces app to use REF (fails if REF doesn't exist)
// -forcepurehwvp forces app to use pure HWVP (fails if device doesn't support it)
// -forcehwvp forces app to use HWVP (fails if device doesn't support it)
// -forceswvp forces app to use SWVP
// -width:# forces app to use # for width. for full screen, it will pick the closest possible supported mode
// -height:# forces app to use # for height. for full screen, it will pick the closest possible supported mode
// -startx:# forces app to use # for the x coord of the window position for windowed mode
// -starty:# forces app to use # for the y coord of the window position for windowed mode
// -constantframetime:# forces app to use constant frame time, where # is the time/frame in seconds
// -quitafterframe:x forces app to quit after # frames
// -noerrormsgboxes prevents the display of message boxes generated by the framework so the application can be run without user interaction
// -automation every CDXUTDialog created will have EnableKeyboardInput(true) called, enabling UI navigation with keyboard
// This is useful when automating application testing.
//
// Hotkeys handled by default are:
// ESC app exits
// Alt-Enter toggle between full screen & windowed
// F2 device selection dialog
// F3 toggle HAL/REF
// F8 toggle wire-frame mode
// Pause pauses time
//--------------------------------------------------------------------------------------
// MATCH
HRESULT DXUTInit( bool bParseCommandLine, bool bHandleDefaultHotkeys, bool bShowMsgBoxOnError )
{
GetDXUTState().SetDXUTInitCalled( true );
// Not always needed, but lets the app create GDI dialogs
InitCommonControls();
// Save the current sticky/toggle/filter key settings so DXUT can restore them later
STICKYKEYS sk = {sizeof(STICKYKEYS), 0};
SystemParametersInfo(SPI_GETSTICKYKEYS, sizeof(STICKYKEYS), &sk, 0);
GetDXUTState().SetStartupStickyKeys( sk );
TOGGLEKEYS tk = {sizeof(TOGGLEKEYS), 0};
SystemParametersInfo(SPI_GETTOGGLEKEYS, sizeof(TOGGLEKEYS), &tk, 0);
GetDXUTState().SetStartupToggleKeys( tk );
FILTERKEYS fk = {sizeof(FILTERKEYS), 0};
SystemParametersInfo(SPI_GETFILTERKEYS, sizeof(FILTERKEYS), &fk, 0);
GetDXUTState().SetStartupFilterKeys( fk );
// Increase the accuracy of Sleep() without needing to link to winmm.lib
TCHAR wszPath[MAX_PATH+1];
if( GetSystemDirectory( wszPath, MAX_PATH+1 ) )
{
StringCchCat( wszPath, MAX_PATH, "\\winmm.dll" );
HINSTANCE hInstWinMM = LoadLibrary( wszPath );
if( hInstWinMM )
{
LPTIMEBEGINPERIOD pTimeBeginPeriod = (LPTIMEBEGINPERIOD)GetProcAddress( hInstWinMM, "timeBeginPeriod" );
if( NULL != pTimeBeginPeriod )
pTimeBeginPeriod(1);
FreeLibrary(hInstWinMM);
}
}
GetDXUTState().SetShowMsgBoxOnError( bShowMsgBoxOnError );
GetDXUTState().SetHandleDefaultHotkeys( bHandleDefaultHotkeys );
if( bParseCommandLine )
DXUTParseCommandLine();
// Verify D3DX version
if( !D3DXCheckVersion( D3D_SDK_VERSION, D3DX_SDK_VERSION ) )
{
DXUTDisplayErrorMessage( DXUTERR_INCORRECTVERSION );
return DXUT_ERR( "D3DXCheckVersion", DXUTERR_INCORRECTVERSION );
}
// Create a Direct3D object if one has not already been created
IDirect3D9* pD3D = DXUTGetD3DObject();
if( pD3D == NULL )
{
// This may fail if DirectX 9 isn't installed
// This may fail if the DirectX headers are out of sync with the installed DirectX DLLs
pD3D = DXUT_Dynamic_Direct3DCreate9( D3D_SDK_VERSION );
GetDXUTState().SetD3D( pD3D );
}
if( pD3D == NULL )
{
// If still NULL, then something went wrong
DXUTDisplayErrorMessage( DXUTERR_NODIRECT3D );
return DXUT_ERR( "Direct3DCreate9", DXUTERR_NODIRECT3D );
}
// Reset the timer
DXUTGetGlobalTimer()->Reset();
GetDXUTState().SetDXUTInited( true );
return S_OK;
}
//--------------------------------------------------------------------------------------
// Parses the command line for parameters. See DXUTInit() for list
//--------------------------------------------------------------------------------------
// MATCH
void DXUTParseCommandLine()
{
TCHAR* strCmdLine = GetCommandLine();
// Skip past program name (first token in command line).
if (*strCmdLine == L'"') // Check for and handle quoted program name
{
strCmdLine++;
// Skip over until another double-quote or a null
while (*strCmdLine && (*strCmdLine != L'"'))
strCmdLine++;
// Skip over double-quote
if (*strCmdLine == L'"')
strCmdLine++;
}
else
{
// First token wasn't a quote
while (*strCmdLine > L' ')
strCmdLine++;
}
for(;;)
{
// Skip past any white space preceding the next token
while (*strCmdLine && (*strCmdLine <= L' '))
strCmdLine++;
if( *strCmdLine == 0 )
break;
TCHAR strFlag[256];
int nFlagLen = 0;
// Skip past the flag marker
if( *strCmdLine == L'/' ||
*strCmdLine == L'-' )
strCmdLine++;
// Compare the first N letters w/o regard to case
StringCchCopy( strFlag, 256, "adapter" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
if( DXUTGetCmdParam( strCmdLine, strFlag, nFlagLen ) )
{
int nAdapter = atoi(strFlag);
GetDXUTState().SetOverrideAdapterOrdinal( nAdapter );
}
continue;
}
StringCchCopy( strFlag, 256, "windowed" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
GetDXUTState().SetOverrideWindowed( true );
strCmdLine += nFlagLen;
continue;
}
StringCchCopy( strFlag, 256, "fullscreen" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
GetDXUTState().SetOverrideFullScreen( true );
strCmdLine += nFlagLen;
continue;
}
StringCchCopy( strFlag, 256, "forcehal" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
GetDXUTState().SetOverrideForceHAL( true );
strCmdLine += nFlagLen;
continue;
}
StringCchCopy( strFlag, 256, "forceref" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
GetDXUTState().SetOverrideForceREF( true );
strCmdLine += nFlagLen;
continue;
}
StringCchCopy( strFlag, 256, "forcepurehwvp" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
GetDXUTState().SetOverrideForcePureHWVP( true );
strCmdLine += nFlagLen;
continue;
}
StringCchCopy( strFlag, 256, "forcehwvp" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
GetDXUTState().SetOverrideForceHWVP( true );
strCmdLine += nFlagLen;
continue;
}
StringCchCopy( strFlag, 256, "forceswvp" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
GetDXUTState().SetOverrideForceSWVP( true );
strCmdLine += nFlagLen;
continue;
}
StringCchCopy( strFlag, 256, "width" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
if( DXUTGetCmdParam( strCmdLine, strFlag, nFlagLen ) )
{
int nWidth = atoi(strFlag);
GetDXUTState().SetOverrideWidth( nWidth );
}
continue;
}
StringCchCopy( strFlag, 256, "height" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
if( DXUTGetCmdParam( strCmdLine, strFlag, nFlagLen ) )
{
int nHeight = atoi(strFlag);
GetDXUTState().SetOverrideHeight( nHeight );
}
continue;
}
StringCchCopy( strFlag, 256, "startx" );
nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
if( DXUTGetCmdParam( strCmdLine, strFlag, nFlagLen ) )
{
int nX = atoi(strFlag);
GetDXUTState().SetOverrideStartX( nX );
}
continue;
}
StringCchCopy( strFlag, 256, "starty" );
nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
if( DXUTGetCmdParam( strCmdLine, strFlag, nFlagLen ) )
{
int nY = atoi(strFlag);
GetDXUTState().SetOverrideStartY( nY );
}
continue;
}
StringCchCopy( strFlag, 256, "constantframetime" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
float fTimePerFrame;
if( DXUTGetCmdParam( strCmdLine, strFlag, nFlagLen ) )
fTimePerFrame = (float)strtod( strFlag, NULL );
else
fTimePerFrame = 0.0333f;
GetDXUTState().SetOverrideConstantFrameTime( true );
GetDXUTState().SetOverrideConstantTimePerFrame( fTimePerFrame );
DXUTSetConstantFrameTime( true, fTimePerFrame );
continue;
}
StringCchCopy( strFlag, 256, "quitafterframe" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
if( DXUTGetCmdParam( strCmdLine, strFlag, nFlagLen ) )
{
int nFrame = atoi(strFlag);
GetDXUTState().SetOverrideQuitAfterFrame( nFrame );
}
continue;
}
StringCchCopy( strFlag, 256, "noerrormsgboxes" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
GetDXUTState().SetShowMsgBoxOnError( false );
strCmdLine += nFlagLen;
continue;
}
StringCchCopy( strFlag, 256, "automation" ); nFlagLen = (int) strlen(strFlag);
if( _strnicmp( strCmdLine, strFlag, nFlagLen ) == 0 )
{
GetDXUTState().SetAutomation( true );
strCmdLine += nFlagLen;
continue;
}
// Unrecognized flag
StringCchCopy( strFlag, 256, strCmdLine );
TCHAR* strSpace = strFlag;
while (*strSpace && (*strSpace > L' '))
strSpace++;
*strSpace = 0;
DXUTOutputDebugString( "Unrecognized flag: %s", strFlag );
strCmdLine += strlen(strFlag);
}
}
//--------------------------------------------------------------------------------------
// Helper function for DXUTParseCommandLine. Updates strCmdLine and strFlag
// Example: if strCmdLine=="-width:1024 -forceref"
// then after: strCmdLine==" -forceref" and strFlag=="1024"
//--------------------------------------------------------------------------------------
// MATCH
bool DXUTGetCmdParam( TCHAR*& strCmdLine, TCHAR* strFlag, int nFlagLen )
{
strCmdLine += nFlagLen;
if( *strCmdLine == L':' )
{
strCmdLine++; // Skip ':'
// Place NULL terminator in strFlag after current token
StringCchCopy( strFlag, 256, strCmdLine );
TCHAR* strSpace = strFlag;
while (*strSpace && (*strSpace > L' '))
strSpace++;
*strSpace = 0;
// Update strCmdLine
strCmdLine += strlen(strFlag);
return true;
}
else
{
strFlag[0] = 0;
return false;
}
}
//--------------------------------------------------------------------------------------
// Creates a window with the specified window title, icon, menu, and
// starting position. If DXUTInit() has not already been called, it will
// call it with the default parameters. Instead of calling this, you can
// call DXUTSetWindow() to use an existing window.
//--------------------------------------------------------------------------------------
HRESULT DXUTCreateWindow( const TCHAR* strWindowTitle, HINSTANCE hInstance,
HICON hIcon, HMENU hMenu, int x, int y )
{
HRESULT hr;
// Not allowed to call this from inside the device callbacks
if( GetDXUTState().GetInsideDeviceCallback() )
return DXUT_ERR_MSGBOX( "DXUTCreateWindow", E_FAIL );
GetDXUTState().SetWindowCreateCalled( true );
if( !GetDXUTState().GetDXUTInited() )
{
// If DXUTInit() was already called and failed, then fail.
// DXUTInit() must first succeed for this function to succeed
if( GetDXUTState().GetDXUTInitCalled() )
return E_FAIL;
// If DXUTInit() hasn't been called, then automatically call it
// with default params
hr = DXUTInit();
if( FAILED(hr) )
return hr;
}
if( DXUTGetHWNDFocus() == NULL )
{
if( hInstance == NULL )
hInstance = (HINSTANCE)GetModuleHandle(NULL);
GetDXUTState().SetHInstance( hInstance );
TCHAR szExePath[MAX_PATH];
GetModuleFileName( NULL, szExePath, MAX_PATH );
if( hIcon == NULL ) // If the icon is NULL, then use the first one found in the exe
hIcon = ExtractIcon( hInstance, szExePath, 0 );
// Register the windows class
WNDCLASS wndClass;
wndClass.style = CS_DBLCLKS;
wndClass.lpfnWndProc = DXUTStaticWndProc;
wndClass.cbClsExtra = 0;
wndClass.cbWndExtra = 0;
wndClass.hInstance = hInstance;
wndClass.hIcon = hIcon;
wndClass.hCursor = LoadCursor( NULL, IDC_ARROW );
wndClass.hbrBackground = (HBRUSH)GetStockObject(BLACK_BRUSH);
wndClass.lpszMenuName = NULL;
wndClass.lpszClassName = "Direct3DWindowClass";
if( !RegisterClass( &wndClass ) )
{
DWORD dwError = GetLastError();
if( dwError != ERROR_CLASS_ALREADY_EXISTS )
return DXUT_ERR_MSGBOX( "RegisterClass", HRESULT_FROM_WIN32(dwError) );
}
// Set the window's initial style. It is invisible initially since it might
// be resized later
DWORD dwWindowStyle = WS_OVERLAPPED | WS_CAPTION | WS_SYSMENU | WS_THICKFRAME |
WS_MINIMIZEBOX | WS_MAXIMIZEBOX;
RECT rc;
// Override the window's initial & size position if there were cmd line args
if( GetDXUTState().GetOverrideStartX() != -1 )
x = GetDXUTState().GetOverrideStartX();
if( GetDXUTState().GetOverrideStartY() != -1 )
y = GetDXUTState().GetOverrideStartY();
GetDXUTState().SetWindowCreatedWithDefaultPositions( false );
if( x == CW_USEDEFAULT && y == CW_USEDEFAULT )
GetDXUTState().SetWindowCreatedWithDefaultPositions( true );
// Find the window's initial size, but it might be changed later
int nDefaultWidth = 640;
int nDefaultHeight = 480;
if( GetDXUTState().GetOverrideWidth() != 0 )
nDefaultWidth = GetDXUTState().GetOverrideWidth();
if( GetDXUTState().GetOverrideHeight() != 0 )
nDefaultHeight = GetDXUTState().GetOverrideHeight();
SetRect( &rc, 0, 0, nDefaultWidth, nDefaultHeight );
AdjustWindowRect( &rc, dwWindowStyle, ( hMenu != NULL ) ? true : false );
TCHAR* strCachedWindowTitle = GetDXUTState().GetWindowTitle();
StringCchCopy( strCachedWindowTitle, 256, strWindowTitle );
// Create the render window
HWND hWnd = CreateWindow( "Direct3DWindowClass", strWindowTitle, dwWindowStyle,
x, y, (rc.right-rc.left), (rc.bottom-rc.top), 0,
hMenu, hInstance, 0 );
if( hWnd == NULL )
{
DWORD dwError = GetLastError();
return DXUT_ERR_MSGBOX( "CreateWindow", HRESULT_FROM_WIN32(dwError) );
}
GetDXUTState().SetWindowCreated( true );
GetDXUTState().SetHWNDFocus( hWnd );
GetDXUTState().SetHWNDDeviceFullScreen( hWnd );
GetDXUTState().SetHWNDDeviceWindowed( hWnd );
}
return S_OK;
}
//--------------------------------------------------------------------------------------
// Sets a previously created window for the framework to use. If DXUTInit()
// has not already been called, it will call it with the default parameters.
// Instead of calling this, you can call DXUTCreateWindow() to create a new window.
//--------------------------------------------------------------------------------------
HRESULT DXUTSetWindow( HWND hWndFocus, HWND hWndDeviceFullScreen, HWND hWndDeviceWindowed, bool bHandleMessages )
{
HRESULT hr;
// Not allowed to call this from inside the device callbacks
if( GetDXUTState().GetInsideDeviceCallback() )
return DXUT_ERR_MSGBOX( "DXUTCreateWindow", E_FAIL );
GetDXUTState().SetWindowCreateCalled( true );
// To avoid confusion, we do not allow any HWND to be NULL here. The
// caller must pass in valid HWND for all three parameters. The same
// HWND may be used for more than one parameter.
if( hWndFocus == NULL || hWndDeviceFullScreen == NULL || hWndDeviceWindowed == NULL )
return DXUT_ERR_MSGBOX( "DXUTSetWindow", E_INVALIDARG );
// If subclassing the window, set the pointer to the local window procedure
if( bHandleMessages )
{
// Switch window procedures
#ifdef _WIN64
LONG_PTR nResult = SetWindowLongPtr( hWndFocus, GWLP_WNDPROC, (LONG_PTR)DXUTStaticWndProc );
#else
LONG_PTR nResult = SetWindowLongPtr( hWndFocus, GWLP_WNDPROC, (LONG)(LONG_PTR)DXUTStaticWndProc );
#endif
DWORD dwError = GetLastError();
if( nResult == 0 )
return DXUT_ERR_MSGBOX( "SetWindowLongPtr", HRESULT_FROM_WIN32(dwError) );
}
if( !GetDXUTState().GetDXUTInited() )
{
// If DXUTInit() was already called and failed, then fail.
// DXUTInit() must first succeed for this function to succeed
if( GetDXUTState().GetDXUTInitCalled() )
return E_FAIL;
// If DXUTInit() hasn't been called, then automatically call it
// with default params
hr = DXUTInit();
if( FAILED(hr) )
return hr;
}
TCHAR* strCachedWindowTitle = GetDXUTState().GetWindowTitle();
GetWindowText( hWndFocus, strCachedWindowTitle, 255 );
strCachedWindowTitle[255] = 0;
HINSTANCE hInstance = (HINSTANCE) (LONG_PTR) GetWindowLongPtr( hWndFocus, GWLP_HINSTANCE );
GetDXUTState().SetHInstance( hInstance );
GetDXUTState().SetWindowCreatedWithDefaultPositions( false );
GetDXUTState().SetWindowCreated( true );
GetDXUTState().SetHWNDFocus( hWndFocus );
GetDXUTState().SetHWNDDeviceFullScreen( hWndDeviceFullScreen );
GetDXUTState().SetHWNDDeviceWindowed( hWndDeviceWindowed );
return S_OK;
}
//--------------------------------------------------------------------------------------
// Creates a Direct3D device. If DXUTCreateWindow() or DXUTSetWindow() has not already
// been called, it will call DXUTCreateWindow() with the default parameters.
// Instead of calling this, you can call DXUTSetDevice() or DXUTCreateDeviceFromSettings()
//--------------------------------------------------------------------------------------
HRESULT DXUTCreateDevice( UINT AdapterOrdinal, bool bWindowed,
int nSuggestedWidth, int nSuggestedHeight,
LPDXUTCALLBACKISDEVICEACCEPTABLE pCallbackIsDeviceAcceptable,
LPDXUTCALLBACKMODIFYDEVICESETTINGS pCallbackModifyDeviceSettings,
void* pUserContext )
{
HRESULT hr;
// Not allowed to call this from inside the device callbacks
if( GetDXUTState().GetInsideDeviceCallback() )
return DXUT_ERR_MSGBOX( "DXUTCreateWindow", E_FAIL );
// Record the function arguments in the global state
GetDXUTState().SetIsDeviceAcceptableFunc( pCallbackIsDeviceAcceptable );
GetDXUTState().SetModifyDeviceSettingsFunc( pCallbackModifyDeviceSettings );
GetDXUTState().SetIsDeviceAcceptableFuncUserContext( pUserContext );
GetDXUTState().SetModifyDeviceSettingsFuncUserContext( pUserContext );
GetDXUTState().SetDeviceCreateCalled( true );
// If DXUTCreateWindow() or DXUTSetWindow() has not already been called,
// then call DXUTCreateWindow() with the default parameters.
if( !GetDXUTState().GetWindowCreated() )
{
// If DXUTCreateWindow() or DXUTSetWindow() was already called and failed, then fail.
// DXUTCreateWindow() or DXUTSetWindow() must first succeed for this function to succeed
if( GetDXUTState().GetWindowCreateCalled() )
return E_FAIL;
// If DXUTCreateWindow() or DXUTSetWindow() hasn't been called, then
// automatically call DXUTCreateWindow() with default params
hr = DXUTCreateWindow();
if( FAILED(hr) )
return hr;
}
// Force an enumeration with the new IsDeviceAcceptable callback
DXUTPrepareEnumerationObject( true );
DXUTMatchOptions matchOptions;
matchOptions.eAdapterOrdinal = DXUTMT_PRESERVE_INPUT;
matchOptions.eDeviceType = DXUTMT_IGNORE_INPUT;
matchOptions.eWindowed = DXUTMT_PRESERVE_INPUT;
matchOptions.eAdapterFormat = DXUTMT_IGNORE_INPUT;
matchOptions.eVertexProcessing = DXUTMT_IGNORE_INPUT;
matchOptions.eResolution = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eBackBufferFormat = DXUTMT_IGNORE_INPUT;
matchOptions.eBackBufferCount = DXUTMT_IGNORE_INPUT;
matchOptions.eMultiSample = DXUTMT_IGNORE_INPUT;
matchOptions.eSwapEffect = DXUTMT_IGNORE_INPUT;
matchOptions.eDepthFormat = DXUTMT_IGNORE_INPUT;
matchOptions.eStencilFormat = DXUTMT_IGNORE_INPUT;
matchOptions.ePresentFlags = DXUTMT_IGNORE_INPUT;
matchOptions.eRefreshRate = DXUTMT_IGNORE_INPUT;
matchOptions.ePresentInterval = DXUTMT_IGNORE_INPUT;
DXUTDeviceSettings deviceSettings;
ZeroMemory( &deviceSettings, sizeof(DXUTDeviceSettings) );
deviceSettings.AdapterOrdinal = AdapterOrdinal;
deviceSettings.pp.Windowed = bWindowed;
deviceSettings.pp.BackBufferWidth = nSuggestedWidth;
deviceSettings.pp.BackBufferHeight = nSuggestedHeight;
// Override with settings from the command line
if( GetDXUTState().GetOverrideWidth() != 0 )
deviceSettings.pp.BackBufferWidth = GetDXUTState().GetOverrideWidth();
if( GetDXUTState().GetOverrideHeight() != 0 )
deviceSettings.pp.BackBufferHeight = GetDXUTState().GetOverrideHeight();
if( GetDXUTState().GetOverrideAdapterOrdinal() != -1 )
deviceSettings.AdapterOrdinal = GetDXUTState().GetOverrideAdapterOrdinal();
if( GetDXUTState().GetOverrideFullScreen() )
{
deviceSettings.pp.Windowed = FALSE;
if( GetDXUTState().GetOverrideWidth() == 0 && GetDXUTState().GetOverrideHeight() == 0 )
matchOptions.eResolution = DXUTMT_IGNORE_INPUT;
}
if( GetDXUTState().GetOverrideWindowed() )
deviceSettings.pp.Windowed = TRUE;
if( GetDXUTState().GetOverrideForceHAL() )
{
deviceSettings.DeviceType = D3DDEVTYPE_HAL;
matchOptions.eDeviceType = DXUTMT_PRESERVE_INPUT;
}
if( GetDXUTState().GetOverrideForceREF() )
{
deviceSettings.DeviceType = D3DDEVTYPE_REF;
matchOptions.eDeviceType = DXUTMT_PRESERVE_INPUT;
}
if( GetDXUTState().GetOverrideForcePureHWVP() )
{
deviceSettings.BehaviorFlags = D3DCREATE_HARDWARE_VERTEXPROCESSING | D3DCREATE_PUREDEVICE;
matchOptions.eVertexProcessing = DXUTMT_PRESERVE_INPUT;
}
else if( GetDXUTState().GetOverrideForceHWVP() )
{
deviceSettings.BehaviorFlags = D3DCREATE_HARDWARE_VERTEXPROCESSING;
matchOptions.eVertexProcessing = DXUTMT_PRESERVE_INPUT;
}
else if( GetDXUTState().GetOverrideForceSWVP() )
{
deviceSettings.BehaviorFlags = D3DCREATE_SOFTWARE_VERTEXPROCESSING;
matchOptions.eVertexProcessing = DXUTMT_PRESERVE_INPUT;
}
hr = DXUTFindValidDeviceSettings( &deviceSettings, &deviceSettings, &matchOptions );
if( FAILED(hr) ) // the call will fail if no valid devices were found
{
DXUTDisplayErrorMessage( hr );
return DXUT_ERR( "DXUTFindValidDeviceSettings", hr );
}
// Change to a Direct3D device created from the new device settings.
// If there is an existing device, then either reset or recreated the scene
hr = DXUTChangeDevice( &deviceSettings, NULL, false, true );
if( FAILED(hr) )
return hr;
return S_OK;
}
//--------------------------------------------------------------------------------------
// Passes a previously created Direct3D device for use by the framework.
// If DXUTCreateWindow() has not already been called, it will call it with the
// default parameters. Instead of calling this, you can call DXUTCreateDevice() or
// DXUTCreateDeviceFromSettings()
//--------------------------------------------------------------------------------------
HRESULT DXUTSetDevice( IDirect3DDevice9* pd3dDevice )
{
HRESULT hr;
if( pd3dDevice == NULL )
return DXUT_ERR_MSGBOX( "DXUTSetDevice", E_INVALIDARG );
// Not allowed to call this from inside the device callbacks
if( GetDXUTState().GetInsideDeviceCallback() )
return DXUT_ERR_MSGBOX( "DXUTCreateWindow", E_FAIL );
GetDXUTState().SetDeviceCreateCalled( true );
// If DXUTCreateWindow() or DXUTSetWindow() has not already been called,
// then call DXUTCreateWindow() with the default parameters.
if( !GetDXUTState().GetWindowCreated() )
{
// If DXUTCreateWindow() or DXUTSetWindow() was already called and failed, then fail.
// DXUTCreateWindow() or DXUTSetWindow() must first succeed for this function to succeed
if( GetDXUTState().GetWindowCreateCalled() )
return E_FAIL;
// If DXUTCreateWindow() or DXUTSetWindow() hasn't been called, then
// automatically call DXUTCreateWindow() with default params
hr = DXUTCreateWindow();
if( FAILED(hr) )
return hr;
}
DXUTDeviceSettings* pDeviceSettings = new DXUTDeviceSettings;
if( pDeviceSettings == NULL )
return E_OUTOFMEMORY;
ZeroMemory( pDeviceSettings, sizeof(DXUTDeviceSettings) );
// Get the present params from the swap chain
IDirect3DSurface9* pBackBuffer = NULL;
hr = pd3dDevice->GetBackBuffer( 0, 0, D3DBACKBUFFER_TYPE_MONO, &pBackBuffer );
if( SUCCEEDED(hr) )
{
IDirect3DSwapChain9* pSwapChain = NULL;
hr = pBackBuffer->GetContainer( IID_IDirect3DSwapChain9, (void**) &pSwapChain );
if( SUCCEEDED(hr) )
{
pSwapChain->GetPresentParameters( &pDeviceSettings->pp );
SAFE_RELEASE( pSwapChain );
}
SAFE_RELEASE( pBackBuffer );
}
D3DDEVICE_CREATION_PARAMETERS d3dCreationParams;
pd3dDevice->GetCreationParameters( &d3dCreationParams );
// Fill out the rest of the device settings struct
pDeviceSettings->AdapterOrdinal = d3dCreationParams.AdapterOrdinal;
pDeviceSettings->DeviceType = d3dCreationParams.DeviceType;
DXUTFindAdapterFormat( pDeviceSettings->AdapterOrdinal, pDeviceSettings->DeviceType,
pDeviceSettings->pp.BackBufferFormat, pDeviceSettings->pp.Windowed,
&pDeviceSettings->AdapterFormat );
pDeviceSettings->BehaviorFlags = d3dCreationParams.BehaviorFlags;
// Change to the Direct3D device passed in
hr = DXUTChangeDevice( pDeviceSettings, pd3dDevice, false, false );
if( FAILED(hr) )
return hr;
return S_OK;
}
//--------------------------------------------------------------------------------------
// Tells the framework to change to a device created from the passed in device settings
// If DXUTCreateWindow() has not already been called, it will call it with the
// default parameters. Instead of calling this, you can call DXUTCreateDevice()
// or DXUTSetDevice()
//--------------------------------------------------------------------------------------
HRESULT DXUTCreateDeviceFromSettings( DXUTDeviceSettings* pDeviceSettings, bool bPreserveInput, bool bClipWindowToSingleAdapter )
{
HRESULT hr;
GetDXUTState().SetDeviceCreateCalled( true );
// If DXUTCreateWindow() or DXUTSetWindow() has not already been called,
// then call DXUTCreateWindow() with the default parameters.
if( !GetDXUTState().GetWindowCreated() )
{
// If DXUTCreateWindow() or DXUTSetWindow() was already called and failed, then fail.
// DXUTCreateWindow() or DXUTSetWindow() must first succeed for this function to succeed
if( GetDXUTState().GetWindowCreateCalled() )
return E_FAIL;
// If DXUTCreateWindow() or DXUTSetWindow() hasn't been called, then
// automatically call DXUTCreateWindow() with default params
hr = DXUTCreateWindow();
if( FAILED(hr) )
return hr;
}
if( !bPreserveInput )
{
// If not preserving the input, then find the closest valid to it
DXUTMatchOptions matchOptions;
matchOptions.eAdapterOrdinal = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eDeviceType = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eWindowed = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eAdapterFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eVertexProcessing = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eResolution = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eBackBufferFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eBackBufferCount = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eMultiSample = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eSwapEffect = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eDepthFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eStencilFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.ePresentFlags = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eRefreshRate = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.ePresentInterval = DXUTMT_CLOSEST_TO_INPUT;
hr = DXUTFindValidDeviceSettings( pDeviceSettings, pDeviceSettings, &matchOptions );
if( FAILED(hr) ) // the call will fail if no valid devices were found
{
DXUTDisplayErrorMessage( hr );
return DXUT_ERR( "DXUTFindValidDeviceSettings", hr );
}
}
// Change to a Direct3D device created from the new device settings.
// If there is an existing device, then either reset or recreate the scene
hr = DXUTChangeDevice( pDeviceSettings, NULL, false, bClipWindowToSingleAdapter );
if( FAILED(hr) )
return hr;
return S_OK;
}
//--------------------------------------------------------------------------------------
// Toggle between full screen and windowed
//--------------------------------------------------------------------------------------
HRESULT DXUTToggleFullScreen()
{
HRESULT hr;
// Get the current device settings and flip the windowed state then
// find the closest valid device settings with this change
DXUTDeviceSettings deviceSettings = DXUTGetDeviceSettings();
deviceSettings.pp.Windowed = !deviceSettings.pp.Windowed;
DXUTMatchOptions matchOptions;
matchOptions.eAdapterOrdinal = DXUTMT_PRESERVE_INPUT;
matchOptions.eDeviceType = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eWindowed = DXUTMT_PRESERVE_INPUT;
matchOptions.eAdapterFormat = DXUTMT_IGNORE_INPUT;
matchOptions.eVertexProcessing = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eBackBufferFormat = DXUTMT_IGNORE_INPUT;
matchOptions.eBackBufferCount = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eMultiSample = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eSwapEffect = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eDepthFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eStencilFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.ePresentFlags = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eRefreshRate = DXUTMT_IGNORE_INPUT;
matchOptions.ePresentInterval = DXUTMT_IGNORE_INPUT;
// Go back to previous state
UINT nWidth = ( deviceSettings.pp.Windowed ) ? GetDXUTState().GetWindowBackBufferWidthAtModeChange() : GetDXUTState().GetFullScreenBackBufferWidthAtModeChange();
UINT nHeight = ( deviceSettings.pp.Windowed ) ? GetDXUTState().GetWindowBackBufferHeightAtModeChange() : GetDXUTState().GetFullScreenBackBufferHeightAtModeChange();
if( nWidth > 0 && nHeight > 0 )
{
matchOptions.eResolution = DXUTMT_CLOSEST_TO_INPUT;
deviceSettings.pp.BackBufferWidth = nWidth;
deviceSettings.pp.BackBufferHeight = nHeight;
}
else
{
// No previous data, so just switch to defaults
matchOptions.eResolution = DXUTMT_IGNORE_INPUT;
}
hr = DXUTFindValidDeviceSettings( &deviceSettings, &deviceSettings, &matchOptions );
if( SUCCEEDED(hr) )
{
// Create a Direct3D device using the new device settings.
// If there is an existing device, then it will either reset or recreate the scene.
hr = DXUTChangeDevice( &deviceSettings, NULL, false, false );
// If hr == E_ABORT, this means the app rejected the device settings in the ModifySettingsCallback so nothing changed
if( FAILED(hr) && (hr != E_ABORT) )
{
// Failed creating device, try to switch back.
deviceSettings.pp.Windowed = !deviceSettings.pp.Windowed;
UINT nWidth = ( deviceSettings.pp.Windowed ) ? GetDXUTState().GetWindowBackBufferWidthAtModeChange() : GetDXUTState().GetFullScreenBackBufferWidthAtModeChange();
UINT nHeight = ( deviceSettings.pp.Windowed ) ? GetDXUTState().GetWindowBackBufferHeightAtModeChange() : GetDXUTState().GetFullScreenBackBufferHeightAtModeChange();
if( nWidth > 0 && nHeight > 0 )
{
matchOptions.eResolution = DXUTMT_CLOSEST_TO_INPUT;
deviceSettings.pp.BackBufferWidth = nWidth;
deviceSettings.pp.BackBufferHeight = nHeight;
}
else
{
matchOptions.eResolution = DXUTMT_IGNORE_INPUT;
}
DXUTFindValidDeviceSettings( &deviceSettings, &deviceSettings, &matchOptions );
HRESULT hr2 = DXUTChangeDevice( &deviceSettings, NULL, false, false );
if( FAILED(hr2) )
{
// If this failed, then shutdown
DXUTShutdown();
}
}
}
return hr;
}
//--------------------------------------------------------------------------------------
// Toggle between HAL and REF
//--------------------------------------------------------------------------------------
HRESULT DXUTToggleREF()
{
HRESULT hr;
DXUTDeviceSettings deviceSettings = DXUTGetDeviceSettings();
if( deviceSettings.DeviceType == D3DDEVTYPE_HAL )
deviceSettings.DeviceType = D3DDEVTYPE_REF;
else if( deviceSettings.DeviceType == D3DDEVTYPE_REF )
deviceSettings.DeviceType = D3DDEVTYPE_HAL;
DXUTMatchOptions matchOptions;
matchOptions.eAdapterOrdinal = DXUTMT_PRESERVE_INPUT;
matchOptions.eDeviceType = DXUTMT_PRESERVE_INPUT;
matchOptions.eWindowed = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eAdapterFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eVertexProcessing = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eResolution = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eBackBufferFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eBackBufferCount = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eMultiSample = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eSwapEffect = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eDepthFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eStencilFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.ePresentFlags = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eRefreshRate = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.ePresentInterval = DXUTMT_CLOSEST_TO_INPUT;
hr = DXUTFindValidDeviceSettings( &deviceSettings, &deviceSettings, &matchOptions );
if( SUCCEEDED(hr) )
{
// Create a Direct3D device using the new device settings.
// If there is an existing device, then it will either reset or recreate the scene.
hr = DXUTChangeDevice( &deviceSettings, NULL, false, false );
// If hr == E_ABORT, this means the app rejected the device settings in the ModifySettingsCallback so nothing changed
if( FAILED( hr ) && (hr != E_ABORT) )
{
// Failed creating device, try to switch back.
if( deviceSettings.DeviceType == D3DDEVTYPE_HAL )
deviceSettings.DeviceType = D3DDEVTYPE_REF;
else if( deviceSettings.DeviceType == D3DDEVTYPE_REF )
deviceSettings.DeviceType = D3DDEVTYPE_HAL;
DXUTFindValidDeviceSettings( &deviceSettings, &deviceSettings, &matchOptions );
HRESULT hr2 = DXUTChangeDevice( &deviceSettings, NULL, false, false );
if( FAILED(hr2) )
{
// If this failed, then shutdown
DXUTShutdown();
}
}
}
return hr;
}
//--------------------------------------------------------------------------------------
// Internal helper function to prepare the enumeration object by creating it if it
// didn't already exist and enumerating if desired.
//--------------------------------------------------------------------------------------
CD3DEnumeration* DXUTPrepareEnumerationObject( bool bEnumerate )
{
// Create a new CD3DEnumeration object and enumerate all devices unless its already been done
CD3DEnumeration* pd3dEnum = GetDXUTState().GetD3DEnumeration();
if( pd3dEnum == NULL )
{
pd3dEnum = DXUTGetEnumeration();
GetDXUTState().SetD3DEnumeration( pd3dEnum );
bEnumerate = true;
}
if( bEnumerate )
{
// Enumerate for each adapter all of the supported display modes,
// device types, adapter formats, back buffer formats, window/full screen support,
// depth stencil formats, multisampling types/qualities, and presentations intervals.
//
// For each combination of device type (HAL/REF), adapter format, back buffer format, and
// IsWindowed it will call the app's ConfirmDevice callback. This allows the app
// to reject or allow that combination based on its caps/etc. It also allows the
// app to change the BehaviorFlags. The BehaviorFlags defaults non-pure HWVP
// if supported otherwise it will default to SWVP, however the app can change this
// through the ConfirmDevice callback.
IDirect3D9* pD3D = DXUTGetD3DObject();
pd3dEnum->Enumerate( pD3D, GetDXUTState().GetIsDeviceAcceptableFunc(), GetDXUTState().GetIsDeviceAcceptableFuncUserContext() );
}
return pd3dEnum;
}
//--------------------------------------------------------------------------------------
// This function tries to find valid device settings based upon the input device settings
// struct and the match options. For each device setting a match option in the
// DXUTMatchOptions struct specifies how the function makes decisions. For example, if
// the caller wants a HAL device with a back buffer format of D3DFMT_A2B10G10R10 but the
// HAL device on the system does not support D3DFMT_A2B10G10R10 however a REF device is
// installed that does, then the function has a choice to either use REF or to change to
// a back buffer format to compatible with the HAL device. The match options lets the
// caller control how these choices are made.
//
// Each match option must be one of the following types:
// DXUTMT_IGNORE_INPUT: Uses the closest valid value to a default
// DXUTMT_PRESERVE_INPUT: Uses the input without change, but may cause no valid device to be found
// DXUTMT_CLOSEST_TO_INPUT: Uses the closest valid value to the input
//
// If pMatchOptions is NULL then, all of the match options are assumed to be DXUTMT_IGNORE_INPUT.
// The function returns failure if no valid device settings can be found otherwise
// the function returns success and the valid device settings are written to pOut.
//--------------------------------------------------------------------------------------
HRESULT DXUTFindValidDeviceSettings( DXUTDeviceSettings* pOut, DXUTDeviceSettings* pIn,
DXUTMatchOptions* pMatchOptions )
{
if( pOut == NULL )
return DXUT_ERR_MSGBOX( "DXUTFindValidDeviceSettings", E_INVALIDARG );
CD3DEnumeration* pd3dEnum = DXUTPrepareEnumerationObject( false );
IDirect3D9* pD3D = DXUTGetD3DObject();
// Default to DXUTMT_IGNORE_INPUT for everything unless pMatchOptions isn't NULL
DXUTMatchOptions defaultMatchOptions;
if( NULL == pMatchOptions )
{
ZeroMemory( &defaultMatchOptions, sizeof(DXUTMatchOptions) );
pMatchOptions = &defaultMatchOptions;
}
// Build an optimal device settings structure based upon the match
// options. If the match option is set to ignore, then a optimal default value is used.
// The default value may not exist on the system, but later this will be taken
// into account.
DXUTDeviceSettings optimalDeviceSettings;
DXUTBuildOptimalDeviceSettings( &optimalDeviceSettings, pIn, pMatchOptions );
// Find the best combination of:
// Adapter Ordinal
// Device Type
// Adapter Format
// Back Buffer Format
// Windowed
// given what's available on the system and the match options combined with the device settings input.
// This combination of settings is encapsulated by the CD3DEnumDeviceSettingsCombo class.
float fBestRanking = -1.0f;
CD3DEnumDeviceSettingsCombo* pBestDeviceSettingsCombo = NULL;
D3DDISPLAYMODE adapterDesktopDisplayMode;
CGrowableArray<CD3DEnumAdapterInfo*>* pAdapterList = pd3dEnum->GetAdapterInfoList();
for( int iAdapter=0; iAdapter<pAdapterList->GetSize(); iAdapter++ )
{
CD3DEnumAdapterInfo* pAdapterInfo = pAdapterList->GetAt(iAdapter);
// Get the desktop display mode of adapter
pD3D->GetAdapterDisplayMode( pAdapterInfo->AdapterOrdinal, &adapterDesktopDisplayMode );
// Enum all the device types supported by this adapter to find the best device settings
for( int iDeviceInfo=0; iDeviceInfo<pAdapterInfo->deviceInfoList.GetSize(); iDeviceInfo++ )
{
CD3DEnumDeviceInfo* pDeviceInfo = pAdapterInfo->deviceInfoList.GetAt(iDeviceInfo);
// Enum all the device settings combinations. A device settings combination is
// a unique set of an adapter format, back buffer format, and IsWindowed.
for( int iDeviceCombo=0; iDeviceCombo<pDeviceInfo->deviceSettingsComboList.GetSize(); iDeviceCombo++ )
{
CD3DEnumDeviceSettingsCombo* pDeviceSettingsCombo = pDeviceInfo->deviceSettingsComboList.GetAt(iDeviceCombo);
// If windowed mode the adapter format has to be the same as the desktop
// display mode format so skip any that don't match
if (pDeviceSettingsCombo->Windowed && (pDeviceSettingsCombo->AdapterFormat != adapterDesktopDisplayMode.Format))
continue;
// Skip any combo that doesn't meet the preserve match options
if( false == DXUTDoesDeviceComboMatchPreserveOptions( pDeviceSettingsCombo, pIn, pMatchOptions ) )
continue;
// Get a ranking number that describes how closely this device combo matches the optimal combo
float fCurRanking = DXUTRankDeviceCombo( pDeviceSettingsCombo, &optimalDeviceSettings, &adapterDesktopDisplayMode );
// If this combo better matches the input device settings then save it
if( fCurRanking > fBestRanking )
{
pBestDeviceSettingsCombo = pDeviceSettingsCombo;
fBestRanking = fCurRanking;
}
}
}
}
// If no best device combination was found then fail
if( pBestDeviceSettingsCombo == NULL )
return DXUTERR_NOCOMPATIBLEDEVICES;
// Using the best device settings combo found, build valid device settings taking heed of
// the match options and the input device settings
DXUTDeviceSettings validDeviceSettings;
DXUTBuildValidDeviceSettings( &validDeviceSettings, pBestDeviceSettingsCombo, pIn, pMatchOptions );
*pOut = validDeviceSettings;
return S_OK;
}
//--------------------------------------------------------------------------------------
// Internal helper function to build a device settings structure based upon the match
// options. If the match option is set to ignore, then a optimal default value is used.
// The default value may not exist on the system, but later this will be taken
// into account.
//--------------------------------------------------------------------------------------
void DXUTBuildOptimalDeviceSettings( DXUTDeviceSettings* pOptimalDeviceSettings,
DXUTDeviceSettings* pDeviceSettingsIn,
DXUTMatchOptions* pMatchOptions )
{
IDirect3D9* pD3D = DXUTGetD3DObject();
D3DDISPLAYMODE adapterDesktopDisplayMode;
ZeroMemory( pOptimalDeviceSettings, sizeof(DXUTDeviceSettings) );
//---------------------
// Adapter ordinal
//---------------------
if( pMatchOptions->eAdapterOrdinal == DXUTMT_IGNORE_INPUT )
pOptimalDeviceSettings->AdapterOrdinal = D3DADAPTER_DEFAULT;
else
pOptimalDeviceSettings->AdapterOrdinal = pDeviceSettingsIn->AdapterOrdinal;
//---------------------
// Device type
//---------------------
if( pMatchOptions->eDeviceType == DXUTMT_IGNORE_INPUT )
pOptimalDeviceSettings->DeviceType = D3DDEVTYPE_HAL;
else
pOptimalDeviceSettings->DeviceType = pDeviceSettingsIn->DeviceType;
//---------------------
// Windowed
//---------------------
if( pMatchOptions->eWindowed == DXUTMT_IGNORE_INPUT )
pOptimalDeviceSettings->pp.Windowed = TRUE;
else
pOptimalDeviceSettings->pp.Windowed = pDeviceSettingsIn->pp.Windowed;
//---------------------
// Adapter format
//---------------------
if( pMatchOptions->eAdapterFormat == DXUTMT_IGNORE_INPUT )
{
// If windowed, default to the desktop display mode
// If fullscreen, default to the desktop display mode for quick mode change or
// default to D3DFMT_X8R8G8B8 if the desktop display mode is < 32bit
pD3D->GetAdapterDisplayMode( pOptimalDeviceSettings->AdapterOrdinal, &adapterDesktopDisplayMode );
if( pOptimalDeviceSettings->pp.Windowed || DXUTColorChannelBits(adapterDesktopDisplayMode.Format) >= 8 )
pOptimalDeviceSettings->AdapterFormat = adapterDesktopDisplayMode.Format;
else
pOptimalDeviceSettings->AdapterFormat = D3DFMT_X8R8G8B8;
}
else
{
pOptimalDeviceSettings->AdapterFormat = pDeviceSettingsIn->AdapterFormat;
}
//---------------------
// Vertex processing
//---------------------
if( pMatchOptions->eVertexProcessing == DXUTMT_IGNORE_INPUT )
pOptimalDeviceSettings->BehaviorFlags = D3DCREATE_HARDWARE_VERTEXPROCESSING;
else
pOptimalDeviceSettings->BehaviorFlags = pDeviceSettingsIn->BehaviorFlags;
//---------------------
// Resolution
//---------------------
if( pMatchOptions->eResolution == DXUTMT_IGNORE_INPUT )
{
// If windowed, default to 640x480
// If fullscreen, default to the desktop res for quick mode change
if( pOptimalDeviceSettings->pp.Windowed )
{
pOptimalDeviceSettings->pp.BackBufferWidth = 640;
pOptimalDeviceSettings->pp.BackBufferHeight = 480;
}
else
{
pD3D->GetAdapterDisplayMode( pOptimalDeviceSettings->AdapterOrdinal, &adapterDesktopDisplayMode );
pOptimalDeviceSettings->pp.BackBufferWidth = adapterDesktopDisplayMode.Width;
pOptimalDeviceSettings->pp.BackBufferHeight = adapterDesktopDisplayMode.Height;
}
}
else
{
pOptimalDeviceSettings->pp.BackBufferWidth = pDeviceSettingsIn->pp.BackBufferWidth;
pOptimalDeviceSettings->pp.BackBufferHeight = pDeviceSettingsIn->pp.BackBufferHeight;
}
//---------------------
// Back buffer format
//---------------------
if( pMatchOptions->eBackBufferFormat == DXUTMT_IGNORE_INPUT )
pOptimalDeviceSettings->pp.BackBufferFormat = pOptimalDeviceSettings->AdapterFormat; // Default to match the adapter format
else
pOptimalDeviceSettings->pp.BackBufferFormat = pDeviceSettingsIn->pp.BackBufferFormat;
//---------------------
// Back buffer count
//---------------------
if( pMatchOptions->eBackBufferCount == DXUTMT_IGNORE_INPUT )
pOptimalDeviceSettings->pp.BackBufferCount = 2; // Default to triple buffering for perf gain
else
pOptimalDeviceSettings->pp.BackBufferCount = pDeviceSettingsIn->pp.BackBufferCount;
//---------------------
// Multisample
//---------------------
if( pMatchOptions->eMultiSample == DXUTMT_IGNORE_INPUT )
{
// Default to no multisampling
pOptimalDeviceSettings->pp.MultiSampleType = D3DMULTISAMPLE_NONE;
pOptimalDeviceSettings->pp.MultiSampleQuality = 0;
}
else
{
pOptimalDeviceSettings->pp.MultiSampleType = pDeviceSettingsIn->pp.MultiSampleType;
pOptimalDeviceSettings->pp.MultiSampleQuality = pDeviceSettingsIn->pp.MultiSampleQuality;
}
//---------------------
// Swap effect
//---------------------
if( pMatchOptions->eSwapEffect == DXUTMT_IGNORE_INPUT )
pOptimalDeviceSettings->pp.SwapEffect = D3DSWAPEFFECT_DISCARD;
else
pOptimalDeviceSettings->pp.SwapEffect = pDeviceSettingsIn->pp.SwapEffect;
//---------------------
// Depth stencil
//---------------------
if( pMatchOptions->eDepthFormat == DXUTMT_IGNORE_INPUT &&
pMatchOptions->eStencilFormat == DXUTMT_IGNORE_INPUT )
{
UINT nBackBufferBits = DXUTColorChannelBits( pOptimalDeviceSettings->pp.BackBufferFormat );
if( nBackBufferBits >= 8 )
pOptimalDeviceSettings->pp.AutoDepthStencilFormat = D3DFMT_D32;
else
pOptimalDeviceSettings->pp.AutoDepthStencilFormat = D3DFMT_D16;
}
else
{
pOptimalDeviceSettings->pp.AutoDepthStencilFormat = pDeviceSettingsIn->pp.AutoDepthStencilFormat;
}
//---------------------
// Present flags
//---------------------
if( pMatchOptions->ePresentFlags == DXUTMT_IGNORE_INPUT )
pOptimalDeviceSettings->pp.Flags = D3DPRESENTFLAG_DISCARD_DEPTHSTENCIL;
else
pOptimalDeviceSettings->pp.Flags = pDeviceSettingsIn->pp.Flags;
//---------------------
// Refresh rate
//---------------------
if( pMatchOptions->eRefreshRate == DXUTMT_IGNORE_INPUT )
pOptimalDeviceSettings->pp.FullScreen_RefreshRateInHz = 0;
else
pOptimalDeviceSettings->pp.FullScreen_RefreshRateInHz = pDeviceSettingsIn->pp.FullScreen_RefreshRateInHz;
//---------------------
// Present interval
//---------------------
if( pMatchOptions->ePresentInterval == DXUTMT_IGNORE_INPUT )
{
// For windowed, default to D3DPRESENT_INTERVAL_IMMEDIATE
// which will wait not for the vertical retrace period to prevent tearing,
// but may introduce tearing.
// For full screen, default to D3DPRESENT_INTERVAL_DEFAULT
// which will wait for the vertical retrace period to prevent tearing.
if( pOptimalDeviceSettings->pp.Windowed )
pOptimalDeviceSettings->pp.PresentationInterval = D3DPRESENT_INTERVAL_IMMEDIATE;
else
pOptimalDeviceSettings->pp.PresentationInterval = D3DPRESENT_INTERVAL_DEFAULT;
}
else
{
pOptimalDeviceSettings->pp.PresentationInterval = pDeviceSettingsIn->pp.PresentationInterval;
}
}
//--------------------------------------------------------------------------------------
// Returns false for any CD3DEnumDeviceSettingsCombo that doesn't meet the preserve
// match options against the input pDeviceSettingsIn.
//--------------------------------------------------------------------------------------
bool DXUTDoesDeviceComboMatchPreserveOptions( CD3DEnumDeviceSettingsCombo* pDeviceSettingsCombo,
DXUTDeviceSettings* pDeviceSettingsIn,
DXUTMatchOptions* pMatchOptions )
{
//---------------------
// Adapter ordinal
//---------------------
if( pMatchOptions->eAdapterOrdinal == DXUTMT_PRESERVE_INPUT &&
(pDeviceSettingsCombo->AdapterOrdinal != pDeviceSettingsIn->AdapterOrdinal) )
return false;
//---------------------
// Device type
//---------------------
if( pMatchOptions->eDeviceType == DXUTMT_PRESERVE_INPUT &&
(pDeviceSettingsCombo->DeviceType != pDeviceSettingsIn->DeviceType) )
return false;
//---------------------
// Windowed
//---------------------
if( pMatchOptions->eWindowed == DXUTMT_PRESERVE_INPUT &&
(pDeviceSettingsCombo->Windowed != pDeviceSettingsIn->pp.Windowed) )
return false;
//---------------------
// Adapter format
//---------------------
if( pMatchOptions->eAdapterFormat == DXUTMT_PRESERVE_INPUT &&
(pDeviceSettingsCombo->AdapterFormat != pDeviceSettingsIn->AdapterFormat) )
return false;
//---------------------
// Vertex processing
//---------------------
// If keep VP and input has HWVP, then skip if this combo doesn't have HWTL
if( pMatchOptions->eVertexProcessing == DXUTMT_PRESERVE_INPUT &&
((pDeviceSettingsIn->BehaviorFlags & D3DCREATE_HARDWARE_VERTEXPROCESSING) != 0) &&
((pDeviceSettingsCombo->pDeviceInfo->Caps.DevCaps & D3DDEVCAPS_HWTRANSFORMANDLIGHT) == 0) )
return false;
//---------------------
// Resolution
//---------------------
// If keep resolution then check that width and height supported by this combo
if( pMatchOptions->eResolution == DXUTMT_PRESERVE_INPUT )
{
bool bFound = false;
for( int i=0; i< pDeviceSettingsCombo->pAdapterInfo->displayModeList.GetSize(); i++ )
{
D3DDISPLAYMODE displayMode = pDeviceSettingsCombo->pAdapterInfo->displayModeList.GetAt( i );
if( displayMode.Format != pDeviceSettingsCombo->AdapterFormat )
continue; // Skip this display mode if it doesn't match the combo's adapter format
if( displayMode.Width == pDeviceSettingsIn->pp.BackBufferWidth &&
displayMode.Height == pDeviceSettingsIn->pp.BackBufferHeight )
{
bFound = true;
break;
}
}
// If the width and height are not supported by this combo, return false
if( !bFound )
return false;
}
//---------------------
// Back buffer format
//---------------------
if( pMatchOptions->eBackBufferFormat == DXUTMT_PRESERVE_INPUT &&
pDeviceSettingsCombo->BackBufferFormat != pDeviceSettingsIn->pp.BackBufferFormat )
return false;
//---------------------
// Back buffer count
//---------------------
// No caps for the back buffer count
//---------------------
// Multisample
//---------------------
if( pMatchOptions->eMultiSample == DXUTMT_PRESERVE_INPUT )
{
bool bFound = false;
for( int i=0; i<pDeviceSettingsCombo->multiSampleTypeList.GetSize(); i++ )
{
D3DMULTISAMPLE_TYPE msType = pDeviceSettingsCombo->multiSampleTypeList.GetAt(i);
DWORD msQuality = pDeviceSettingsCombo->multiSampleQualityList.GetAt(i);
if( msType == pDeviceSettingsIn->pp.MultiSampleType &&
msQuality >= pDeviceSettingsIn->pp.MultiSampleQuality )
{
bFound = true;
break;
}
}
// If multisample type/quality not supported by this combo, then return false
if( !bFound )
return false;
}
//---------------------
// Swap effect
//---------------------
// No caps for swap effects
//---------------------
// Depth stencil
//---------------------
// If keep depth stencil format then check that the depth stencil format is supported by this combo
if( pMatchOptions->eDepthFormat == DXUTMT_PRESERVE_INPUT &&
pMatchOptions->eStencilFormat == DXUTMT_PRESERVE_INPUT )
{
if( pDeviceSettingsIn->pp.AutoDepthStencilFormat != D3DFMT_UNKNOWN &&
!pDeviceSettingsCombo->depthStencilFormatList.Contains( pDeviceSettingsIn->pp.AutoDepthStencilFormat ) )
return false;
}
// If keep depth format then check that the depth format is supported by this combo
if( pMatchOptions->eDepthFormat == DXUTMT_PRESERVE_INPUT &&
pDeviceSettingsIn->pp.AutoDepthStencilFormat != D3DFMT_UNKNOWN )
{
bool bFound = false;
UINT dwDepthBits = DXUTDepthBits( pDeviceSettingsIn->pp.AutoDepthStencilFormat );
for( int i=0; i<pDeviceSettingsCombo->depthStencilFormatList.GetSize(); i++ )
{
D3DFORMAT depthStencilFmt = pDeviceSettingsCombo->depthStencilFormatList.GetAt(i);
UINT dwCurDepthBits = DXUTDepthBits( depthStencilFmt );
if( dwCurDepthBits - dwDepthBits == 0)
bFound = true;
}
if( !bFound )
return false;
}
// If keep depth format then check that the depth format is supported by this combo
if( pMatchOptions->eStencilFormat == DXUTMT_PRESERVE_INPUT &&
pDeviceSettingsIn->pp.AutoDepthStencilFormat != D3DFMT_UNKNOWN )
{
bool bFound = false;
UINT dwStencilBits = DXUTStencilBits( pDeviceSettingsIn->pp.AutoDepthStencilFormat );
for( int i=0; i<pDeviceSettingsCombo->depthStencilFormatList.GetSize(); i++ )
{
D3DFORMAT depthStencilFmt = pDeviceSettingsCombo->depthStencilFormatList.GetAt(i);
UINT dwCurStencilBits = DXUTStencilBits( depthStencilFmt );
if( dwCurStencilBits - dwStencilBits == 0)
bFound = true;
}
if( !bFound )
return false;
}
//---------------------
// Present flags
//---------------------
// No caps for the present flags
//---------------------
// Refresh rate
//---------------------
// If keep refresh rate then check that the resolution is supported by this combo
if( pMatchOptions->eRefreshRate == DXUTMT_PRESERVE_INPUT )
{
bool bFound = false;
for( int i=0; i<pDeviceSettingsCombo->pAdapterInfo->displayModeList.GetSize(); i++ )
{
D3DDISPLAYMODE displayMode = pDeviceSettingsCombo->pAdapterInfo->displayModeList.GetAt( i );
if( displayMode.Format != pDeviceSettingsCombo->AdapterFormat )
continue;
if( displayMode.RefreshRate == pDeviceSettingsIn->pp.FullScreen_RefreshRateInHz )
{
bFound = true;
break;
}
}
// If refresh rate not supported by this combo, then return false
if( !bFound )
return false;
}
//---------------------
// Present interval
//---------------------
// If keep present interval then check that the present interval is supported by this combo
if( pMatchOptions->ePresentInterval == DXUTMT_PRESERVE_INPUT &&
!pDeviceSettingsCombo->presentIntervalList.Contains( pDeviceSettingsIn->pp.PresentationInterval ) )
return false;
return true;
}
//--------------------------------------------------------------------------------------
// Returns a ranking number that describes how closely this device
// combo matches the optimal combo based on the match options and the optimal device settings
//--------------------------------------------------------------------------------------
float DXUTRankDeviceCombo( CD3DEnumDeviceSettingsCombo* pDeviceSettingsCombo,
DXUTDeviceSettings* pOptimalDeviceSettings,
D3DDISPLAYMODE* pAdapterDesktopDisplayMode )
{
float fCurRanking = 0.0f;
// Arbitrary weights. Gives preference to the ordinal, device type, and windowed
const float fAdapterOrdinalWeight = 1000.0f;
const float fDeviceTypeWeight = 100.0f;
const float fWindowWeight = 10.0f;
const float fAdapterFormatWeight = 1.0f;
const float fVertexProcessingWeight = 1.0f;
const float fResolutionWeight = 1.0f;
const float fBackBufferFormatWeight = 1.0f;
const float fMultiSampleWeight = 1.0f;
const float fDepthStencilWeight = 1.0f;
const float fRefreshRateWeight = 1.0f;
const float fPresentIntervalWeight = 1.0f;
//---------------------
// Adapter ordinal
//---------------------
if( pDeviceSettingsCombo->AdapterOrdinal == pOptimalDeviceSettings->AdapterOrdinal )
fCurRanking += fAdapterOrdinalWeight;
//---------------------
// Device type
//---------------------
if( pDeviceSettingsCombo->DeviceType == pOptimalDeviceSettings->DeviceType )
fCurRanking += fDeviceTypeWeight;
// Slightly prefer HAL
if( pDeviceSettingsCombo->DeviceType == D3DDEVTYPE_HAL )
fCurRanking += 0.1f;
//---------------------
// Windowed
//---------------------
if( pDeviceSettingsCombo->Windowed == pOptimalDeviceSettings->pp.Windowed )
fCurRanking += fWindowWeight;
//---------------------
// Adapter format
//---------------------
if( pDeviceSettingsCombo->AdapterFormat == pOptimalDeviceSettings->AdapterFormat )
{
fCurRanking += fAdapterFormatWeight;
}
else
{
int nBitDepthDelta = abs( (long) DXUTColorChannelBits(pDeviceSettingsCombo->AdapterFormat) -
(long) DXUTColorChannelBits(pOptimalDeviceSettings->AdapterFormat) );
float fScale = __max(0.9f - (float)nBitDepthDelta*0.2f, 0.0f);
fCurRanking += fScale * fAdapterFormatWeight;
}
if( !pDeviceSettingsCombo->Windowed )
{
// Slightly prefer when it matches the desktop format or is D3DFMT_X8R8G8B8
bool bAdapterOptimalMatch;
if( DXUTColorChannelBits(pAdapterDesktopDisplayMode->Format) >= 8 )
bAdapterOptimalMatch = (pDeviceSettingsCombo->AdapterFormat == pAdapterDesktopDisplayMode->Format);
else
bAdapterOptimalMatch = (pDeviceSettingsCombo->AdapterFormat == D3DFMT_X8R8G8B8);
if( bAdapterOptimalMatch )
fCurRanking += 0.1f;
}
//---------------------
// Vertex processing
//---------------------
if( (pOptimalDeviceSettings->BehaviorFlags & D3DCREATE_HARDWARE_VERTEXPROCESSING) != 0 ||
(pOptimalDeviceSettings->BehaviorFlags & D3DCREATE_MIXED_VERTEXPROCESSING) != 0 )
{
if( (pDeviceSettingsCombo->pDeviceInfo->Caps.DevCaps & D3DDEVCAPS_HWTRANSFORMANDLIGHT) != 0 )
fCurRanking += fVertexProcessingWeight;
}
// Slightly prefer HW T&L
if( (pDeviceSettingsCombo->pDeviceInfo->Caps.DevCaps & D3DDEVCAPS_HWTRANSFORMANDLIGHT) != 0 )
fCurRanking += 0.1f;
//---------------------
// Resolution
//---------------------
bool bResolutionFound = false;
for( int idm = 0; idm < pDeviceSettingsCombo->pAdapterInfo->displayModeList.GetSize(); idm++ )
{
D3DDISPLAYMODE displayMode = pDeviceSettingsCombo->pAdapterInfo->displayModeList.GetAt( idm );
if( displayMode.Format != pDeviceSettingsCombo->AdapterFormat )
continue;
if( displayMode.Width == pOptimalDeviceSettings->pp.BackBufferWidth &&
displayMode.Height == pOptimalDeviceSettings->pp.BackBufferHeight )
bResolutionFound = true;
}
if( bResolutionFound )
fCurRanking += fResolutionWeight;
//---------------------
// Back buffer format
//---------------------
if( pDeviceSettingsCombo->BackBufferFormat == pOptimalDeviceSettings->pp.BackBufferFormat )
{
fCurRanking += fBackBufferFormatWeight;
}
else
{
int nBitDepthDelta = abs( (long) DXUTColorChannelBits(pDeviceSettingsCombo->BackBufferFormat) -
(long) DXUTColorChannelBits(pOptimalDeviceSettings->pp.BackBufferFormat) );
float fScale = __max(0.9f - (float)nBitDepthDelta*0.2f, 0.0f);
fCurRanking += fScale * fBackBufferFormatWeight;
}
// Check if this back buffer format is the same as
// the adapter format since this is preferred.
bool bAdapterMatchesBB = (pDeviceSettingsCombo->BackBufferFormat == pDeviceSettingsCombo->AdapterFormat);
if( bAdapterMatchesBB )
fCurRanking += 0.1f;
//---------------------
// Back buffer count
//---------------------
// No caps for the back buffer count
//---------------------
// Multisample
//---------------------
bool bMultiSampleFound = false;
for( int i=0; i<pDeviceSettingsCombo->multiSampleTypeList.GetSize(); i++ )
{
D3DMULTISAMPLE_TYPE msType = pDeviceSettingsCombo->multiSampleTypeList.GetAt(i);
DWORD msQuality = pDeviceSettingsCombo->multiSampleQualityList.GetAt(i);
if( msType == pOptimalDeviceSettings->pp.MultiSampleType &&
msQuality >= pOptimalDeviceSettings->pp.MultiSampleQuality )
{
bMultiSampleFound = true;
break;
}
}
if( bMultiSampleFound )
fCurRanking += fMultiSampleWeight;
//---------------------
// Swap effect
//---------------------
// No caps for swap effects
//---------------------
// Depth stencil
//---------------------
if( pDeviceSettingsCombo->depthStencilFormatList.Contains( pOptimalDeviceSettings->pp.AutoDepthStencilFormat ) )
fCurRanking += fDepthStencilWeight;
//---------------------
// Present flags
//---------------------
// No caps for the present flags
//---------------------
// Refresh rate
//---------------------
bool bRefreshFound = false;
for( int idm = 0; idm < pDeviceSettingsCombo->pAdapterInfo->displayModeList.GetSize(); idm++ )
{
D3DDISPLAYMODE displayMode = pDeviceSettingsCombo->pAdapterInfo->displayModeList.GetAt( idm );
if( displayMode.Format != pDeviceSettingsCombo->AdapterFormat )
continue;
if( displayMode.RefreshRate == pOptimalDeviceSettings->pp.FullScreen_RefreshRateInHz )
bRefreshFound = true;
}
if( bRefreshFound )
fCurRanking += fRefreshRateWeight;
//---------------------
// Present interval
//---------------------
// If keep present interval then check that the present interval is supported by this combo
if( pDeviceSettingsCombo->presentIntervalList.Contains( pOptimalDeviceSettings->pp.PresentationInterval ) )
fCurRanking += fPresentIntervalWeight;
return fCurRanking;
}
//--------------------------------------------------------------------------------------
// Builds valid device settings using the match options, the input device settings, and the
// best device settings combo found.
//--------------------------------------------------------------------------------------
void DXUTBuildValidDeviceSettings( DXUTDeviceSettings* pValidDeviceSettings,
CD3DEnumDeviceSettingsCombo* pBestDeviceSettingsCombo,
DXUTDeviceSettings* pDeviceSettingsIn,
DXUTMatchOptions* pMatchOptions )
{
IDirect3D9* pD3D = DXUTGetD3DObject();
D3DDISPLAYMODE adapterDesktopDisplayMode;
pD3D->GetAdapterDisplayMode( pBestDeviceSettingsCombo->AdapterOrdinal, &adapterDesktopDisplayMode );
// For each setting pick the best, taking into account the match options and
// what's supported by the device
//---------------------
// Adapter Ordinal
//---------------------
// Just using pBestDeviceSettingsCombo->AdapterOrdinal
//---------------------
// Device Type
//---------------------
// Just using pBestDeviceSettingsCombo->DeviceType
//---------------------
// Windowed
//---------------------
// Just using pBestDeviceSettingsCombo->Windowed
//---------------------
// Adapter Format
//---------------------
// Just using pBestDeviceSettingsCombo->AdapterFormat
//---------------------
// Vertex processing
//---------------------
DWORD dwBestBehaviorFlags = 0;
if( pMatchOptions->eVertexProcessing == DXUTMT_PRESERVE_INPUT )
{
dwBestBehaviorFlags = pDeviceSettingsIn->BehaviorFlags;
}
else if( pMatchOptions->eVertexProcessing == DXUTMT_IGNORE_INPUT )
{
// The framework defaults to HWVP if available otherwise use SWVP
if ((pBestDeviceSettingsCombo->pDeviceInfo->Caps.DevCaps & D3DDEVCAPS_HWTRANSFORMANDLIGHT) != 0)
dwBestBehaviorFlags |= D3DCREATE_HARDWARE_VERTEXPROCESSING;
else
dwBestBehaviorFlags |= D3DCREATE_SOFTWARE_VERTEXPROCESSING;
}
else // if( pMatchOptions->eVertexProcessing == DXUTMT_CLOSEST_TO_INPUT )
{
// Default to input, and fallback to SWVP if HWVP not available
dwBestBehaviorFlags = pDeviceSettingsIn->BehaviorFlags;
if ((pBestDeviceSettingsCombo->pDeviceInfo->Caps.DevCaps & D3DDEVCAPS_HWTRANSFORMANDLIGHT) == 0 &&
( (dwBestBehaviorFlags & D3DCREATE_HARDWARE_VERTEXPROCESSING) != 0 ||
(dwBestBehaviorFlags & D3DCREATE_MIXED_VERTEXPROCESSING) != 0) )
{
dwBestBehaviorFlags &= ~D3DCREATE_HARDWARE_VERTEXPROCESSING;
dwBestBehaviorFlags &= ~D3DCREATE_MIXED_VERTEXPROCESSING;
dwBestBehaviorFlags |= D3DCREATE_SOFTWARE_VERTEXPROCESSING;
}
// One of these must be selected
if( (dwBestBehaviorFlags & D3DCREATE_HARDWARE_VERTEXPROCESSING) == 0 &&
(dwBestBehaviorFlags & D3DCREATE_MIXED_VERTEXPROCESSING) == 0 &&
(dwBestBehaviorFlags & D3DCREATE_SOFTWARE_VERTEXPROCESSING) == 0 )
{
if ((pBestDeviceSettingsCombo->pDeviceInfo->Caps.DevCaps & D3DDEVCAPS_HWTRANSFORMANDLIGHT) != 0)
dwBestBehaviorFlags |= D3DCREATE_HARDWARE_VERTEXPROCESSING;
else
dwBestBehaviorFlags |= D3DCREATE_SOFTWARE_VERTEXPROCESSING;
}
}
//---------------------
// Resolution
//---------------------
D3DDISPLAYMODE bestDisplayMode;
if( pMatchOptions->eResolution == DXUTMT_PRESERVE_INPUT )
{
bestDisplayMode.Width = pDeviceSettingsIn->pp.BackBufferWidth;
bestDisplayMode.Height = pDeviceSettingsIn->pp.BackBufferHeight;
}
else
{
D3DDISPLAYMODE displayModeIn;
if( pMatchOptions->eResolution == DXUTMT_CLOSEST_TO_INPUT &&
pDeviceSettingsIn )
{
displayModeIn.Width = pDeviceSettingsIn->pp.BackBufferWidth;
displayModeIn.Height = pDeviceSettingsIn->pp.BackBufferHeight;
}
else // if( pMatchOptions->eResolution == DXUTMT_IGNORE_INPUT )
{
if( pBestDeviceSettingsCombo->Windowed )
{
// The framework defaults to 640x480 for windowed
displayModeIn.Width = 640;
displayModeIn.Height = 480;
}
else
{
// The framework defaults to desktop resolution for fullscreen to try to avoid slow mode change
displayModeIn.Width = adapterDesktopDisplayMode.Width;
displayModeIn.Height = adapterDesktopDisplayMode.Height;
}
}
// Call a helper function to find the closest valid display mode to the optimal
DXUTFindValidResolution( pBestDeviceSettingsCombo, displayModeIn, &bestDisplayMode );
}
//---------------------
// Back Buffer Format
//---------------------
// Just using pBestDeviceSettingsCombo->BackBufferFormat
//---------------------
// Back buffer count
//---------------------
UINT bestBackBufferCount;
if( pMatchOptions->eBackBufferCount == DXUTMT_PRESERVE_INPUT )
{
bestBackBufferCount = pDeviceSettingsIn->pp.BackBufferCount;
}
else if( pMatchOptions->eBackBufferCount == DXUTMT_IGNORE_INPUT )
{
// The framework defaults to triple buffering
bestBackBufferCount = 2;
}
else // if( pMatchOptions->eBackBufferCount == DXUTMT_CLOSEST_TO_INPUT )
{
bestBackBufferCount = pDeviceSettingsIn->pp.BackBufferCount;
if( bestBackBufferCount > 3 )
bestBackBufferCount = 3;
if( bestBackBufferCount < 1 )
bestBackBufferCount = 1;
}
//---------------------
// Multisample
//---------------------
D3DMULTISAMPLE_TYPE bestMultiSampleType;
DWORD bestMultiSampleQuality;
if( pDeviceSettingsIn && pDeviceSettingsIn->pp.SwapEffect != D3DSWAPEFFECT_DISCARD )
{
// Swap effect is not set to discard so multisampling has to off
bestMultiSampleType = D3DMULTISAMPLE_NONE;
bestMultiSampleQuality = 0;
}
else
{
if( pMatchOptions->eBackBufferCount == DXUTMT_PRESERVE_INPUT )
{
bestMultiSampleType = pDeviceSettingsIn->pp.MultiSampleType;
bestMultiSampleQuality = pDeviceSettingsIn->pp.MultiSampleQuality;
}
else if( pMatchOptions->eBackBufferCount == DXUTMT_IGNORE_INPUT )
{
// Default to no multisampling (always supported)
bestMultiSampleType = D3DMULTISAMPLE_NONE;
bestMultiSampleQuality = 0;
}
else if( pMatchOptions->eBackBufferCount == DXUTMT_CLOSEST_TO_INPUT )
{
// Default to no multisampling (always supported)
bestMultiSampleType = D3DMULTISAMPLE_NONE;
bestMultiSampleQuality = 0;
for( int i=0; i < pBestDeviceSettingsCombo->multiSampleTypeList.GetSize(); i++ )
{
D3DMULTISAMPLE_TYPE type = pBestDeviceSettingsCombo->multiSampleTypeList.GetAt(i);
DWORD qualityLevels = pBestDeviceSettingsCombo->multiSampleQualityList.GetAt(i);
// Check whether supported type is closer to the input than our current best
if( abs(type - pDeviceSettingsIn->pp.MultiSampleType) < abs(bestMultiSampleType - pDeviceSettingsIn->pp.MultiSampleType) )
{
bestMultiSampleType = type;
bestMultiSampleQuality = __min( qualityLevels-1, pDeviceSettingsIn->pp.MultiSampleQuality );
}
}
}
else
{
// Error case
bestMultiSampleType = D3DMULTISAMPLE_NONE;
bestMultiSampleQuality = 0;
}
}
//---------------------
// Swap effect
//---------------------
D3DSWAPEFFECT bestSwapEffect;
if( pMatchOptions->eSwapEffect == DXUTMT_PRESERVE_INPUT )
{
bestSwapEffect = pDeviceSettingsIn->pp.SwapEffect;
}
else if( pMatchOptions->eSwapEffect == DXUTMT_IGNORE_INPUT )
{
bestSwapEffect = D3DSWAPEFFECT_DISCARD;
}
else // if( pMatchOptions->eSwapEffect == DXUTMT_CLOSEST_TO_INPUT )
{
bestSwapEffect = pDeviceSettingsIn->pp.SwapEffect;
// Swap effect has to be one of these 3
if( bestSwapEffect != D3DSWAPEFFECT_DISCARD &&
bestSwapEffect != D3DSWAPEFFECT_FLIP &&
bestSwapEffect != D3DSWAPEFFECT_COPY )
{
bestSwapEffect = D3DSWAPEFFECT_DISCARD;
}
}
//---------------------
// Depth stencil
//---------------------
D3DFORMAT bestDepthStencilFormat;
BOOL bestEnableAutoDepthStencil;
CGrowableArray< int > depthStencilRanking;
depthStencilRanking.SetSize( pBestDeviceSettingsCombo->depthStencilFormatList.GetSize() );
UINT dwBackBufferBitDepth = DXUTColorChannelBits( pBestDeviceSettingsCombo->BackBufferFormat );
UINT dwInputDepthBitDepth = 0;
if( pDeviceSettingsIn )
dwInputDepthBitDepth = DXUTDepthBits( pDeviceSettingsIn->pp.AutoDepthStencilFormat );
for( int i=0; i<pBestDeviceSettingsCombo->depthStencilFormatList.GetSize(); i++ )
{
D3DFORMAT curDepthStencilFmt = pBestDeviceSettingsCombo->depthStencilFormatList.GetAt(i);
DWORD dwCurDepthBitDepth = DXUTDepthBits( curDepthStencilFmt );
int nRanking;
if( pMatchOptions->eDepthFormat == DXUTMT_PRESERVE_INPUT )
{
// Need to match bit depth of input
if(dwCurDepthBitDepth == dwInputDepthBitDepth)
nRanking = 0;
else
nRanking = 10000;
}
else if( pMatchOptions->eDepthFormat == DXUTMT_IGNORE_INPUT )
{
// Prefer match of backbuffer bit depth
nRanking = abs((int)dwCurDepthBitDepth - (int)dwBackBufferBitDepth*4);
}
else // if( pMatchOptions->eDepthFormat == DXUTMT_CLOSEST_TO_INPUT )
{
// Prefer match of input depth format bit depth
nRanking = abs((int)dwCurDepthBitDepth - (int)dwInputDepthBitDepth);
}
depthStencilRanking.Add( nRanking );
}
UINT dwInputStencilBitDepth = 0;
if( pDeviceSettingsIn )
dwInputStencilBitDepth = DXUTStencilBits( pDeviceSettingsIn->pp.AutoDepthStencilFormat );
for( int i=0; i<pBestDeviceSettingsCombo->depthStencilFormatList.GetSize(); i++ )
{
D3DFORMAT curDepthStencilFmt = pBestDeviceSettingsCombo->depthStencilFormatList.GetAt(i);
int nRanking = depthStencilRanking.GetAt(i);
DWORD dwCurStencilBitDepth = DXUTStencilBits( curDepthStencilFmt );
if( pMatchOptions->eStencilFormat == DXUTMT_PRESERVE_INPUT )
{
// Need to match bit depth of input
if(dwCurStencilBitDepth == dwInputStencilBitDepth)
nRanking += 0;
else
nRanking += 10000;
}
else if( pMatchOptions->eStencilFormat == DXUTMT_IGNORE_INPUT )
{
// Prefer 0 stencil bit depth
nRanking += dwCurStencilBitDepth;
}
else // if( pMatchOptions->eStencilFormat == DXUTMT_CLOSEST_TO_INPUT )
{
// Prefer match of input stencil format bit depth
nRanking += abs((int)dwCurStencilBitDepth - (int)dwInputStencilBitDepth);
}
depthStencilRanking.SetAt( i, nRanking );
}
int nBestRanking = 100000;
int nBestIndex = -1;
for( int i=0; i<pBestDeviceSettingsCombo->depthStencilFormatList.GetSize(); i++ )
{
int nRanking = depthStencilRanking.GetAt(i);
if( nRanking < nBestRanking )
{
nBestRanking = nRanking;
nBestIndex = i;
}
}
if( nBestIndex >= 0 )
{
bestDepthStencilFormat = pBestDeviceSettingsCombo->depthStencilFormatList.GetAt(nBestIndex);
bestEnableAutoDepthStencil = true;
}
else
{
bestDepthStencilFormat = D3DFMT_UNKNOWN;
bestEnableAutoDepthStencil = false;
}
//---------------------
// Present flags
//---------------------
DWORD dwBestFlags;
if( pMatchOptions->ePresentFlags == DXUTMT_PRESERVE_INPUT )
{
dwBestFlags = pDeviceSettingsIn->pp.Flags;
}
else if( pMatchOptions->ePresentFlags == DXUTMT_IGNORE_INPUT )
{
dwBestFlags = 0;
if( bestEnableAutoDepthStencil )
dwBestFlags = D3DPRESENTFLAG_DISCARD_DEPTHSTENCIL;
}
else // if( pMatchOptions->ePresentFlags == DXUTMT_CLOSEST_TO_INPUT )
{
dwBestFlags = pDeviceSettingsIn->pp.Flags;
if( bestEnableAutoDepthStencil )
dwBestFlags |= D3DPRESENTFLAG_DISCARD_DEPTHSTENCIL;
}
//---------------------
// Refresh rate
//---------------------
if( pBestDeviceSettingsCombo->Windowed )
{
// Must be 0 for windowed
bestDisplayMode.RefreshRate = 0;
}
else
{
if( pMatchOptions->eRefreshRate == DXUTMT_PRESERVE_INPUT )
{
bestDisplayMode.RefreshRate = pDeviceSettingsIn->pp.FullScreen_RefreshRateInHz;
}
else
{
UINT refreshRateMatch;
if( pMatchOptions->eRefreshRate == DXUTMT_CLOSEST_TO_INPUT )
{
refreshRateMatch = pDeviceSettingsIn->pp.FullScreen_RefreshRateInHz;
}
else // if( pMatchOptions->eRefreshRate == DXUTMT_IGNORE_INPUT )
{
refreshRateMatch = adapterDesktopDisplayMode.RefreshRate;
}
bestDisplayMode.RefreshRate = 0;
if( refreshRateMatch != 0 )
{
int nBestRefreshRanking = 100000;
CGrowableArray<D3DDISPLAYMODE>* pDisplayModeList = &pBestDeviceSettingsCombo->pAdapterInfo->displayModeList;
for( int iDisplayMode=0; iDisplayMode<pDisplayModeList->GetSize(); iDisplayMode++ )
{
D3DDISPLAYMODE displayMode = pDisplayModeList->GetAt(iDisplayMode);
if( displayMode.Format != pBestDeviceSettingsCombo->AdapterFormat ||
displayMode.Height != bestDisplayMode.Height ||
displayMode.Width != bestDisplayMode.Width )
continue; // Skip display modes that don't match
// Find the delta between the current refresh rate and the optimal refresh rate
int nCurRanking = abs((int)displayMode.RefreshRate - (int)refreshRateMatch);
if( nCurRanking < nBestRefreshRanking )
{
bestDisplayMode.RefreshRate = displayMode.RefreshRate;
nBestRefreshRanking = nCurRanking;
// Stop if perfect match found
if( nBestRefreshRanking == 0 )
break;
}
}
}
}
}
//---------------------
// Present interval
//---------------------
UINT bestPresentInterval;
if( pMatchOptions->ePresentInterval == DXUTMT_PRESERVE_INPUT )
{
bestPresentInterval = pDeviceSettingsIn->pp.PresentationInterval;
}
else if( pMatchOptions->ePresentInterval == DXUTMT_IGNORE_INPUT )
{
if( pBestDeviceSettingsCombo->Windowed )
{
// For windowed, the framework defaults to D3DPRESENT_INTERVAL_IMMEDIATE
// which will wait not for the vertical retrace period to prevent tearing,
// but may introduce tearing
bestPresentInterval = D3DPRESENT_INTERVAL_IMMEDIATE;
}
else
{
// For full screen, the framework defaults to D3DPRESENT_INTERVAL_DEFAULT
// which will wait for the vertical retrace period to prevent tearing
bestPresentInterval = D3DPRESENT_INTERVAL_DEFAULT;
}
}
else // if( pMatchOptions->ePresentInterval == DXUTMT_CLOSEST_TO_INPUT )
{
if( pBestDeviceSettingsCombo->presentIntervalList.Contains( pDeviceSettingsIn->pp.PresentationInterval ) )
{
bestPresentInterval = pDeviceSettingsIn->pp.PresentationInterval;
}
else
{
if( pBestDeviceSettingsCombo->Windowed )
bestPresentInterval = D3DPRESENT_INTERVAL_IMMEDIATE;
else
bestPresentInterval = D3DPRESENT_INTERVAL_DEFAULT;
}
}
// Fill the device settings struct
ZeroMemory( pValidDeviceSettings, sizeof(DXUTDeviceSettings) );
pValidDeviceSettings->AdapterOrdinal = pBestDeviceSettingsCombo->AdapterOrdinal;
pValidDeviceSettings->DeviceType = pBestDeviceSettingsCombo->DeviceType;
pValidDeviceSettings->AdapterFormat = pBestDeviceSettingsCombo->AdapterFormat;
pValidDeviceSettings->BehaviorFlags = dwBestBehaviorFlags;
pValidDeviceSettings->pp.BackBufferWidth = bestDisplayMode.Width;
pValidDeviceSettings->pp.BackBufferHeight = bestDisplayMode.Height;
pValidDeviceSettings->pp.BackBufferFormat = pBestDeviceSettingsCombo->BackBufferFormat;
pValidDeviceSettings->pp.BackBufferCount = bestBackBufferCount;
pValidDeviceSettings->pp.MultiSampleType = bestMultiSampleType;
pValidDeviceSettings->pp.MultiSampleQuality = bestMultiSampleQuality;
pValidDeviceSettings->pp.SwapEffect = bestSwapEffect;
pValidDeviceSettings->pp.hDeviceWindow = pBestDeviceSettingsCombo->Windowed ? DXUTGetHWNDDeviceWindowed() : DXUTGetHWNDDeviceFullScreen();
pValidDeviceSettings->pp.Windowed = pBestDeviceSettingsCombo->Windowed;
pValidDeviceSettings->pp.EnableAutoDepthStencil = bestEnableAutoDepthStencil;
pValidDeviceSettings->pp.AutoDepthStencilFormat = bestDepthStencilFormat;
pValidDeviceSettings->pp.Flags = dwBestFlags;
pValidDeviceSettings->pp.FullScreen_RefreshRateInHz = bestDisplayMode.RefreshRate;
pValidDeviceSettings->pp.PresentationInterval = bestPresentInterval;
}
//--------------------------------------------------------------------------------------
// Internal helper function to find the closest allowed display mode to the optimal
//--------------------------------------------------------------------------------------
HRESULT DXUTFindValidResolution( CD3DEnumDeviceSettingsCombo* pBestDeviceSettingsCombo,
D3DDISPLAYMODE displayModeIn, D3DDISPLAYMODE* pBestDisplayMode )
{
D3DDISPLAYMODE bestDisplayMode;
ZeroMemory( &bestDisplayMode, sizeof(D3DDISPLAYMODE) );
if( pBestDeviceSettingsCombo->Windowed )
{
// In windowed mode, all resolutions are valid but restritions still apply
// on the size of the window. See DXUTChangeDevice() for details
*pBestDisplayMode = displayModeIn;
}
else
{
int nBestRanking = 100000;
int nCurRanking;
CGrowableArray<D3DDISPLAYMODE>* pDisplayModeList = &pBestDeviceSettingsCombo->pAdapterInfo->displayModeList;
for( int iDisplayMode=0; iDisplayMode<pDisplayModeList->GetSize(); iDisplayMode++ )
{
D3DDISPLAYMODE displayMode = pDisplayModeList->GetAt(iDisplayMode);
// Skip display modes that don't match the combo's adapter format
if( displayMode.Format != pBestDeviceSettingsCombo->AdapterFormat )
continue;
// Find the delta between the current width/height and the optimal width/height
nCurRanking = abs((int)displayMode.Width - (int)displayModeIn.Width) +
abs((int)displayMode.Height- (int)displayModeIn.Height);
if( nCurRanking < nBestRanking )
{
bestDisplayMode = displayMode;
nBestRanking = nCurRanking;
// Stop if perfect match found
if( nBestRanking == 0 )
break;
}
}
if( bestDisplayMode.Width == 0 )
{
*pBestDisplayMode = displayModeIn;
return E_FAIL; // No valid display modes found
}
*pBestDisplayMode = bestDisplayMode;
}
return S_OK;
}
//--------------------------------------------------------------------------------------
// Internal helper function to return the adapter format from the first device settings
// combo that matches the passed adapter ordinal, device type, backbuffer format, and windowed.
//--------------------------------------------------------------------------------------
HRESULT DXUTFindAdapterFormat( UINT AdapterOrdinal, D3DDEVTYPE DeviceType, D3DFORMAT BackBufferFormat,
BOOL Windowed, D3DFORMAT* pAdapterFormat )
{
CD3DEnumeration* pd3dEnum = DXUTPrepareEnumerationObject();
CD3DEnumDeviceInfo* pDeviceInfo = pd3dEnum->GetDeviceInfo( AdapterOrdinal, DeviceType );
if( pDeviceInfo )
{
for( int iDeviceCombo=0; iDeviceCombo<pDeviceInfo->deviceSettingsComboList.GetSize(); iDeviceCombo++ )
{
CD3DEnumDeviceSettingsCombo* pDeviceSettingsCombo = pDeviceInfo->deviceSettingsComboList.GetAt(iDeviceCombo);
if( pDeviceSettingsCombo->BackBufferFormat == BackBufferFormat &&
pDeviceSettingsCombo->Windowed == Windowed )
{
// Return the adapter format from the first match
*pAdapterFormat = pDeviceSettingsCombo->AdapterFormat;
return S_OK;
}
}
}
*pAdapterFormat = BackBufferFormat;
return E_FAIL;
}
//--------------------------------------------------------------------------------------
// Change to a Direct3D device created from the device settings or passed in.
// The framework will only reset if the device is similar to the previous device
// otherwise it will cleanup the previous device (if there is one) and recreate the
// scene using the app's device callbacks.
//--------------------------------------------------------------------------------------
HRESULT DXUTChangeDevice( DXUTDeviceSettings* pNewDeviceSettings, IDirect3DDevice9* pd3dDeviceFromApp, bool bForceRecreate, bool bClipWindowToSingleAdapter )
{
HRESULT hr;
DXUTDeviceSettings* pOldDeviceSettings = GetDXUTState().GetCurrentDeviceSettings();
if( DXUTGetD3DObject() == NULL )
return S_FALSE;
// Make a copy of the pNewDeviceSettings on the heap
DXUTDeviceSettings* pNewDeviceSettingsOnHeap = new DXUTDeviceSettings;
if( pNewDeviceSettingsOnHeap == NULL )
return E_OUTOFMEMORY;
memcpy( pNewDeviceSettingsOnHeap, pNewDeviceSettings, sizeof(DXUTDeviceSettings) );
pNewDeviceSettings = pNewDeviceSettingsOnHeap;
// If the ModifyDeviceSettings callback is non-NULL, then call it to let the app
// change the settings or reject the device change by returning false.
LPDXUTCALLBACKMODIFYDEVICESETTINGS pCallbackModifyDeviceSettings = GetDXUTState().GetModifyDeviceSettingsFunc();
if( pCallbackModifyDeviceSettings )
{
D3DCAPS9 caps;
IDirect3D9* pD3D = DXUTGetD3DObject();
pD3D->GetDeviceCaps( pNewDeviceSettings->AdapterOrdinal, pNewDeviceSettings->DeviceType, &caps );
bool bContinue = pCallbackModifyDeviceSettings( pNewDeviceSettings, &caps, GetDXUTState().GetModifyDeviceSettingsFuncUserContext() );
if( !bContinue )
{
// The app rejected the device change by returning false, so just use the current device if there is one.
if( pOldDeviceSettings == NULL )
DXUTDisplayErrorMessage( DXUTERR_NOCOMPATIBLEDEVICES );
SAFE_DELETE( pNewDeviceSettings );
return E_ABORT;
}
if( GetDXUTState().GetD3D() == NULL )
{
SAFE_DELETE( pNewDeviceSettings );
return S_FALSE;
}
}
GetDXUTState().SetCurrentDeviceSettings( pNewDeviceSettings );
DXUTPause( true, true );
// When a WM_SIZE message is received, it calls DXUTCheckForWindowSizeChange().
// A WM_SIZE message might be sent when adjusting the window, so tell
// DXUTCheckForWindowSizeChange() to ignore size changes temporarily
GetDXUTState().SetIgnoreSizeChange( true );
// Update thread safety on/off depending on Direct3D device's thread safety
g_bThreadSafe = ((pNewDeviceSettings->BehaviorFlags & D3DCREATE_MULTITHREADED) != 0 );
// Only apply the cmd line overrides if this is the first device created
// and DXUTSetDevice() isn't used
if( NULL == pd3dDeviceFromApp && NULL == pOldDeviceSettings )
{
// Updates the device settings struct based on the cmd line args.
// Warning: if the device doesn't support these new settings then CreateDevice() will fail.
DXUTUpdateDeviceSettingsWithOverrides( pNewDeviceSettings );
}
// Take note if the backbuffer width & height are 0 now as they will change after pd3dDevice->Reset()
bool bKeepCurrentWindowSize = false;
if( pNewDeviceSettings->pp.BackBufferWidth == 0 && pNewDeviceSettings->pp.BackBufferHeight == 0 )
bKeepCurrentWindowSize = true;
//////////////////////////
// Before reset
/////////////////////////
if( pNewDeviceSettings->pp.Windowed )
{
// Going to windowed mode
if( pOldDeviceSettings && !pOldDeviceSettings->pp.Windowed )
{
// Going from fullscreen -> windowed
GetDXUTState().SetFullScreenBackBufferWidthAtModeChange( pOldDeviceSettings->pp.BackBufferWidth );
GetDXUTState().SetFullScreenBackBufferHeightAtModeChange( pOldDeviceSettings->pp.BackBufferHeight );
// Restore windowed mode style
SetWindowLong( DXUTGetHWNDDeviceWindowed(), GWL_STYLE, GetDXUTState().GetWindowedStyleAtModeChange() );
}
// If different device windows are used for windowed mode and fullscreen mode,
// hide the fullscreen window so that it doesn't obscure the screen.
if( DXUTGetHWNDDeviceFullScreen() != DXUTGetHWNDDeviceWindowed() )
ShowWindow( DXUTGetHWNDDeviceFullScreen(), SW_HIDE );
// If using the same window for windowed and fullscreen mode, reattach menu if one exists
if( DXUTGetHWNDDeviceFullScreen() == DXUTGetHWNDDeviceWindowed() )
{
if( GetDXUTState().GetMenu() != NULL )
SetMenu( DXUTGetHWNDDeviceWindowed(), GetDXUTState().GetMenu() );
}
}
else
{
// Going to fullscreen mode
if( pOldDeviceSettings == NULL || (pOldDeviceSettings && pOldDeviceSettings->pp.Windowed) )
{
// Transistioning to full screen mode from a standard window so
// save current window position/size/style now in case the user toggles to windowed mode later
WINDOWPLACEMENT* pwp = GetDXUTState().GetWindowedPlacement();
ZeroMemory( pwp, sizeof(WINDOWPLACEMENT) );
pwp->length = sizeof(WINDOWPLACEMENT);
GetWindowPlacement( DXUTGetHWNDDeviceWindowed(), pwp );
DWORD dwStyle = GetWindowLong( DXUTGetHWNDDeviceWindowed(), GWL_STYLE );
dwStyle &= ~WS_MAXIMIZE & ~WS_MINIMIZE; // remove minimize/maximize style
GetDXUTState().SetWindowedStyleAtModeChange( dwStyle );
if( pOldDeviceSettings )
{
GetDXUTState().SetWindowBackBufferWidthAtModeChange( pOldDeviceSettings->pp.BackBufferWidth );
GetDXUTState().SetWindowBackBufferHeightAtModeChange( pOldDeviceSettings->pp.BackBufferHeight );
}
}
// Hide the window to avoid animation of blank windows
ShowWindow( DXUTGetHWNDDeviceFullScreen(), SW_HIDE );
// Set FS window style
SetWindowLong( DXUTGetHWNDDeviceFullScreen(), GWL_STYLE, WS_POPUP|WS_SYSMENU );
// If using the same window for windowed and fullscreen mode, save and remove menu
if( DXUTGetHWNDDeviceFullScreen() == DXUTGetHWNDDeviceWindowed() )
{
HMENU hMenu = GetMenu( DXUTGetHWNDDeviceFullScreen() );
GetDXUTState().SetMenu( hMenu );
SetMenu( DXUTGetHWNDDeviceFullScreen(), NULL );
}
// Restore the window to normal. Note that if the window was maximized then minimized, the
// WPF_RESTORETOMAXIMIZED flag will be set which will cause SW_RESTORE to restore the
// window from minimized to maxmized which isn't what we want right now.
WINDOWPLACEMENT wpFullscreen;
ZeroMemory( &wpFullscreen, sizeof(WINDOWPLACEMENT) );
wpFullscreen.length = sizeof(WINDOWPLACEMENT);
GetWindowPlacement( DXUTGetHWNDDeviceFullScreen(), &wpFullscreen );
wpFullscreen.flags &= ~WPF_RESTORETOMAXIMIZED;
wpFullscreen.showCmd = SW_RESTORE;
SetWindowPlacement( DXUTGetHWNDDeviceFullScreen(), &wpFullscreen );
}
// If AdapterOrdinal and DeviceType are the same, we can just do a Reset().
// If they've changed, we need to do a complete device tear down/rebuild.
// Also only allow a reset if pd3dDevice is the same as the current device
if( !bForceRecreate &&
(pd3dDeviceFromApp == NULL || pd3dDeviceFromApp == DXUTGetD3DDevice()) &&
pOldDeviceSettings &&
pOldDeviceSettings->AdapterOrdinal == pNewDeviceSettings->AdapterOrdinal &&
pOldDeviceSettings->DeviceType == pNewDeviceSettings->DeviceType &&
pOldDeviceSettings->BehaviorFlags == pNewDeviceSettings->BehaviorFlags )
{
// Reset the Direct3D device and call the app's device callbacks
hr = DXUTReset3DEnvironment();
if( FAILED(hr) )
{
if( D3DERR_DEVICELOST == hr )
{
// The device is lost, just mark it as so and continue on with
// capturing the state and resizing the window/etc.
GetDXUTState().SetDeviceLost( true );
}
else if( DXUTERR_RESETTINGDEVICEOBJECTS == hr ||
DXUTERR_MEDIANOTFOUND == hr )
{
// Something bad happened in the app callbacks
SAFE_DELETE( pOldDeviceSettings );
DXUTDisplayErrorMessage( hr );
DXUTShutdown();
return hr;
}
else // DXUTERR_RESETTINGDEVICE
{
// Reset failed and the device wasn't lost and it wasn't the apps fault,
// so recreate the device to try to recover
GetDXUTState().SetCurrentDeviceSettings( pOldDeviceSettings );
if( FAILED( DXUTChangeDevice( pNewDeviceSettings, pd3dDeviceFromApp, true, bClipWindowToSingleAdapter ) ) )
{
// If that fails, then shutdown
SAFE_DELETE( pOldDeviceSettings );
DXUTShutdown();
return DXUTERR_CREATINGDEVICE;
}
else
{
SAFE_DELETE( pOldDeviceSettings );
return S_OK;
}
}
}
}
else
{
// Cleanup if not first device created
if( pOldDeviceSettings )
DXUTCleanup3DEnvironment( false );
// Create the D3D device and call the app's device callbacks
hr = DXUTCreate3DEnvironment( pd3dDeviceFromApp );
if( FAILED(hr) )
{
SAFE_DELETE( pOldDeviceSettings );
DXUTCleanup3DEnvironment();
DXUTDisplayErrorMessage( hr );
DXUTPause( false, false );
GetDXUTState().SetIgnoreSizeChange( false );
return hr;
}
}
// Enable/disable StickKeys shortcut, ToggleKeys shortcut, FilterKeys shortcut, and Windows key
// to prevent accidental task switching
DXUTAllowShortcutKeys( ( pNewDeviceSettings->pp.Windowed ) ? GetDXUTState().GetAllowShortcutKeysWhenWindowed() : GetDXUTState().GetAllowShortcutKeysWhenFullscreen() );
IDirect3D9* pD3D = DXUTGetD3DObject();
HMONITOR hAdapterMonitor = pD3D->GetAdapterMonitor( pNewDeviceSettings->AdapterOrdinal );
GetDXUTState().SetAdapterMonitor( hAdapterMonitor );
// Update the device stats text
DXUTUpdateStaticFrameStats();
// Update GetDXUTState()'s copy of D3D caps
D3DCAPS9* pd3dCaps = GetDXUTState().GetCaps();
DXUTGetD3DDevice()->GetDeviceCaps( pd3dCaps );
if( pOldDeviceSettings && !pOldDeviceSettings->pp.Windowed && pNewDeviceSettings->pp.Windowed )
{
// Going from fullscreen -> windowed
// Restore the show state, and positions/size of the window to what it was
// It is important to adjust the window size
// after resetting the device rather than beforehand to ensure
// that the monitor resolution is correct and does not limit the size of the new window.
WINDOWPLACEMENT* pwp = GetDXUTState().GetWindowedPlacement();
SetWindowPlacement( DXUTGetHWNDDeviceWindowed(), pwp );
}
// Check to see if the window needs to be resized.
// Handle cases where the window is minimized and maxmimized as well.
bool bNeedToResize = false;
if( pNewDeviceSettings->pp.Windowed && // only resize if in windowed mode
!bKeepCurrentWindowSize ) // only resize if pp.BackbufferWidth/Height were not 0
{
UINT nClientWidth;
UINT nClientHeight;
if( IsIconic(DXUTGetHWNDDeviceWindowed()) )
{
// Window is currently minimized. To tell if it needs to resize,
// get the client rect of window when its restored the
// hard way using GetWindowPlacement()
WINDOWPLACEMENT wp;
ZeroMemory( &wp, sizeof(WINDOWPLACEMENT) );
wp.length = sizeof(WINDOWPLACEMENT);
GetWindowPlacement( DXUTGetHWNDDeviceWindowed(), &wp );
if( (wp.flags & WPF_RESTORETOMAXIMIZED) != 0 && wp.showCmd == SW_SHOWMINIMIZED )
{
// WPF_RESTORETOMAXIMIZED means that when the window is restored it will
// be maximized. So maximize the window temporarily to get the client rect
// when the window is maximized. GetSystemMetrics( SM_CXMAXIMIZED ) will give this
// information if the window is on the primary but this will work on multimon.
ShowWindow( DXUTGetHWNDDeviceWindowed(), SW_RESTORE );
RECT rcClient;
GetClientRect( DXUTGetHWNDDeviceWindowed(), &rcClient );
nClientWidth = (UINT)(rcClient.right - rcClient.left);
nClientHeight = (UINT)(rcClient.bottom - rcClient.top);
ShowWindow( DXUTGetHWNDDeviceWindowed(), SW_MINIMIZE );
}
else
{
// Use wp.rcNormalPosition to get the client rect, but wp.rcNormalPosition
// includes the window frame so subtract it
RECT rcFrame = {0};
AdjustWindowRect( &rcFrame, GetDXUTState().GetWindowedStyleAtModeChange(), GetDXUTState().GetMenu() != NULL );
LONG nFrameWidth = rcFrame.right - rcFrame.left;
LONG nFrameHeight = rcFrame.bottom - rcFrame.top;
nClientWidth = (UINT)(wp.rcNormalPosition.right - wp.rcNormalPosition.left - nFrameWidth);
nClientHeight = (UINT)(wp.rcNormalPosition.bottom - wp.rcNormalPosition.top - nFrameHeight);
}
}
else
{
// Window is restored or maximized so just get its client rect
RECT rcClient;
GetClientRect( DXUTGetHWNDDeviceWindowed(), &rcClient );
nClientWidth = (UINT)(rcClient.right - rcClient.left);
nClientHeight = (UINT)(rcClient.bottom - rcClient.top);
}
// Now that we know the client rect, compare it against the back buffer size
// to see if the client rect is already the right size
if( nClientWidth != pNewDeviceSettings->pp.BackBufferWidth ||
nClientHeight != pNewDeviceSettings->pp.BackBufferHeight )
{
bNeedToResize = true;
}
if( bClipWindowToSingleAdapter && !IsIconic(DXUTGetHWNDDeviceWindowed()) )
{
// Get the rect of the monitor attached to the adapter
MONITORINFO miAdapter;
miAdapter.cbSize = sizeof(MONITORINFO);
HMONITOR hAdapterMonitor = DXUTGetD3DObject()->GetAdapterMonitor( pNewDeviceSettings->AdapterOrdinal );
GetMonitorInfo( hAdapterMonitor, &miAdapter );
HMONITOR hWindowMonitor = MonitorFromWindow( DXUTGetHWND(), MONITOR_DEFAULTTOPRIMARY );
// Get the rect of the window
RECT rcWindow;
GetWindowRect( DXUTGetHWNDDeviceWindowed(), &rcWindow );
// Check if the window rect is fully inside the adapter's vitural screen rect
if( (rcWindow.left < miAdapter.rcWork.left ||
rcWindow.right > miAdapter.rcWork.right ||
rcWindow.top < miAdapter.rcWork.top ||
rcWindow.bottom > miAdapter.rcWork.bottom) )
{
if( hWindowMonitor == hAdapterMonitor && IsZoomed(DXUTGetHWNDDeviceWindowed()) )
{
// If the window is maximized and on the same monitor as the adapter, then
// no need to clip to single adapter as the window is already clipped
// even though the rcWindow rect is outside of the miAdapter.rcWork
}
else
{
bNeedToResize = true;
}
}
}
}
// Only resize window if needed
if( bNeedToResize )
{
// Need to resize, so if window is maximized or minimized then restore the window
if( IsIconic(DXUTGetHWNDDeviceWindowed()) )
ShowWindow( DXUTGetHWNDDeviceWindowed(), SW_RESTORE );
if( IsZoomed(DXUTGetHWNDDeviceWindowed()) ) // doing the IsIconic() check first also handles the WPF_RESTORETOMAXIMIZED case
ShowWindow( DXUTGetHWNDDeviceWindowed(), SW_RESTORE );
if( bClipWindowToSingleAdapter )
{
// Get the rect of the monitor attached to the adapter
MONITORINFO miAdapter;
miAdapter.cbSize = sizeof(MONITORINFO);
GetMonitorInfo( DXUTGetD3DObject()->GetAdapterMonitor( pNewDeviceSettings->AdapterOrdinal ), &miAdapter );
// Get the rect of the monitor attached to the window
MONITORINFO miWindow;
miWindow.cbSize = sizeof(MONITORINFO);
GetMonitorInfo( MonitorFromWindow( DXUTGetHWND(), MONITOR_DEFAULTTOPRIMARY ), &miWindow );
// Do something reasonable if the BackBuffer size is greater than the monitor size
int nAdapterMonitorWidth = miAdapter.rcWork.right - miAdapter.rcWork.left;
int nAdapterMonitorHeight = miAdapter.rcWork.bottom - miAdapter.rcWork.top;
int nClientWidth = pNewDeviceSettings->pp.BackBufferWidth;
int nClientHeight = pNewDeviceSettings->pp.BackBufferHeight;
// Get the rect of the window
RECT rcWindow;
GetWindowRect( DXUTGetHWNDDeviceWindowed(), &rcWindow );
// Make a window rect with a client rect that is the same size as the backbuffer
RECT rcResizedWindow;
rcResizedWindow.left = 0;
rcResizedWindow.right = nClientWidth;
rcResizedWindow.top = 0;
rcResizedWindow.bottom = nClientHeight;
AdjustWindowRect( &rcResizedWindow, GetWindowLong( DXUTGetHWNDDeviceWindowed(), GWL_STYLE ), GetDXUTState().GetMenu() != NULL );
int nWindowWidth = rcResizedWindow.right - rcResizedWindow.left;
int nWindowHeight = rcResizedWindow.bottom - rcResizedWindow.top;
if( nWindowWidth > nAdapterMonitorWidth )
nWindowWidth = (nAdapterMonitorWidth - 0);
if( nWindowHeight > nAdapterMonitorHeight )
nWindowHeight = (nAdapterMonitorHeight - 0);
if( rcResizedWindow.left < miAdapter.rcWork.left ||
rcResizedWindow.top < miAdapter.rcWork.top ||
rcResizedWindow.right > miAdapter.rcWork.right ||
rcResizedWindow.bottom > miAdapter.rcWork.bottom )
{
int nWindowOffsetX = (nAdapterMonitorWidth - nWindowWidth) / 2;
int nWindowOffsetY = (nAdapterMonitorHeight - nWindowHeight) / 2;
rcResizedWindow.left = miAdapter.rcWork.left + nWindowOffsetX;
rcResizedWindow.top = miAdapter.rcWork.top + nWindowOffsetY;
rcResizedWindow.right = miAdapter.rcWork.left + nWindowOffsetX + nWindowWidth;
rcResizedWindow.bottom = miAdapter.rcWork.top + nWindowOffsetY + nWindowHeight;
}
// Resize the window. It is important to adjust the window size
// after resetting the device rather than beforehand to ensure
// that the monitor resolution is correct and does not limit the size of the new window.
SetWindowPos( DXUTGetHWNDDeviceWindowed(), 0, rcResizedWindow.left, rcResizedWindow.top, nWindowWidth, nWindowHeight, SWP_NOZORDER );
}
else
{
// Make a window rect with a client rect that is the same size as the backbuffer
RECT rcWindow = {0};
rcWindow.right = (long)(pNewDeviceSettings->pp.BackBufferWidth);
rcWindow.bottom = (long)(pNewDeviceSettings->pp.BackBufferHeight);
AdjustWindowRect( &rcWindow, GetWindowLong( DXUTGetHWNDDeviceWindowed(), GWL_STYLE ), GetDXUTState().GetMenu() != NULL );
// Resize the window. It is important to adjust the window size
// after resetting the device rather than beforehand to ensure
// that the monitor resolution is correct and does not limit the size of the new window.
int cx = (int)(rcWindow.right - rcWindow.left);
int cy = (int)(rcWindow.bottom - rcWindow.top);
SetWindowPos( DXUTGetHWNDDeviceWindowed(), 0, 0, 0, cx, cy, SWP_NOZORDER|SWP_NOMOVE );
}
// Its possible that the new window size is not what we asked for.
// No window can be sized larger than the desktop, so see see if the Windows OS resized the
// window to something smaller to fit on the desktop. Also if WM_GETMINMAXINFO
// will put a limit on the smallest/largest window size.
RECT rcClient;
GetClientRect( DXUTGetHWNDDeviceWindowed(), &rcClient );
UINT nClientWidth = (UINT)(rcClient.right - rcClient.left);
UINT nClientHeight = (UINT)(rcClient.bottom - rcClient.top);
if( nClientWidth != pNewDeviceSettings->pp.BackBufferWidth ||
nClientHeight != pNewDeviceSettings->pp.BackBufferHeight )
{
// If its different, then resize the backbuffer again. This time create a backbuffer that matches the
// client rect of the current window w/o resizing the window.
DXUTDeviceSettings deviceSettings = DXUTGetDeviceSettings();
deviceSettings.pp.BackBufferWidth = 0;
deviceSettings.pp.BackBufferHeight = 0;
hr = DXUTChangeDevice( &deviceSettings, NULL, false, bClipWindowToSingleAdapter );
if( FAILED( hr ) )
{
SAFE_DELETE( pOldDeviceSettings );
DXUTCleanup3DEnvironment();
DXUTPause( false, false );
GetDXUTState().SetIgnoreSizeChange( false );
return hr;
}
}
}
// Make the window visible
if( !IsWindowVisible( DXUTGetHWND() ) )
ShowWindow( DXUTGetHWND(), SW_SHOW );
// Show/hide the HW cursor after the window is its proper place if the application requested it
if( GetDXUTState().GetShowCursorWhenFullScreen() )
DXUTInitHWCursor();
SAFE_DELETE( pOldDeviceSettings );
GetDXUTState().SetIgnoreSizeChange( false );
DXUTPause( false, false );
GetDXUTState().SetDeviceCreated( true );
return S_OK;
}
//--------------------------------------------------------------------------------------
// Low level keyboard hook to disable Windows key to prevent accidental task switching.
//--------------------------------------------------------------------------------------
LRESULT CALLBACK LowLevelKeyboardProc( int nCode, WPARAM wParam, LPARAM lParam )
{
if (nCode < 0 || nCode != HC_ACTION) // do not process message
return CallNextHookEx( GetDXUTState().GetKeyboardHook(), nCode, wParam, lParam);
return CallNextHookEx( GetDXUTState().GetKeyboardHook(), nCode, wParam, lParam );
}
//--------------------------------------------------------------------------------------
// Controls how DXUT behaves when fullscreen and windowed mode with regard to
// shortcut keys (Windows keys, StickyKeys shortcut, ToggleKeys shortcut, FilterKeys shortcut)
//--------------------------------------------------------------------------------------
void DXUTSetShortcutKeySettings( bool bAllowWhenFullscreen, bool bAllowWhenWindowed )
{
GetDXUTState().SetAllowShortcutKeysWhenWindowed( bAllowWhenWindowed );
GetDXUTState().SetAllowShortcutKeysWhenFullscreen( bAllowWhenFullscreen );
// DXUTInit() records initial accessibility states so don't change them until then
if( GetDXUTState().GetDXUTInited() )
{
if( DXUTIsWindowed() )
DXUTAllowShortcutKeys( GetDXUTState().GetAllowShortcutKeysWhenWindowed() );
else
DXUTAllowShortcutKeys( GetDXUTState().GetAllowShortcutKeysWhenFullscreen() );
}
}
//--------------------------------------------------------------------------------------
// Enables/disables Windows keys, and disables or restores the StickyKeys/ToggleKeys/FilterKeys
// shortcut to help prevent accidental task switching
//--------------------------------------------------------------------------------------
void DXUTAllowShortcutKeys( bool bAllowKeys )
{
GetDXUTState().SetAllowShortcutKeys( bAllowKeys );
}
//--------------------------------------------------------------------------------------
// Updates the device settings struct based on the cmd line args.
//--------------------------------------------------------------------------------------
void DXUTUpdateDeviceSettingsWithOverrides( DXUTDeviceSettings* pDeviceSettings )
{
if( GetDXUTState().GetOverrideAdapterOrdinal() != -1 )
pDeviceSettings->AdapterOrdinal = GetDXUTState().GetOverrideAdapterOrdinal();
if( GetDXUTState().GetOverrideFullScreen() )
pDeviceSettings->pp.Windowed = false;
if( GetDXUTState().GetOverrideWindowed() )
pDeviceSettings->pp.Windowed = true;
if( GetDXUTState().GetOverrideForceREF() )
pDeviceSettings->DeviceType = D3DDEVTYPE_REF;
else if( GetDXUTState().GetOverrideForceHAL() )
pDeviceSettings->DeviceType = D3DDEVTYPE_HAL;
if( GetDXUTState().GetOverrideWidth() != 0 )
pDeviceSettings->pp.BackBufferWidth = GetDXUTState().GetOverrideWidth();
if( GetDXUTState().GetOverrideHeight() != 0 )
pDeviceSettings->pp.BackBufferHeight = GetDXUTState().GetOverrideHeight();
if( GetDXUTState().GetOverrideForcePureHWVP() )
{
pDeviceSettings->BehaviorFlags &= ~D3DCREATE_SOFTWARE_VERTEXPROCESSING;
pDeviceSettings->BehaviorFlags |= D3DCREATE_HARDWARE_VERTEXPROCESSING;
pDeviceSettings->BehaviorFlags |= D3DCREATE_PUREDEVICE;
}
else if( GetDXUTState().GetOverrideForceHWVP() )
{
pDeviceSettings->BehaviorFlags &= ~D3DCREATE_SOFTWARE_VERTEXPROCESSING;
pDeviceSettings->BehaviorFlags &= ~D3DCREATE_PUREDEVICE;
pDeviceSettings->BehaviorFlags |= D3DCREATE_HARDWARE_VERTEXPROCESSING;
}
else if( GetDXUTState().GetOverrideForceSWVP() )
{
pDeviceSettings->BehaviorFlags &= ~D3DCREATE_HARDWARE_VERTEXPROCESSING;
pDeviceSettings->BehaviorFlags &= ~D3DCREATE_PUREDEVICE;
pDeviceSettings->BehaviorFlags |= D3DCREATE_SOFTWARE_VERTEXPROCESSING;
}
}
//--------------------------------------------------------------------------------------
// Creates the 3D environment
//--------------------------------------------------------------------------------------
HRESULT DXUTCreate3DEnvironment( IDirect3DDevice9* pd3dDeviceFromApp )
{
HRESULT hr = S_OK;
IDirect3DDevice9* pd3dDevice = NULL;
DXUTDeviceSettings* pNewDeviceSettings = GetDXUTState().GetCurrentDeviceSettings();
// Only create a Direct3D device if one hasn't been supplied by the app
if( pd3dDeviceFromApp == NULL )
{
// Try to create the device with the chosen settings
IDirect3D9* pD3D = DXUTGetD3DObject();
hr = pD3D->CreateDevice( pNewDeviceSettings->AdapterOrdinal, pNewDeviceSettings->DeviceType,
DXUTGetHWNDFocus(), pNewDeviceSettings->BehaviorFlags,
&pNewDeviceSettings->pp, &pd3dDevice );
if( FAILED(hr) )
{
DXUT_ERR( "CreateDevice", hr );
return DXUTERR_CREATINGDEVICE;
}
}
else
{
pd3dDeviceFromApp->AddRef();
pd3dDevice = pd3dDeviceFromApp;
}
GetDXUTState().SetD3DDevice( pd3dDevice );
// If switching to REF, set the exit code to 11. If switching to HAL and exit code was 11, then set it back to 0.
if( pNewDeviceSettings->DeviceType == D3DDEVTYPE_REF && GetDXUTState().GetExitCode() == 0 )
GetDXUTState().SetExitCode(11);
else if( pNewDeviceSettings->DeviceType == D3DDEVTYPE_HAL && GetDXUTState().GetExitCode() == 11 )
GetDXUTState().SetExitCode(0);
// Update back buffer desc before calling app's device callbacks
DXUTUpdateBackBufferDesc();
// Update the device stats text
CD3DEnumeration* pd3dEnum = DXUTPrepareEnumerationObject();
CD3DEnumAdapterInfo* pAdapterInfo = pd3dEnum->GetAdapterInfo( pNewDeviceSettings->AdapterOrdinal );
DXUTUpdateDeviceStats( pNewDeviceSettings->DeviceType,
pNewDeviceSettings->BehaviorFlags,
&pAdapterInfo->AdapterIdentifier );
// Call the resource cache created function
hr = DXUTGetGlobalResourceCache().OnCreateDevice( pd3dDevice );
if( FAILED(hr) )
return DXUT_ERR( "OnCreateDevice", ( hr == DXUTERR_MEDIANOTFOUND ) ? DXUTERR_MEDIANOTFOUND : DXUTERR_CREATINGDEVICEOBJECTS );
// Call the app's device created callback if non-NULL
const D3DSURFACE_DESC* pbackBufferSurfaceDesc = DXUTGetBackBufferSurfaceDesc();
GetDXUTState().SetInsideDeviceCallback( true );
LPDXUTCALLBACKDEVICECREATED pCallbackDeviceCreated = GetDXUTState().GetDeviceCreatedFunc();
hr = S_OK;
if( pCallbackDeviceCreated != NULL )
hr = pCallbackDeviceCreated( DXUTGetD3DDevice(), pbackBufferSurfaceDesc, GetDXUTState().GetDeviceCreatedFuncUserContext() );
GetDXUTState().SetInsideDeviceCallback( false );
if( DXUTGetD3DDevice() == NULL ) // Handle DXUTShutdown from inside callback
return E_FAIL;
if( FAILED(hr) )
{
DXUT_ERR( "DeviceCreated callback", hr );
return ( hr == DXUTERR_MEDIANOTFOUND ) ? DXUTERR_MEDIANOTFOUND : DXUTERR_CREATINGDEVICEOBJECTS;
}
GetDXUTState().SetDeviceObjectsCreated( true );
// Call the resource cache device reset function
hr = DXUTGetGlobalResourceCache().OnResetDevice( pd3dDevice );
if( FAILED(hr) )
return DXUT_ERR( "OnResetDevice", DXUTERR_RESETTINGDEVICEOBJECTS );
// Call the app's device reset callback if non-NULL
GetDXUTState().SetInsideDeviceCallback( true );
LPDXUTCALLBACKDEVICERESET pCallbackDeviceReset = GetDXUTState().GetDeviceResetFunc();
hr = S_OK;
if( pCallbackDeviceReset != NULL )
hr = pCallbackDeviceReset( DXUTGetD3DDevice(), pbackBufferSurfaceDesc, GetDXUTState().GetDeviceResetFuncUserContext() );
GetDXUTState().SetInsideDeviceCallback( false );
if( DXUTGetD3DDevice() == NULL ) // Handle DXUTShutdown from inside callback
return E_FAIL;
if( FAILED(hr) )
{
DXUT_ERR( "DeviceReset callback", hr );
return ( hr == DXUTERR_MEDIANOTFOUND ) ? DXUTERR_MEDIANOTFOUND : DXUTERR_RESETTINGDEVICEOBJECTS;
}
GetDXUTState().SetDeviceObjectsReset( true );
return S_OK;
}
//--------------------------------------------------------------------------------------
// Resets the 3D environment by:
// - Calls the device lost callback
// - Resets the device
// - Stores the back buffer description
// - Sets up the full screen Direct3D cursor if requested
// - Calls the device reset callback
//--------------------------------------------------------------------------------------
HRESULT DXUTReset3DEnvironment()
{
HRESULT hr;
IDirect3DDevice9* pd3dDevice = DXUTGetD3DDevice();
assert( pd3dDevice != NULL );
// Call the app's device lost callback
if( GetDXUTState().GetDeviceObjectsReset() == true )
{
GetDXUTState().SetInsideDeviceCallback( true );
LPDXUTCALLBACKDEVICELOST pCallbackDeviceLost = GetDXUTState().GetDeviceLostFunc();
if( pCallbackDeviceLost != NULL )
pCallbackDeviceLost( GetDXUTState().GetDeviceLostFuncUserContext() );
GetDXUTState().SetDeviceObjectsReset( false );
GetDXUTState().SetInsideDeviceCallback( false );
// Call the resource cache device lost function
DXUTGetGlobalResourceCache().OnLostDevice();
}
// Reset the device
DXUTDeviceSettings* pDeviceSettings = GetDXUTState().GetCurrentDeviceSettings();
hr = pd3dDevice->Reset( &pDeviceSettings->pp );
if( FAILED(hr) )
{
if( hr == D3DERR_DEVICELOST )
return D3DERR_DEVICELOST; // Reset could legitimately fail if the device is lost
else
return DXUT_ERR( "Reset", DXUTERR_RESETTINGDEVICE );
}
// Update back buffer desc before calling app's device callbacks
DXUTUpdateBackBufferDesc();
hr = DXUTGetGlobalResourceCache().OnResetDevice( pd3dDevice );
if( FAILED(hr) )
return DXUT_ERR( "OnResetDevice", DXUTERR_RESETTINGDEVICEOBJECTS );
// Call the app's OnDeviceReset callback
GetDXUTState().SetInsideDeviceCallback( true );
const D3DSURFACE_DESC* pbackBufferSurfaceDesc = DXUTGetBackBufferSurfaceDesc();
LPDXUTCALLBACKDEVICERESET pCallbackDeviceReset = GetDXUTState().GetDeviceResetFunc();
hr = S_OK;
if( pCallbackDeviceReset != NULL )
hr = pCallbackDeviceReset( pd3dDevice, pbackBufferSurfaceDesc, GetDXUTState().GetDeviceResetFuncUserContext() );
GetDXUTState().SetInsideDeviceCallback( false );
if( FAILED(hr) )
{
// If callback failed, cleanup
DXUT_ERR( "DeviceResetCallback", hr );
if( hr != DXUTERR_MEDIANOTFOUND )
hr = DXUTERR_RESETTINGDEVICEOBJECTS;
GetDXUTState().SetInsideDeviceCallback( true );
LPDXUTCALLBACKDEVICELOST pCallbackDeviceLost = GetDXUTState().GetDeviceLostFunc();
if( pCallbackDeviceLost != NULL )
pCallbackDeviceLost( GetDXUTState().GetDeviceLostFuncUserContext() );
GetDXUTState().SetInsideDeviceCallback( false );
DXUTGetGlobalResourceCache().OnLostDevice();
return hr;
}
// Success
GetDXUTState().SetDeviceObjectsReset( true );
return S_OK;
}
//--------------------------------------------------------------------------------------
// Pauses time or rendering. Keeps a ref count so pausing can be layered
//--------------------------------------------------------------------------------------
void DXUTPause( bool bPauseTime, bool bPauseRendering )
{
int nPauseTimeCount = GetDXUTState().GetPauseTimeCount();
nPauseTimeCount += ( bPauseTime ? +1 : -1 );
if( nPauseTimeCount < 0 )
nPauseTimeCount = 0;
GetDXUTState().SetPauseTimeCount( nPauseTimeCount );
int nPauseRenderingCount = GetDXUTState().GetPauseRenderingCount();
nPauseRenderingCount += ( bPauseRendering ? +1 : -1 );
if( nPauseRenderingCount < 0 )
nPauseRenderingCount = 0;
GetDXUTState().SetPauseRenderingCount( nPauseRenderingCount );
if( nPauseTimeCount > 0 )
{
// Stop the scene from animating
DXUTGetGlobalTimer()->Stop();
}
else
{
// Restart the timer
DXUTGetGlobalTimer()->Start();
}
GetDXUTState().SetRenderingPaused( nPauseRenderingCount > 0 );
GetDXUTState().SetTimePaused( nPauseTimeCount > 0 );
}
//--------------------------------------------------------------------------------------
// Checks if the window client rect has changed and if it has, then reset the device
//--------------------------------------------------------------------------------------
void DXUTCheckForWindowSizeChange()
{
// Skip the check for various reasons
if( GetDXUTState().GetIgnoreSizeChange() ||
!GetDXUTState().GetDeviceCreated() ||
!GetDXUTState().GetCurrentDeviceSettings()->pp.Windowed )
return;
RECT rcCurrentClient;
GetClientRect( DXUTGetHWND(), &rcCurrentClient );
if( (UINT)rcCurrentClient.right != GetDXUTState().GetCurrentDeviceSettings()->pp.BackBufferWidth ||
(UINT)rcCurrentClient.bottom != GetDXUTState().GetCurrentDeviceSettings()->pp.BackBufferHeight )
{
// A new window size will require a new backbuffer size
// size, so the device must be reset and the D3D structures updated accordingly.
// Tell DXUTChangeDevice and D3D to size according to the HWND's client rect
DXUTDeviceSettings deviceSettings = DXUTGetDeviceSettings();
deviceSettings.pp.BackBufferWidth = 0;
deviceSettings.pp.BackBufferHeight = 0;
DXUTChangeDevice( &deviceSettings, NULL, false, false );
}
}
//--------------------------------------------------------------------------------------
// Handles app's message loop and rendering when idle. If DXUTCreateDevice*() or DXUTSetDevice()
// has not already been called, it will call DXUTCreateWindow() with the default parameters.
//--------------------------------------------------------------------------------------
HRESULT DXUTMainLoop( HACCEL hAccel )
{
HRESULT hr;
// Not allowed to call this from inside the device callbacks or reenter
if( GetDXUTState().GetInsideDeviceCallback() || GetDXUTState().GetInsideMainloop() )
{
if( (GetDXUTState().GetExitCode() == 0) || (GetDXUTState().GetExitCode() == 11) )
GetDXUTState().SetExitCode(1);
return DXUT_ERR_MSGBOX( "DXUTMainLoop", E_FAIL );
}
GetDXUTState().SetInsideMainloop( true );
// If DXUTCreateDevice*() or DXUTSetDevice() has not already been called,
// then call DXUTCreateDevice() with the default parameters.
if( !GetDXUTState().GetDeviceCreated() )
{
if( GetDXUTState().GetDeviceCreateCalled() )
{
if( (GetDXUTState().GetExitCode() == 0) || (GetDXUTState().GetExitCode() == 11) )
GetDXUTState().SetExitCode(1);
return E_FAIL; // DXUTCreateDevice() must first succeed for this function to succeed
}
hr = DXUTCreateDevice();
if( FAILED(hr) )
{
if( (GetDXUTState().GetExitCode() == 0) || (GetDXUTState().GetExitCode() == 11) )
GetDXUTState().SetExitCode(1);
return hr;
}
}
HWND hWnd = DXUTGetHWND();
// DXUTInit() must have been called and succeeded for this function to proceed
// DXUTCreateWindow() or DXUTSetWindow() must have been called and succeeded for this function to proceed
// DXUTCreateDevice() or DXUTCreateDeviceFromSettings() or DXUTSetDevice() must have been called and succeeded for this function to proceed
if( !GetDXUTState().GetDXUTInited() || !GetDXUTState().GetWindowCreated() || !GetDXUTState().GetDeviceCreated() )
{
if( (GetDXUTState().GetExitCode() == 0) || (GetDXUTState().GetExitCode() == 11) )
GetDXUTState().SetExitCode(1);
return DXUT_ERR_MSGBOX( "DXUTMainLoop", E_FAIL );
}
// Now we're ready to receive and process Windows messages.
bool bGotMsg;
MSG msg;
msg.message = WM_NULL;
PeekMessage( &msg, NULL, 0U, 0U, PM_NOREMOVE );
while( WM_QUIT != msg.message )
{
// Use PeekMessage() so we can use idle time to render the scene.
bGotMsg = ( PeekMessage( &msg, NULL, 0U, 0U, PM_REMOVE ) != 0 );
if( bGotMsg )
{
// Translate and dispatch the message
if( hAccel == NULL || hWnd == NULL ||
0 == TranslateAccelerator( hWnd, hAccel, &msg ) )
{
TranslateMessage( &msg );
DispatchMessage( &msg );
}
}
else
{
// Render a frame during idle time (no messages are waiting)
DXUTRender3DEnvironment();
}
}
// Cleanup the accelerator table
if( hAccel != NULL )
DestroyAcceleratorTable( hAccel );
GetDXUTState().SetInsideMainloop( false );
return S_OK;
}
//--------------------------------------------------------------------------------------
// Render the 3D environment by:
// - Checking if the device is lost and trying to reset it if it is
// - Get the elapsed time since the last frame
// - Calling the app's framemove and render callback
// - Calling Present()
//--------------------------------------------------------------------------------------
void DXUTRender3DEnvironment()
{
HRESULT hr;
IDirect3DDevice9* pd3dDevice = DXUTGetD3DDevice();
if( NULL == pd3dDevice )
return;
if( GetDXUTState().GetDeviceLost() || DXUTIsRenderingPaused() )
{
// Window is minimized or paused so yield
// CPU time to other processes
Sleep( 100 );
}
if( !GetDXUTState().GetActive() )
{
// Window is not in focus so yield CPU time to other processes
Sleep( 20 );
}
if( GetDXUTState().GetDeviceLost() && !GetDXUTState().GetRenderingPaused() )
{
// Test the cooperative level to see if it's okay to render
if( FAILED( hr = pd3dDevice->TestCooperativeLevel() ) )
{
if( D3DERR_DEVICELOST == hr )
{
// The device has been lost but cannot be reset at this time.
// So wait until it can be reset.
Sleep( 50 );
return;
}
// If we are windowed, read the desktop format and
// ensure that the Direct3D device is using the same format
// since the user could have changed the desktop bitdepth
if( DXUTIsWindowed() )
{
D3DDISPLAYMODE adapterDesktopDisplayMode;
IDirect3D9* pD3D = DXUTGetD3DObject();
DXUTDeviceSettings* pDeviceSettings = GetDXUTState().GetCurrentDeviceSettings();
pD3D->GetAdapterDisplayMode( pDeviceSettings->AdapterOrdinal, &adapterDesktopDisplayMode );
if( pDeviceSettings->AdapterFormat != adapterDesktopDisplayMode.Format )
{
DXUTMatchOptions matchOptions;
matchOptions.eAdapterOrdinal = DXUTMT_PRESERVE_INPUT;
matchOptions.eDeviceType = DXUTMT_PRESERVE_INPUT;
matchOptions.eWindowed = DXUTMT_PRESERVE_INPUT;
matchOptions.eAdapterFormat = DXUTMT_PRESERVE_INPUT;
matchOptions.eVertexProcessing = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eResolution = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eBackBufferFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eBackBufferCount = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eMultiSample = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eSwapEffect = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eDepthFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eStencilFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.ePresentFlags = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eRefreshRate = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.ePresentInterval = DXUTMT_CLOSEST_TO_INPUT;
DXUTDeviceSettings deviceSettings = DXUTGetDeviceSettings();
deviceSettings.AdapterFormat = adapterDesktopDisplayMode.Format;
hr = DXUTFindValidDeviceSettings( &deviceSettings, &deviceSettings, &matchOptions );
if( FAILED(hr) ) // the call will fail if no valid devices were found
{
DXUTDisplayErrorMessage( DXUTERR_NOCOMPATIBLEDEVICES );
DXUTShutdown();
}
// Change to a Direct3D device created from the new device settings.
// If there is an existing device, then either reset or recreate the scene
hr = DXUTChangeDevice( &deviceSettings, NULL, false, false );
if( FAILED(hr) )
{
// If this fails, try to go fullscreen and if this fails also shutdown.
if( FAILED(DXUTToggleFullScreen()) )
DXUTShutdown();
}
return;
}
}
// Try to reset the device
if( FAILED( hr = DXUTReset3DEnvironment() ) )
{
if( D3DERR_DEVICELOST == hr )
{
// The device was lost again, so continue waiting until it can be reset.
Sleep( 50 );
return;
}
else if( DXUTERR_RESETTINGDEVICEOBJECTS == hr ||
DXUTERR_MEDIANOTFOUND == hr )
{
DXUTDisplayErrorMessage( hr );
DXUTShutdown();
return;
}
else
{
// Reset failed, but the device wasn't lost so something bad happened,
// so recreate the device to try to recover
DXUTDeviceSettings* pDeviceSettings = GetDXUTState().GetCurrentDeviceSettings();
if( FAILED( DXUTChangeDevice( pDeviceSettings, NULL, true, false ) ) )
{
DXUTShutdown();
return;
}
}
}
}
GetDXUTState().SetDeviceLost( false );
}
// Get the app's time, in seconds. Skip rendering if no time elapsed
double fTime = DXUTGetGlobalTimer()->GetTime();
float fElapsedTime = (float) DXUTGetGlobalTimer()->GetElapsedTime();
// Store the time for the app
if( GetDXUTState().GetConstantFrameTime() )
{
fElapsedTime = GetDXUTState().GetTimePerFrame();
fTime = DXUTGetTime() + fElapsedTime;
}
GetDXUTState().SetTime( fTime );
GetDXUTState().SetElapsedTime( fElapsedTime );
// Update the FPS stats
DXUTUpdateFrameStats();
DXUTHandleTimers();
// Animate the scene by calling the app's frame move callback
LPDXUTCALLBACKFRAMEMOVE pCallbackFrameMove = GetDXUTState().GetFrameMoveFunc();
if( pCallbackFrameMove != NULL )
{
pCallbackFrameMove( pd3dDevice, fTime, fElapsedTime, GetDXUTState().GetFrameMoveFuncUserContext() );
pd3dDevice = DXUTGetD3DDevice();
if( NULL == pd3dDevice ) // Handle DXUTShutdown from inside callback
return;
}
if( !GetDXUTState().GetRenderingPaused() )
{
// Render the scene by calling the app's render callback
LPDXUTCALLBACKFRAMERENDER pCallbackFrameRender = GetDXUTState().GetFrameRenderFunc();
if( pCallbackFrameRender != NULL )
{
pCallbackFrameRender( pd3dDevice, fTime, fElapsedTime, GetDXUTState().GetFrameRenderFuncUserContext() );
pd3dDevice = DXUTGetD3DDevice();
if( NULL == pd3dDevice ) // Handle DXUTShutdown from inside callback
return;
}
#if defined(DEBUG) | defined(_DEBUG)
// The back buffer should always match the client rect
// if the Direct3D backbuffer covers the entire window
RECT rcClient;
GetClientRect( DXUTGetHWND(), &rcClient );
assert( DXUTGetBackBufferSurfaceDesc()->Width == (UINT)rcClient.right );
assert( DXUTGetBackBufferSurfaceDesc()->Height == (UINT)rcClient.bottom );
#endif
// Show the frame on the primary surface.
hr = pd3dDevice->Present( NULL, NULL, NULL, NULL );
if( FAILED(hr) )
{
if( D3DERR_DEVICELOST == hr )
{
GetDXUTState().SetDeviceLost( true );
}
else if( D3DERR_DRIVERINTERNALERROR == hr )
{
// When D3DERR_DRIVERINTERNALERROR is returned from Present(),
// the application can do one of the following:
//
// - End, with the pop-up window saying that the application cannot continue
// because of problems in the display adapter and that the user should
// contact the adapter manufacturer.
//
// - Attempt to restart by calling IDirect3DDevice9::Reset, which is essentially the same
// path as recovering from a lost device. If IDirect3DDevice9::Reset fails with
// D3DERR_DRIVERINTERNALERROR, the application should end immediately with the message
// that the user should contact the adapter manufacturer.
//
// The framework attempts the path of resetting the device
//
GetDXUTState().SetDeviceLost( true );
}
}
}
// Update current frame #
int nFrame = GetDXUTState().GetCurrentFrameNumber();
nFrame++;
GetDXUTState().SetCurrentFrameNumber( nFrame );
// Check to see if the app should shutdown due to cmdline
if( GetDXUTState().GetOverrideQuitAfterFrame() != 0 )
{
if( nFrame > GetDXUTState().GetOverrideQuitAfterFrame() )
DXUTShutdown();
}
return;
}
//--------------------------------------------------------------------------------------
// Updates the string which describes the device
//--------------------------------------------------------------------------------------
void DXUTUpdateDeviceStats( D3DDEVTYPE DeviceType, DWORD BehaviorFlags, D3DADAPTER_IDENTIFIER9* pAdapterIdentifier )
{
// Store device description
TCHAR* pstrDeviceStats = GetDXUTState().GetDeviceStats();
if( DeviceType == D3DDEVTYPE_REF )
StringCchCopy( pstrDeviceStats, 256, "REF" );
else if( DeviceType == D3DDEVTYPE_HAL )
StringCchCopy( pstrDeviceStats, 256, "HA" );
else if( DeviceType == D3DDEVTYPE_SW )
StringCchCopy( pstrDeviceStats, 256, "SW" );
if( BehaviorFlags & D3DCREATE_HARDWARE_VERTEXPROCESSING &&
BehaviorFlags & D3DCREATE_PUREDEVICE )
{
if( DeviceType == D3DDEVTYPE_HAL )
StringCchCat( pstrDeviceStats, 256, " (pure hw vp)" );
else
StringCchCat( pstrDeviceStats, 256, " (simulated pure hw vp)" );
}
else if( BehaviorFlags & D3DCREATE_HARDWARE_VERTEXPROCESSING )
{
if( DeviceType == D3DDEVTYPE_HAL )
StringCchCat( pstrDeviceStats, 256, " (hw vp)" );
else
StringCchCat( pstrDeviceStats, 256, " (simulated hw vp)" );
}
else if( BehaviorFlags & D3DCREATE_MIXED_VERTEXPROCESSING )
{
if( DeviceType == D3DDEVTYPE_HAL )
StringCchCat( pstrDeviceStats, 256, " (mixed vp)" );
else
StringCchCat( pstrDeviceStats, 256, " (simulated mixed vp)" );
}
else if( BehaviorFlags & D3DCREATE_SOFTWARE_VERTEXPROCESSING )
{
StringCchCat( pstrDeviceStats, 256, " (sw vp)" );
}
if( DeviceType == D3DDEVTYPE_HAL )
{
// Be sure not to overflow m_strDeviceStats when appending the adapter
// description, since it can be long.
StringCchCat( pstrDeviceStats, 256, ": " );
// Try to get a unique description from the CD3DEnumDeviceSettingsCombo
DXUTDeviceSettings* pDeviceSettings = GetDXUTState().GetCurrentDeviceSettings();
CD3DEnumeration* pd3dEnum = DXUTPrepareEnumerationObject();
CD3DEnumDeviceSettingsCombo* pDeviceSettingsCombo = pd3dEnum->GetDeviceSettingsCombo( pDeviceSettings->AdapterOrdinal, pDeviceSettings->DeviceType, pDeviceSettings->AdapterFormat, pDeviceSettings->pp.BackBufferFormat, pDeviceSettings->pp.Windowed );
if( pDeviceSettingsCombo )
{
StringCchCat( pstrDeviceStats, 256, pDeviceSettingsCombo->pAdapterInfo->szUniqueDescription );
}
else
{
const int cchDesc = sizeof(pAdapterIdentifier->Description);
TCHAR szDescription[cchDesc];
strcpy(szDescription, pAdapterIdentifier->Description);
szDescription[cchDesc-1] = 0;
StringCchCat( pstrDeviceStats, 256, szDescription );
}
}
}
//--------------------------------------------------------------------------------------
// Updates the frames/sec stat once per second
//--------------------------------------------------------------------------------------
void DXUTUpdateFrameStats()
{
// Keep track of the frame count
double fLastTime = GetDXUTState().GetLastStatsUpdateTime();
DWORD dwFrames = GetDXUTState().GetLastStatsUpdateFrames();
double fTime = DXUTGetGlobalTimer()->GetAbsoluteTime();
dwFrames++;
GetDXUTState().SetLastStatsUpdateFrames( dwFrames );
// Update the scene stats once per second
if( fTime - fLastTime > 1.0f )
{
float fFPS = (float) (dwFrames / (fTime - fLastTime));
GetDXUTState().SetFPS( fFPS );
GetDXUTState().SetLastStatsUpdateTime( fTime );
GetDXUTState().SetLastStatsUpdateFrames( 0 );
TCHAR* pstrFrameStats = GetDXUTState().GetFrameStats();
TCHAR* pstrStaticFrameStats = GetDXUTState().GetStaticFrameStats();
StringCchPrintf( pstrFrameStats, 256, pstrStaticFrameStats, fFPS );
pstrFrameStats[255] = 0;
}
}
//--------------------------------------------------------------------------------------
// Updates the static part of the frame stats so it doesn't have be generated every frame
//--------------------------------------------------------------------------------------
void DXUTUpdateStaticFrameStats()
{
DXUTDeviceSettings* pDeviceSettings = GetDXUTState().GetCurrentDeviceSettings();
if( NULL == pDeviceSettings )
return;
CD3DEnumeration* pd3dEnum = DXUTPrepareEnumerationObject();
if( NULL == pd3dEnum )
return;
CD3DEnumDeviceSettingsCombo* pDeviceSettingsCombo = pd3dEnum->GetDeviceSettingsCombo( pDeviceSettings->AdapterOrdinal, pDeviceSettings->DeviceType, pDeviceSettings->AdapterFormat, pDeviceSettings->pp.BackBufferFormat, pDeviceSettings->pp.Windowed );
if( NULL == pDeviceSettingsCombo )
return;
TCHAR strFmt[100];
D3DPRESENT_PARAMETERS* pPP = &pDeviceSettings->pp;
if( pDeviceSettingsCombo->AdapterFormat == pDeviceSettingsCombo->BackBufferFormat )
{
StringCchCopy( strFmt, 100, DXUTD3DFormatToString( pDeviceSettingsCombo->AdapterFormat, false ) );
}
else
{
StringCchPrintf( strFmt, 100, "backbuf %s, adapter %s",
DXUTD3DFormatToString( pDeviceSettingsCombo->BackBufferFormat, false ),
DXUTD3DFormatToString( pDeviceSettingsCombo->AdapterFormat, false ) );
}
TCHAR strDepthFmt[100];
if( pPP->EnableAutoDepthStencil )
{
StringCchPrintf( strDepthFmt, 100, " (%s)", DXUTD3DFormatToString( pPP->AutoDepthStencilFormat, false ) );
}
else
{
// No depth buffer
strDepthFmt[0] = 0;
}
TCHAR strMultiSample[100];
switch( pPP->MultiSampleType )
{
case D3DMULTISAMPLE_NONMASKABLE: StringCchCopy( strMultiSample, 100, " (Nonmaskable Multisample)" ); break;
case D3DMULTISAMPLE_NONE: StringCchCopy( strMultiSample, 100, "" ); break;
default: StringCchPrintf( strMultiSample, 100, " (%dx Multisample)", pPP->MultiSampleType ); break;
}
TCHAR* pstrStaticFrameStats = GetDXUTState().GetStaticFrameStats();
StringCchPrintf( pstrStaticFrameStats, 256, "%%.02f fps (%dx%d), %s%s%s",
pPP->BackBufferWidth, pPP->BackBufferHeight,
strFmt, strDepthFmt, strMultiSample );
}
//--------------------------------------------------------------------------------------
// Handles window messages
//--------------------------------------------------------------------------------------
LRESULT APIENTRY NewWndProc(HWND hwnd,UINT uMsg,WPARAM wParam,LPARAM lParam);
LRESULT CALLBACK DXUTStaticWndProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam )
{
// Consolidate the keyboard messages and pass them to the app's keyboard callback
if( uMsg == WM_KEYDOWN ||
uMsg == WM_SYSKEYDOWN ||
uMsg == WM_KEYUP ||
uMsg == WM_SYSKEYUP )
{
bool bKeyDown = (uMsg == WM_KEYDOWN || uMsg == WM_SYSKEYDOWN);
DWORD dwMask = (1 << 29);
bool bAltDown = ( (lParam & dwMask) != 0 );
bool* bKeys = GetDXUTState().GetKeys();
bKeys[ (BYTE) (wParam & 0xFF) ] = bKeyDown;
LPDXUTCALLBACKKEYBOARD pCallbackKeyboard = GetDXUTState().GetKeyboardFunc();
if( pCallbackKeyboard )
pCallbackKeyboard( (UINT)wParam, bKeyDown, bAltDown, GetDXUTState().GetKeyboardFuncUserContext() );
}
// Consolidate the mouse button messages and pass them to the app's mouse callback
if( uMsg == WM_LBUTTONDOWN ||
uMsg == WM_LBUTTONUP ||
uMsg == WM_LBUTTONDBLCLK ||
uMsg == WM_MBUTTONDOWN ||
uMsg == WM_MBUTTONUP ||
uMsg == WM_MBUTTONDBLCLK ||
uMsg == WM_RBUTTONDOWN ||
uMsg == WM_RBUTTONUP ||
uMsg == WM_RBUTTONDBLCLK ||
uMsg == WM_MOUSEWHEEL ||
(GetDXUTState().GetNotifyOnMouseMove() && uMsg == WM_MOUSEMOVE) )
{
int xPos = (short)LOWORD(lParam);
int yPos = (short)HIWORD(lParam);
if( uMsg == WM_MOUSEWHEEL )
{
// WM_MOUSEWHEEL passes screen mouse coords
// so convert them to client coords
POINT pt;
pt.x = xPos; pt.y = yPos;
ScreenToClient( hWnd, &pt );
xPos = pt.x; yPos = pt.y;
}
int nMouseWheelDelta = 0;
if( uMsg == WM_MOUSEWHEEL )
nMouseWheelDelta = (short) HIWORD(wParam);
int nMouseButtonState = LOWORD(wParam);
bool bLeftButton = ((nMouseButtonState & MK_LBUTTON) != 0);
bool bRightButton = ((nMouseButtonState & MK_RBUTTON) != 0);
bool bMiddleButton = ((nMouseButtonState & MK_MBUTTON) != 0);
bool* bMouseButtons = GetDXUTState().GetMouseButtons();
bMouseButtons[0] = bLeftButton;
bMouseButtons[1] = bMiddleButton;
bMouseButtons[2] = bRightButton;
bMouseButtons[3] = false;
bMouseButtons[4] = false;
LPDXUTCALLBACKMOUSE pCallbackMouse = GetDXUTState().GetMouseFunc();
if( pCallbackMouse )
pCallbackMouse( bLeftButton, bRightButton, bMiddleButton, false, false, nMouseWheelDelta, xPos, yPos, GetDXUTState().GetMouseFuncUserContext() );
}
// Pass all messages to the app's MsgProc callback, and don't
// process further messages if the apps says not to.
//NewWndProc(hWnd,uMsg,wParam,lParam);
switch( uMsg )
{
case WM_PAINT:
{
IDirect3DDevice9* pd3dDevice = DXUTGetD3DDevice();
// Handle paint messages when the app is paused
if( pd3dDevice && DXUTIsRenderingPaused() &&
GetDXUTState().GetDeviceObjectsCreated() && GetDXUTState().GetDeviceObjectsReset() )
{
HRESULT hr;
double fTime = DXUTGetTime();
float fElapsedTime = DXUTGetElapsedTime();
LPDXUTCALLBACKFRAMERENDER pCallbackFrameRender = GetDXUTState().GetFrameRenderFunc();
if( pCallbackFrameRender != NULL )
pCallbackFrameRender( pd3dDevice, fTime, fElapsedTime, GetDXUTState().GetFrameRenderFuncUserContext() );
hr = pd3dDevice->Present( NULL, NULL, NULL, NULL );
if( D3DERR_DEVICELOST == hr )
{
GetDXUTState().SetDeviceLost( true );
}
else if( D3DERR_DRIVERINTERNALERROR == hr )
{
// When D3DERR_DRIVERINTERNALERROR is returned from Present(),
// the application can do one of the following:
//
// - End, with the pop-up window saying that the application cannot continue
// because of problems in the display adapter and that the user should
// contact the adapter manufacturer.
//
// - Attempt to restart by calling IDirect3DDevice9::Reset, which is essentially the same
// path as recovering from a lost device. If IDirect3DDevice9::Reset fails with
// D3DERR_DRIVERINTERNALERROR, the application should end immediately with the message
// that the user should contact the adapter manufacturer.
//
// The framework attempts the path of resetting the device
//
GetDXUTState().SetDeviceLost( true );
}
}
break;
}
case WM_SIZE:
if( SIZE_MINIMIZED == wParam )
{
if( GetDXUTState().GetClipCursorWhenFullScreen() && !DXUTIsWindowed() )
ClipCursor( NULL );
DXUTPause( true, true ); // Pause while we're minimized
GetDXUTState().SetMinimized( true );
GetDXUTState().SetMaximized( false );
}
else
{
RECT rcCurrentClient;
GetClientRect( DXUTGetHWND(), &rcCurrentClient );
if( rcCurrentClient.top == 0 && rcCurrentClient.bottom == 0 )
{
// Rapidly clicking the task bar to minimize and restore a window
// can cause a WM_SIZE message with SIZE_RESTORED when
// the window has actually become minimized due to rapid change
// so just ignore this message
}
else if( SIZE_MAXIMIZED == wParam )
{
if( GetDXUTState().GetMinimized() )
DXUTPause( false, false ); // Unpause since we're no longer minimized
GetDXUTState().SetMinimized( false );
GetDXUTState().SetMaximized( true );
DXUTCheckForWindowSizeChange();
DXUTCheckForWindowChangingMonitors();
}
else if( SIZE_RESTORED == wParam )
{
if( GetDXUTState().GetMaximized() )
{
GetDXUTState().SetMaximized( false );
DXUTCheckForWindowSizeChange();
DXUTCheckForWindowChangingMonitors();
}
else if( GetDXUTState().GetMinimized() )
{
DXUTPause( false, false ); // Unpause since we're no longer minimized
GetDXUTState().SetMinimized( false );
DXUTCheckForWindowSizeChange();
DXUTCheckForWindowChangingMonitors();
}
else if( GetDXUTState().GetInSizeMove() )
{
// If we're neither maximized nor minimized, the window size
// is changing by the user dragging the window edges. In this
// case, we don't reset the device yet -- we wait until the
// user stops dragging, and a WM_EXITSIZEMOVE message comes.
}
else
{
// This WM_SIZE come from resizing the window via an API like SetWindowPos() so
// resize and reset the device now.
DXUTCheckForWindowSizeChange();
DXUTCheckForWindowChangingMonitors();
}
}
}
break;
case WM_GETMINMAXINFO:
((MINMAXINFO*)lParam)->ptMinTrackSize.x = DXUT_MIN_WINDOW_SIZE_X;
((MINMAXINFO*)lParam)->ptMinTrackSize.y = DXUT_MIN_WINDOW_SIZE_Y;
break;
case WM_ENTERSIZEMOVE:
// Halt frame movement while the app is sizing or moving
DXUTPause( true, true );
GetDXUTState().SetInSizeMove( true );
break;
case WM_EXITSIZEMOVE:
DXUTPause( false, false );
DXUTCheckForWindowSizeChange();
DXUTCheckForWindowChangingMonitors();
GetDXUTState().SetInSizeMove( false );
break;
case WM_MOUSEMOVE:
if( !DXUTIsRenderingPaused() && !DXUTIsWindowed() )
{
IDirect3DDevice9* pd3dDevice = DXUTGetD3DDevice();
if( pd3dDevice )
{
POINT ptCursor;
GetCursorPos( &ptCursor );
pd3dDevice->SetCursorPosition( ptCursor.x, ptCursor.y, 0 );
}
}
break;
case WM_ACTIVATEAPP:
if( wParam == TRUE && !GetDXUTState().GetActive() ) // Handle only if previously not active
{
GetDXUTState().SetActive( true );
// Show the cursor again if returning to fullscreen
if( !DXUTIsWindowed() && GetDXUTState().GetShowCursorWhenFullScreen() )
DXUTInitHWCursor();
// The GetMinimizedWhileFullscreen() varible is used instead of !DXUTIsWindowed()
// to handle the rare case toggling to windowed mode while the fullscreen application
// is minimized and thus making the pause count wrong
if( GetDXUTState().GetMinimizedWhileFullscreen() )
{
DXUTPause( false, false ); // Unpause since we're no longer minimized
GetDXUTState().SetMinimizedWhileFullscreen( false );
}
// Upon returning to this app, potentially disable shortcut keys
// (Windows key, accessibility shortcuts)
DXUTAllowShortcutKeys( ( DXUTIsWindowed() ) ? GetDXUTState().GetAllowShortcutKeysWhenWindowed() :
GetDXUTState().GetAllowShortcutKeysWhenFullscreen() );
}
else if( wParam == FALSE && GetDXUTState().GetActive() ) // Handle only if previously active
{
GetDXUTState().SetActive( false );
if( !DXUTIsWindowed() )
{
// Going from full screen to a minimized state
ClipCursor( NULL ); // don't limit the cursor anymore
DXUTPause( true, true ); // Pause while we're minimized (take care not to pause twice by handling this message twice)
GetDXUTState().SetMinimizedWhileFullscreen( true );
}
// Restore shortcut keys (Windows key, accessibility shortcuts) to original state
//
// This is important to call here if the shortcuts are disabled,
// because if this is not done then the Windows key will continue to
// be disabled while this app is running which is very bad.
// If the app crashes, the Windows key will return to normal.
DXUTAllowShortcutKeys( true );
}
break;
case WM_ENTERMENULOOP:
// Pause the app when menus are displayed
DXUTPause( true, true );
break;
case WM_EXITMENULOOP:
DXUTPause( false, false );
break;
case WM_MENUCHAR:
// A menu is active and the user presses a key that does not correspond to any mnemonic or accelerator key
// So just ignore and don't beep
return MAKELRESULT(0,MNC_CLOSE);
break;
case WM_NCHITTEST:
// Prevent the user from selecting the menu in full screen mode
if( !DXUTIsWindowed() )
return HTCLIENT;
break;
case WM_POWERBROADCAST:
switch( wParam )
{
#ifndef PBT_APMQUERYSUSPEND
#define PBT_APMQUERYSUSPEND 0x0000
#endif
case PBT_APMQUERYSUSPEND:
// At this point, the app should save any data for open
// network connections, files, etc., and prepare to go into
// a suspended mode. The app can use the MsgProc callback
// to handle this if desired.
return true;
#ifndef PBT_APMRESUMESUSPEND
#define PBT_APMRESUMESUSPEND 0x0007
#endif
case PBT_APMRESUMESUSPEND:
// At this point, the app should recover any data, network
// connections, files, etc., and resume running from when
// the app was suspended. The app can use the MsgProc callback
// to handle this if desired.
// QPC may lose consistency when suspending, so reset the timer
// upon resume.
DXUTGetGlobalTimer()->Reset();
GetDXUTState().SetLastStatsUpdateTime( 0 );
return true;
}
break;
case WM_SYSCOMMAND:
// Prevent moving/sizing and power loss in full screen mode
switch( wParam )
{
case SC_MOVE:
case SC_SIZE:
case SC_MAXIMIZE:
case SC_KEYMENU:
case SC_MONITORPOWER:
if( !DXUTIsWindowed() )
return 0;
break;
}
break;
case WM_SYSKEYDOWN:
{
if( GetDXUTState().GetHandleDefaultHotkeys() )
{
switch( wParam )
{
case VK_RETURN:
{
// Toggle full screen upon alt-enter
DWORD dwMask = (1 << 29);
if( (lParam & dwMask) != 0 ) // Alt is down also
{
// Toggle the full screen/window mode
DXUTPause( true, true );
DXUTToggleFullScreen();
DXUTPause( false, false );
return 0;
}
}
}
}
break;
}
case WM_KEYDOWN:
{
if( GetDXUTState().GetHandleDefaultHotkeys() )
{
switch( wParam )
{
case VK_F3:
{
DXUTPause( true, true );
DXUTToggleREF();
DXUTPause( false, false );
break;
}
case VK_F8:
{
bool bWireFrame = GetDXUTState().GetWireframeMode();
bWireFrame = !bWireFrame;
GetDXUTState().SetWireframeMode( bWireFrame );
IDirect3DDevice9* pd3dDevice = DXUTGetD3DDevice();
if( pd3dDevice )
pd3dDevice->SetRenderState( D3DRS_FILLMODE, (bWireFrame) ? D3DFILL_WIREFRAME : D3DFILL_SOLID );
break;
}
case VK_ESCAPE:
{
// Received key to exit app
SendMessage( hWnd, WM_CLOSE, 0, 0 );
}
case VK_PAUSE:
{
bool bTimePaused = DXUTIsTimePaused();
bTimePaused = !bTimePaused;
if( bTimePaused )
DXUTPause( true, false );
else
DXUTPause( false, false );
break;
}
}
}
break;
}
case WM_CLOSE:
{
HMENU hMenu;
hMenu = GetMenu(hWnd);
if( hMenu != NULL )
DestroyMenu( hMenu );
DestroyWindow( hWnd );
UnregisterClass( "Direct3DWindowClass", NULL );
GetDXUTState().SetHWNDFocus( NULL );
GetDXUTState().SetHWNDDeviceFullScreen( NULL );
GetDXUTState().SetHWNDDeviceWindowed( NULL );
return 0;
}
case WM_DESTROY:
PostQuitMessage(0);
break;
}
// Don't allow the F10 key to act as a shortcut to the menu bar
// by not passing these messages to the DefWindowProc only when
// there's no menu present
if( GetDXUTState().GetMenu() == NULL && (uMsg == WM_SYSKEYDOWN || uMsg == WM_SYSKEYUP) && wParam == VK_F10 )
return 0;
else
return DefWindowProc( hWnd, uMsg, wParam, lParam );
}
//--------------------------------------------------------------------------------------
// Resets the state associated with DXUT
//--------------------------------------------------------------------------------------
void DXUTResetFrameworkState()
{
GetDXUTState().Destroy();
GetDXUTState().Create();
}
//--------------------------------------------------------------------------------------
// Closes down the window. When the window closes, it will cleanup everything
//--------------------------------------------------------------------------------------
// MATCH
void DXUTShutdown( int nExitCode )
{
HWND hWnd = DXUTGetHWND();
if( hWnd != NULL )
SendMessage( hWnd, WM_CLOSE, 0, 0 );
GetDXUTState().SetExitCode(nExitCode);
DXUTCleanup3DEnvironment( true );
// Restore shortcut keys (Windows key, accessibility shortcuts) to original state
// This is important to call here if the shortcuts are disabled,
// because accessibility setting changes are permanent.
// This means that if this is not done then the accessibility settings
// might not be the same as when the app was started.
// If the app crashes without restoring the settings, this is also true so it
// would be wise to backup/restore the settings from a file so they can be
// restored when the crashed app is run again.
DXUTAllowShortcutKeys( true );
GetDXUTState().SetD3DEnumeration( NULL );
IDirect3D9* pD3D = DXUTGetD3DObject();
SAFE_RELEASE( pD3D );
GetDXUTState().SetD3D( NULL );
}
//--------------------------------------------------------------------------------------
// Cleans up the 3D environment by:
// - Calls the device lost callback
// - Calls the device destroyed callback
// - Releases the D3D device
//--------------------------------------------------------------------------------------
// MATCH
void DXUTCleanup3DEnvironment( bool bReleaseSettings )
{
IDirect3DDevice9* pd3dDevice = DXUTGetD3DDevice();
if( pd3dDevice != NULL )
{
GetDXUTState().SetInsideDeviceCallback( true );
// Call the app's device lost callback
if( GetDXUTState().GetDeviceObjectsReset() == true )
{
LPDXUTCALLBACKDEVICELOST pCallbackDeviceLost = GetDXUTState().GetDeviceLostFunc();
if( pCallbackDeviceLost != NULL )
pCallbackDeviceLost( GetDXUTState().GetDeviceLostFuncUserContext() );
GetDXUTState().SetDeviceObjectsReset( false );
// Call the resource cache device lost function
DXUTGetGlobalResourceCache().OnLostDevice();
}
// Call the app's device destroyed callback
if( GetDXUTState().GetDeviceObjectsCreated() == true )
{
LPDXUTCALLBACKDEVICEDESTROYED pCallbackDeviceDestroyed = GetDXUTState().GetDeviceDestroyedFunc();
if( pCallbackDeviceDestroyed != NULL )
pCallbackDeviceDestroyed( GetDXUTState().GetDeviceDestroyedFuncUserContext() );
GetDXUTState().SetDeviceObjectsCreated( false );
// Call the resource cache device destory function
DXUTGetGlobalResourceCache().OnDestroyDevice();
}
GetDXUTState().SetInsideDeviceCallback( false );
// Release the D3D device and in debug configs, displays a message box if there
// are unrelease objects.
if( pd3dDevice )
{
if( pd3dDevice->Release() > 0 )
{
DXUTDisplayErrorMessage( DXUTERR_NONZEROREFCOUNT );
DXUT_ERR( "DXUTCleanup3DEnvironment", DXUTERR_NONZEROREFCOUNT );
}
}
GetDXUTState().SetD3DDevice( NULL );
if( bReleaseSettings )
{
DXUTDeviceSettings* pOldDeviceSettings = GetDXUTState().GetCurrentDeviceSettings();
SAFE_DELETE(pOldDeviceSettings);
GetDXUTState().SetCurrentDeviceSettings( NULL );
}
D3DSURFACE_DESC* pbackBufferSurfaceDesc = GetDXUTState().GetBackBufferSurfaceDesc();
ZeroMemory( pbackBufferSurfaceDesc, sizeof(D3DSURFACE_DESC) );
D3DCAPS9* pd3dCaps = GetDXUTState().GetCaps();
ZeroMemory( pd3dCaps, sizeof(D3DCAPS9) );
GetDXUTState().SetDeviceCreated( false );
}
}
//--------------------------------------------------------------------------------------
// Stores back buffer surface desc in GetDXUTState().GetBackBufferSurfaceDesc()
//--------------------------------------------------------------------------------------
void DXUTUpdateBackBufferDesc()
{
HRESULT hr;
IDirect3DSurface9* pBackBuffer;
hr = GetDXUTState().GetD3DDevice()->GetBackBuffer( 0, 0, D3DBACKBUFFER_TYPE_MONO, &pBackBuffer );
D3DSURFACE_DESC* pBBufferSurfaceDesc = GetDXUTState().GetBackBufferSurfaceDesc();
ZeroMemory( pBBufferSurfaceDesc, sizeof(D3DSURFACE_DESC) );
if( SUCCEEDED(hr) )
{
pBackBuffer->GetDesc( pBBufferSurfaceDesc );
SAFE_RELEASE( pBackBuffer );
}
}
//--------------------------------------------------------------------------------------
// Starts a user defined timer callback
//--------------------------------------------------------------------------------------
HRESULT DXUTSetTimer( LPDXUTCALLBACKTIMER pCallbackTimer, float fTimeoutInSecs, UINT* pnIDEvent, void* pCallbackUserContext )
{
if( pCallbackTimer == NULL )
return DXUT_ERR_MSGBOX( "DXUTSetTimer", E_INVALIDARG );
HRESULT hr;
DXUT_TIMER DXUTTimer;
DXUTTimer.pCallbackTimer = pCallbackTimer;
DXUTTimer.pCallbackUserContext = pCallbackUserContext;
DXUTTimer.fTimeoutInSecs = fTimeoutInSecs;
DXUTTimer.fCountdown = fTimeoutInSecs;
DXUTTimer.bEnabled = true;
CGrowableArray<DXUT_TIMER>* pTimerList = GetDXUTState().GetTimerList();
if( pTimerList == NULL )
{
pTimerList = new CGrowableArray<DXUT_TIMER>;
if( pTimerList == NULL )
return E_OUTOFMEMORY;
GetDXUTState().SetTimerList( pTimerList );
}
if( FAILED( hr = pTimerList->Add( DXUTTimer ) ) )
return hr;
if( pnIDEvent )
*pnIDEvent = pTimerList->GetSize();
return S_OK;
}
//--------------------------------------------------------------------------------------
// Stops a user defined timer callback
//--------------------------------------------------------------------------------------
HRESULT DXUTKillTimer( UINT nIDEvent )
{
CGrowableArray<DXUT_TIMER>* pTimerList = GetDXUTState().GetTimerList();
if( pTimerList == NULL )
return S_FALSE;
if( nIDEvent < (UINT)pTimerList->GetSize() )
{
DXUT_TIMER DXUTTimer = pTimerList->GetAt(nIDEvent);
DXUTTimer.bEnabled = false;
pTimerList->SetAt(nIDEvent, DXUTTimer);
}
else
{
return DXUT_ERR_MSGBOX( "DXUTKillTimer", E_INVALIDARG );
}
return S_OK;
}
//--------------------------------------------------------------------------------------
// Internal helper function to handle calling the user defined timer callbacks
//--------------------------------------------------------------------------------------
void DXUTHandleTimers()
{
float fElapsedTime = DXUTGetElapsedTime();
CGrowableArray<DXUT_TIMER>* pTimerList = GetDXUTState().GetTimerList();
if( pTimerList == NULL )
return;
// Walk through the list of timer callbacks
for( int i=0; i<pTimerList->GetSize(); i++ )
{
DXUT_TIMER DXUTTimer = pTimerList->GetAt(i);
if( DXUTTimer.bEnabled )
{
DXUTTimer.fCountdown -= fElapsedTime;
// Call the callback if count down expired
if( DXUTTimer.fCountdown < 0 )
{
DXUTTimer.pCallbackTimer( i, DXUTTimer.pCallbackUserContext );
DXUTTimer.fCountdown = DXUTTimer.fTimeoutInSecs;
}
pTimerList->SetAt(i, DXUTTimer);
}
}
}
//--------------------------------------------------------------------------------------
// External state access functions
//--------------------------------------------------------------------------------------
IDirect3D9* DXUTGetD3DObject() { return GetDXUTState().GetD3D(); }
IDirect3DDevice9* DXUTGetD3DDevice() { return GetDXUTState().GetD3DDevice(); }
const D3DSURFACE_DESC* DXUTGetBackBufferSurfaceDesc() { return GetDXUTState().GetBackBufferSurfaceDesc(); }
const D3DCAPS9* DXUTGetDeviceCaps() { return GetDXUTState().GetCaps(); }
HINSTANCE DXUTGetHINSTANCE() { return GetDXUTState().GetHInstance(); }
HWND DXUTGetHWND() { return DXUTIsWindowed() ? GetDXUTState().GetHWNDDeviceWindowed() : GetDXUTState().GetHWNDDeviceFullScreen(); }
HWND DXUTGetHWNDFocus() { return GetDXUTState().GetHWNDFocus(); }
HWND DXUTGetHWNDDeviceFullScreen() { return GetDXUTState().GetHWNDDeviceFullScreen(); }
HWND DXUTGetHWNDDeviceWindowed() { return GetDXUTState().GetHWNDDeviceWindowed(); }
RECT DXUTGetWindowClientRect() { RECT rc; GetClientRect( DXUTGetHWND(), &rc ); return rc; }
RECT DXUTGetWindowClientRectAtModeChange() { RECT rc = { 0, 0, GetDXUTState().GetWindowBackBufferWidthAtModeChange(), GetDXUTState().GetWindowBackBufferHeightAtModeChange() }; return rc; }
RECT DXUTGetFullsceenClientRectAtModeChange() { RECT rc = { 0, 0, GetDXUTState().GetFullScreenBackBufferWidthAtModeChange(), GetDXUTState().GetFullScreenBackBufferHeightAtModeChange() }; return rc; }
double DXUTGetTime() { return GetDXUTState().GetTime(); }
float DXUTGetElapsedTime() { return GetDXUTState().GetElapsedTime(); }
float DXUTGetFPS() { return GetDXUTState().GetFPS(); }
LPCTSTR DXUTGetWindowTitle() { return GetDXUTState().GetWindowTitle(); }
LPCTSTR DXUTGetFrameStats() { return GetDXUTState().GetFrameStats(); }
LPCTSTR DXUTGetDeviceStats() { return GetDXUTState().GetDeviceStats(); }
bool DXUTIsRenderingPaused() { return GetDXUTState().GetPauseRenderingCount() > 0; }
bool DXUTIsTimePaused() { return GetDXUTState().GetPauseTimeCount() > 0; }
int DXUTGetExitCode() { return GetDXUTState().GetExitCode(); }
bool DXUTGetShowMsgBoxOnError() { return GetDXUTState().GetShowMsgBoxOnError(); }
bool DXUTGetAutomation() { return GetDXUTState().GetAutomation(); }
bool DXUTIsKeyDown( BYTE vKey )
{
bool* bKeys = GetDXUTState().GetKeys();
if( vKey >= 0xA0 && vKey <= 0xA5 ) // VK_LSHIFT, VK_RSHIFT, VK_LCONTROL, VK_RCONTROL, VK_LMENU, VK_RMENU
return GetAsyncKeyState( vKey ) != 0; // these keys only are tracked via GetAsyncKeyState()
else if( vKey >= 0x01 && vKey <= 0x06 && vKey != 0x03 ) // mouse buttons (VK_*BUTTON)
return DXUTIsMouseButtonDown(vKey);
else
return bKeys[vKey];
}
bool DXUTIsMouseButtonDown( BYTE vButton )
{
bool* bMouseButtons = GetDXUTState().GetMouseButtons();
int nIndex = DXUTMapButtonToArrayIndex(vButton);
return bMouseButtons[nIndex];
}
void DXUTSetMultimonSettings( bool bAutoChangeAdapter )
{
GetDXUTState().SetAutoChangeAdapter( bAutoChangeAdapter );
}
void DXUTSetCursorSettings( bool bShowCursorWhenFullScreen, bool bClipCursorWhenFullScreen )
{
GetDXUTState().SetClipCursorWhenFullScreen(bClipCursorWhenFullScreen);
GetDXUTState().SetShowCursorWhenFullScreen(bShowCursorWhenFullScreen);
}
// MATCH
void DXUTSetConstantFrameTime( bool bEnabled, float fTimePerFrame )
{
if( GetDXUTState().GetOverrideConstantFrameTime() )
{
bEnabled = GetDXUTState().GetOverrideConstantFrameTime();
fTimePerFrame = GetDXUTState().GetOverrideConstantTimePerFrame();
}
GetDXUTState().SetConstantFrameTime(bEnabled);
GetDXUTState().SetTimePerFrame(fTimePerFrame);
}
//--------------------------------------------------------------------------------------
// Return if windowed in the current device. If no device exists yet, then returns false
//--------------------------------------------------------------------------------------
// MATCH
bool DXUTIsWindowed()
{
DXUTDeviceSettings* pDeviceSettings = GetDXUTState().GetCurrentDeviceSettings();
if(pDeviceSettings)
return (pDeviceSettings->pp.Windowed != 0);
else
return false;
}
//--------------------------------------------------------------------------------------
// Return the present params of the current device. If no device exists yet, then
// return blank present params
//--------------------------------------------------------------------------------------
D3DPRESENT_PARAMETERS DXUTGetPresentParameters()
{
DXUTDeviceSettings* pDS = GetDXUTState().GetCurrentDeviceSettings();
if( pDS )
{
return pDS->pp;
}
else
{
D3DPRESENT_PARAMETERS pp;
ZeroMemory( &pp, sizeof(D3DPRESENT_PARAMETERS) );
return pp;
}
}
//--------------------------------------------------------------------------------------
// Return the device settings of the current device. If no device exists yet, then
// return blank device settings
//--------------------------------------------------------------------------------------
DXUTDeviceSettings DXUTGetDeviceSettings()
{
DXUTDeviceSettings* pDS = GetDXUTState().GetCurrentDeviceSettings();
if( pDS )
{
return *pDS;
}
else
{
DXUTDeviceSettings ds;
ZeroMemory( &ds, sizeof(DXUTDeviceSettings) );
return ds;
}
}
#ifndef SM_REMOTESESSION // needs WINVER >= 0x0500
#define SM_REMOTESESSION 0x1000
#endif
//--------------------------------------------------------------------------------------
// Display an custom error msg box
//--------------------------------------------------------------------------------------
// MATCH
void DXUTDisplayErrorMessage( HRESULT hr )
{
TCHAR strBuffer[512];
int nExitCode;
bool bFound = true;
switch( hr )
{
case DXUTERR_NODIRECT3D: nExitCode = 2; StringCchCopy( strBuffer, 512, "Could not initialize Direct3D. You may want to check that the latest version of DirectX is correctly installed on your system. Also make sure that this program was compiled with header files that match the installed DirectX DLLs." ); break;
case DXUTERR_INCORRECTVERSION: nExitCode = 10; StringCchCopy( strBuffer, 512, "Incorrect version of Direct3D and/or D3DX." ); break;
case DXUTERR_MEDIANOTFOUND: nExitCode = 4; StringCchCopy( strBuffer, 512, "Could not find required media. Ensure that the DirectX SDK is correctly installed." ); break;
case DXUTERR_NONZEROREFCOUNT: nExitCode = 5; StringCchCopy( strBuffer, 512, "The D3D device has a non-zero reference count, meaning some objects were not released." ); break;
case DXUTERR_CREATINGDEVICE: nExitCode = 6; StringCchCopy( strBuffer, 512, "Failed creating the Direct3D device." ); break;
case DXUTERR_RESETTINGDEVICE: nExitCode = 7; StringCchCopy( strBuffer, 512, "Failed resetting the Direct3D device." ); break;
case DXUTERR_CREATINGDEVICEOBJECTS: nExitCode = 8; StringCchCopy( strBuffer, 512, "Failed creating Direct3D device objects." ); break;
case DXUTERR_RESETTINGDEVICEOBJECTS: nExitCode = 9; StringCchCopy( strBuffer, 512, "Failed resetting Direct3D device objects." ); break;
case DXUTERR_NOCOMPATIBLEDEVICES:
nExitCode = 3;
if( GetSystemMetrics(SM_REMOTESESSION) != 0 )
StringCchCopy( strBuffer, 512, "Direct3D does not work over a remote session." );
else
StringCchCopy( strBuffer, 512, "Could not find any compatible Direct3D devices." );
break;
default: bFound = false; nExitCode = 1;break;
}
GetDXUTState().SetExitCode(nExitCode);
bool bShowMsgBoxOnError = GetDXUTState().GetShowMsgBoxOnError();
if( bFound && bShowMsgBoxOnError )
{
if( DXUTGetWindowTitle()[0] == 0 )
MessageBox( DXUTGetHWND(), strBuffer, "DirectX Application", MB_ICONERROR|MB_OK );
else
MessageBox( DXUTGetHWND(), strBuffer, DXUTGetWindowTitle(), MB_ICONERROR|MB_OK );
}
}
//--------------------------------------------------------------------------------------
// Display error msg box to help debug
//--------------------------------------------------------------------------------------
HRESULT WINAPI DXUTTrace( const CHAR* strFile, DWORD dwLine, HRESULT hr,
const TCHAR* strMsg, bool bPopMsgBox )
{
bool bShowMsgBoxOnError = GetDXUTState().GetShowMsgBoxOnError();
if( bPopMsgBox && bShowMsgBoxOnError == false )
bPopMsgBox = false;
return DXTrace( strFile, dwLine, hr, strMsg, bPopMsgBox );
}
//--------------------------------------------------------------------------------------
// Checks to see if the HWND changed monitors, and if it did it creates a device
// from the monitor's adapter and recreates the scene.
//--------------------------------------------------------------------------------------
void DXUTCheckForWindowChangingMonitors()
{
// Skip this check for various reasons
if( !GetDXUTState().GetAutoChangeAdapter() ||
GetDXUTState().GetIgnoreSizeChange() ||
!GetDXUTState().GetDeviceCreated() ||
!GetDXUTState().GetCurrentDeviceSettings()->pp.Windowed )
{
return;
}
HRESULT hr;
HMONITOR hWindowMonitor = MonitorFromWindow( DXUTGetHWND(), MONITOR_DEFAULTTOPRIMARY );
HMONITOR hAdapterMonitor = GetDXUTState().GetAdapterMonitor();
if( hWindowMonitor != hAdapterMonitor )
{
UINT newOrdinal;
if( SUCCEEDED( DXUTGetAdapterOrdinalFromMonitor( hWindowMonitor, &newOrdinal ) ) )
{
// Find the closest valid device settings with the new ordinal
DXUTDeviceSettings deviceSettings = DXUTGetDeviceSettings();
deviceSettings.AdapterOrdinal = newOrdinal;
DXUTMatchOptions matchOptions;
matchOptions.eAdapterOrdinal = DXUTMT_PRESERVE_INPUT;
matchOptions.eDeviceType = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eWindowed = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eAdapterFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eVertexProcessing = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eResolution = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eBackBufferFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eBackBufferCount = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eMultiSample = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eSwapEffect = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eDepthFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eStencilFormat = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.ePresentFlags = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.eRefreshRate = DXUTMT_CLOSEST_TO_INPUT;
matchOptions.ePresentInterval = DXUTMT_CLOSEST_TO_INPUT;
hr = DXUTFindValidDeviceSettings( &deviceSettings, &deviceSettings, &matchOptions );
if( SUCCEEDED(hr) )
{
// Create a Direct3D device using the new device settings.
// If there is an existing device, then it will either reset or recreate the scene.
hr = DXUTChangeDevice( &deviceSettings, NULL, false, false );
// If hr == E_ABORT, this means the app rejected the device settings in the ModifySettingsCallback
if( hr == E_ABORT )
{
// so nothing changed and keep from attempting to switch adapters next time
GetDXUTState().SetAutoChangeAdapter( false );
}
else if( FAILED(hr) )
{
DXUTShutdown();
DXUTPause( false, false );
return;
}
}
}
}
}
//--------------------------------------------------------------------------------------
// Look for an adapter ordinal that is tied to a HMONITOR
//--------------------------------------------------------------------------------------
HRESULT DXUTGetAdapterOrdinalFromMonitor( HMONITOR hMonitor, UINT* pAdapterOrdinal )
{
*pAdapterOrdinal = 0;
CD3DEnumeration* pd3dEnum = DXUTPrepareEnumerationObject();
IDirect3D9* pD3D = DXUTGetD3DObject();
CGrowableArray<CD3DEnumAdapterInfo*>* pAdapterList = pd3dEnum->GetAdapterInfoList();
for( int iAdapter=0; iAdapter<pAdapterList->GetSize(); iAdapter++ )
{
CD3DEnumAdapterInfo* pAdapterInfo = pAdapterList->GetAt(iAdapter);
HMONITOR hAdapterMonitor = pD3D->GetAdapterMonitor( pAdapterInfo->AdapterOrdinal );
if( hAdapterMonitor == hMonitor )
{
*pAdapterOrdinal = pAdapterInfo->AdapterOrdinal;
return S_OK;
}
}
return E_FAIL;
}
//--------------------------------------------------------------------------------------
// Internal function to map MK_* to an array index
//--------------------------------------------------------------------------------------
int DXUTMapButtonToArrayIndex( BYTE vButton )
{
switch( vButton )
{
case MK_LBUTTON: return 0;
case MK_MBUTTON: return 1;
case MK_RBUTTON: return 2;
}
return 0;
}
//--------------------------------------------------------------------------------------
// Initialize the HW cursor and clipped
//--------------------------------------------------------------------------------------
void DXUTInitHWCursor()
{
// Set up the full screen cursor
if( !DXUTIsWindowed() )
{
HCURSOR hCursor = (HCURSOR)(ULONG_PTR)GetClassLongPtr( DXUTGetHWNDDeviceFullScreen(), GCLP_HCURSOR );
DXUTSetDeviceCursor( GetDXUTState().GetD3DDevice(), hCursor, false );
DXUTGetD3DDevice()->ShowCursor( true );
// Confine cursor to full screen window
RECT rcWindow;
GetWindowRect( DXUTGetHWNDDeviceFullScreen(), &rcWindow );
ClipCursor( &rcWindow );
}
else
{
ClipCursor( NULL );
}
}
//--------------------------------------------------------------------------------------
// Gives the D3D device a cursor with image and hotspot from hCursor.
//--------------------------------------------------------------------------------------
HRESULT DXUTSetDeviceCursor( IDirect3DDevice9* pd3dDevice, HCURSOR hCursor, bool bAddWatermark )
{
HRESULT hr = E_FAIL;
ICONINFO iconinfo;
bool bBWCursor;
LPDIRECT3DSURFACE9 pCursorSurface = NULL;
HDC hdcColor = NULL;
HDC hdcMask = NULL;
HDC hdcScreen = NULL;
BITMAP bm;
DWORD dwWidth;
DWORD dwHeightSrc;
DWORD dwHeightDest;
COLORREF crColor;
COLORREF crMask;
UINT x;
UINT y;
BITMAPINFO bmi;
COLORREF* pcrArrayColor = NULL;
COLORREF* pcrArrayMask = NULL;
DWORD* pBitmap;
HGDIOBJ hgdiobjOld;
ZeroMemory( &iconinfo, sizeof(iconinfo) );
if( !GetIconInfo( hCursor, &iconinfo ) )
goto End;
if (0 == GetObject((HGDIOBJ)iconinfo.hbmMask, sizeof(BITMAP), (LPVOID)&bm))
goto End;
dwWidth = bm.bmWidth;
dwHeightSrc = bm.bmHeight;
if( iconinfo.hbmColor == NULL )
{
bBWCursor = TRUE;
dwHeightDest = dwHeightSrc / 2;
}
else
{
bBWCursor = FALSE;
dwHeightDest = dwHeightSrc;
}
// Create a surface for the fullscreen cursor
if( FAILED( hr = pd3dDevice->CreateOffscreenPlainSurface( dwWidth, dwHeightDest,
D3DFMT_A8R8G8B8, D3DPOOL_SCRATCH, &pCursorSurface, NULL ) ) )
{
goto End;
}
pcrArrayMask = new DWORD[dwWidth * dwHeightSrc];
ZeroMemory(&bmi, sizeof(bmi));
bmi.bmiHeader.biSize = sizeof(bmi.bmiHeader);
bmi.bmiHeader.biWidth = dwWidth;
bmi.bmiHeader.biHeight = dwHeightSrc;
bmi.bmiHeader.biPlanes = 1;
bmi.bmiHeader.biBitCount = 32;
bmi.bmiHeader.biCompression = BI_RGB;
hdcScreen = GetDC( NULL );
hdcMask = CreateCompatibleDC( hdcScreen );
if( hdcMask == NULL )
{
hr = E_FAIL;
goto End;
}
hgdiobjOld = SelectObject(hdcMask, iconinfo.hbmMask);
GetDIBits(hdcMask, iconinfo.hbmMask, 0, dwHeightSrc,
pcrArrayMask, &bmi, DIB_RGB_COLORS);
SelectObject(hdcMask, hgdiobjOld);
if (!bBWCursor)
{
pcrArrayColor = new DWORD[dwWidth * dwHeightDest];
hdcColor = CreateCompatibleDC( hdcScreen );
if( hdcColor == NULL )
{
hr = E_FAIL;
goto End;
}
SelectObject(hdcColor, iconinfo.hbmColor);
GetDIBits(hdcColor, iconinfo.hbmColor, 0, dwHeightDest,
pcrArrayColor, &bmi, DIB_RGB_COLORS);
}
// Transfer cursor image into the surface
D3DLOCKED_RECT lr;
pCursorSurface->LockRect( &lr, NULL, 0 );
pBitmap = (DWORD*)lr.pBits;
for( y = 0; y < dwHeightDest; y++ )
{
for( x = 0; x < dwWidth; x++ )
{
if (bBWCursor)
{
crColor = pcrArrayMask[dwWidth*(dwHeightDest-1-y) + x];
crMask = pcrArrayMask[dwWidth*(dwHeightSrc-1-y) + x];
}
else
{
crColor = pcrArrayColor[dwWidth*(dwHeightDest-1-y) + x];
crMask = pcrArrayMask[dwWidth*(dwHeightDest-1-y) + x];
}
if (crMask == 0)
pBitmap[dwWidth*y + x] = 0xff000000 | crColor;
else
pBitmap[dwWidth*y + x] = 0x00000000;
// It may be helpful to make the D3D cursor look slightly
// different from the Windows cursor so you can distinguish
// between the two when developing/testing code. When
// bAddWatermark is TRUE, the following code adds some
// small grey "D3D" characters to the upper-left corner of
// the D3D cursor image.
if( bAddWatermark && x < 12 && y < 5 )
{
// 11.. 11.. 11.. .... CCC0
// 1.1. ..1. 1.1. .... A2A0
// 1.1. .1.. 1.1. .... A4A0
// 1.1. ..1. 1.1. .... A2A0
// 11.. 11.. 11.. .... CCC0
const WORD wMask[5] = { 0xccc0, 0xa2a0, 0xa4a0, 0xa2a0, 0xccc0 };
if( wMask[y] & (1 << (15 - x)) )
{
pBitmap[dwWidth*y + x] |= 0xff808080;
}
}
}
}
pCursorSurface->UnlockRect();
// Set the device cursor
if( FAILED( hr = pd3dDevice->SetCursorProperties( iconinfo.xHotspot,
iconinfo.yHotspot, pCursorSurface ) ) )
{
goto End;
}
hr = S_OK;
End:
if( iconinfo.hbmMask != NULL )
DeleteObject( iconinfo.hbmMask );
if( iconinfo.hbmColor != NULL )
DeleteObject( iconinfo.hbmColor );
if( hdcScreen != NULL )
ReleaseDC( NULL, hdcScreen );
if( hdcColor != NULL )
DeleteDC( hdcColor );
if( hdcMask != NULL )
DeleteDC( hdcMask );
SAFE_DELETE_ARRAY( pcrArrayColor );
SAFE_DELETE_ARRAY( pcrArrayMask );
SAFE_RELEASE( pCursorSurface );
return hr;
}
//--------------------------------------------------------------------------------------
// Get the desktop resolution of an adapter. This isn't the same as the current resolution
// from GetAdapterDisplayMode since the device might be fullscreen
//--------------------------------------------------------------------------------------
void DXUTGetDesktopResolution( UINT AdapterOrdinal, DWORD* pdwWidth, DWORD* pdwHeight )
{
CD3DEnumeration* pd3dEnum = DXUTPrepareEnumerationObject();
CD3DEnumAdapterInfo* pAdapterInfo = pd3dEnum->GetAdapterInfo( AdapterOrdinal );
DEVMODE devMode;
ZeroMemory( &devMode, sizeof(DEVMODE) );
devMode.dmSize = sizeof(DEVMODE);
TCHAR strDeviceName[256];
strcpy(strDeviceName,pAdapterInfo->AdapterIdentifier.DeviceName);
strDeviceName[255] = 0;
EnumDisplaySettings( strDeviceName, ENUM_REGISTRY_SETTINGS, &devMode );
*pdwWidth = devMode.dmPelsWidth;
*pdwHeight = devMode.dmPelsHeight;
}