DXUTInit
Microsoft DirectX 9.0 SDK Update (October 2004)

DXUTInit Function


Initializes the sample framework.

Syntax

HRESULT DXUTInit(      

    BOOL bParseCommandLine,     BOOL bHandleDefaultHotkeys,     BOOL bShowMsgBoxOnError );

Parameters

bParseCommandLine
[in] If TRUE, the sample framework checks for command-line arguments. The application performs the following actions based upon the entered command-line arguments.

Command-line ArgumentAction
-adapter:#Forces the application to use this adapter ordinal. Fails if the adapter ordinal does not exist.
-fullscreenStarts in full-screen mode.
-windowedStarts in windowed mode.
-startx:#For windowed mode, sets the x-coordinate of the window position to the value of #.
-starty:#For windowed mode, sets the y-coordinate of the window position to the value of #.
-height:#Sets the window height to the value of #. For full-screen mode, the sample framework picks the closest possible supported mode.
-width:#Sets the window width to the value of #. For full-screen mode, the sample framework picks the closest possible supported mode.
-forcehalForces the application to use a hardware abstraction layer (HAL) device type, D3DDEVTYPE_HAL. Fails if a HAL device does not exist.
-forcehwvpForces the application to use hardware vertex processing. Fails if the device does not support this mode.
-forcepurehwvpForces the application to use pure hardware vertex processing. Fails if the device does not support this mode.
-forcerefForces the application to use a reference device type, D3DDEVTYPE_REF. Fails if a reference device does not exist.
-forceswvpForces the application to use software vertex processing.
-constantframetimeUses a constant frame time.
-noerrormsgboxesPrevents the display of message boxes generated by the framework, allowing the application to be run without user interaction.
-quitafterframe:#Forces the application to quit after frame #.

Command-line arguments take precedence over options set by the application when a Microsoft Direct3D device is first created, but they are ignored afterward to allow the user to interactively change the settings.

The default value of this parameter is TRUE.

bHandleDefaultHotkeys
[in] If TRUE, the sample framework automatically responds to certain keyboard input. The following table lists the keyboard input that is handled by default.

KeyAction
ALT+ENTERToggles between full-screen and windowed modes.
ESCExits the application.
F2Prompts the user to select a new rendering device or display mode.
F3Toggles between HAL and reference devices.
F8Toggles between wireframe and rendered views.
PAUSEPauses the application.

The default value of this parameter is TRUE. If FALSE, the application is free to respond to these keystrokes as desired.

bShowMsgBoxOnError
[in] If TRUE, the sample framework displays a message box if there is an error condition. The default value of this parameter is TRUE.

Return Value

If the function succeeds, the return value is S_OK.

If the function fails, the return value can be one of the error codes in DXUTERR.

Remarks

If this function has not been called before DXUTCreateWindow or DXUTSetWindow, the framework will automatically call this function using the default parameter values.

Function Information

Headerdxut.h
Import libraryNone
Minimum operating systems Windows 98

See Also

Initializing the Sample Framework, Device Types, Processing Vertex Data, DXUTCreateWindow, DXUTSetWindow, Error Messages


© 2004 Microsoft Corporation. All rights reserved.
Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center.