Framework Class

Language: Visual BasicC#C++JScript(Show All)

---

Contains properties and methods that provide helper functionality for 3-D graphics in applications such as the Microsoft DirectX 9.0 for Managed Code sample applications included in the DirectX software development kit (SDK).

Definition

Visual Basic	Public Class Framework     Inherits MarshalByRefObject     Implements IDisposable
C#	public class Framework : MarshalByRefObject, IDisposable
C++	public ref class Framework : MarshalByRefObject, IDisposable
JScript	public class Framework extends MarshalByRefObject implements IDisposable

Members Table

The following table lists the members exposed by the object. Click a tab on the left to choose the type of member you want to view.

Events

Event	Description
DeviceCreated	Occurs when the Direct3D Device object is created.
DeviceLost	Occurs when the Direct3D Device object is lost.
DeviceReset	Occurs when the Direct3D Device object is reset.
Disposing	Occurs when the Framework object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime.

Fields

Field	Description
DefaultSizeHeight	Retrieves the default window height, in pixels, when the application starts.
DefaultSizeWidth	Retrieves the default window width, in pixels, when the application starts.
TrueIntPtr	Retrieves the Boolean value of true as a System.IntPtr .

Methods

Method	Description
CloseWindow	Closes the current application window.
CreateDevice	Creates a Microsoft Direct3D device.
CreateDeviceFromSettings	Tells the framework to change to a device created from settings described in a DeviceSettings object.
CreateWindow	Creates a window for the application.
DisplayErrorMessage	Displays a custom error message box.
Dispose	Immediately releases the unmanaged resources used by the Framework object.
Finalize	Allows the Framework object to free resources before it is destroyed by the garbage collector.
Initialize	Initializes the sample framework.
KillTimer	Uninstalls an existing timer.
LoadFirstIconFromResource	Attempts to load the first icon from the application's resources.
MainLoop	Starts the main execution loop of the sample framework.
Pause	Sets the paused state of the sample framework internal timer and/or rendering process.
Render3DEnviroment	Renders the 3-D environment and updates application and device parameters.
Reset3DEnviroment	Resets the 3-D environment.
ResetState	Resets the sample framework state to its initial default state, and all previous framework state changes are lost.
SetCallbackInterface	Sets the interface that the sample framework will use to call into samples.
SetConstantFrameTime	Enables or disables a constant frame time.
SetCursorSettings	Sets options for cursor usage in full-screen mode.
SetDevice	Sets an existing Direct3D Device for use by the sample framework.
SetDeviceCreationInterface	Sets the interface that the framework will use to determine if a device is acceptable.
SetKeyboardCallback	Sets the keyboard event callback function.
SetMouseCallback	Sets the mouse event callback function.
SetTimer	Adds a timer to the list of timers for the application.
SetWindow	Sets a previously created window for the framework to use.
SetWndProcCallback	Sets the WndProcCallback delegate to use in the sample framework.
ShowSettingsDialog	Indicates whether the sample framework's device settings dialog box is currently showing.
ToggleFullscreen	Switches the application between windowed and full-screen modes.
ToggleReference	Switches the application between hardware abstraction layer (HAL) and reference devices.

Properties

Property	Description
BackBufferSurfaceDescription	Retrieves a SurfaceDescription structure that describes the back buffer on the current adapter.
CanAutomaticallyChangeMonitor	Sets or retrieves if the current adapter can automatically change monitors.
Device	Retrieves the Device object currently used by the framework.
DeviceCaps	Retrieves a Caps structure that describes the capabilities of the current device.
DeviceSettings	Retrieves the DeviceSettings object that contains the device settings for the current Device object used by the framework.
DeviceStats	Retrieves a string containing the current device type, vertex processing behavior, and device name.
ExitCode	Retrieves the sample framework exit code.
FPS	Retrieves the number of frames per second the application is currently running.
FrameStats	Retrieves a string containing the current number of frames per second, resolution, back buffer format, and depth stencil format.
IsD3DSettingsDialogShowing	Retrieves whether the settings dialog is displayed.
IsNotifiedOnMouseMove	Retrieves whether the framework should notify for mouse moves.
IsOverridingFullScreen	Retrieves whether the framework should override and start fullscreen.
IsWindowed	Retrieves whether the current device is windowed.
PresentParameters	Retrieves the PresentParameters object for the current Device object.
Window	Retrieves the handle of the window used for rendering.
WindowClientRectangle	Retrieves the size and location of the window that is rendering.
WindowDeviceFullscreen	Retrieves the handle of the window used for fullscreen rendering.
WindowDeviceWindowed	Retrieves the handle of the window used for windowed rendering.
WindowFocus	Retrieves the handle of the window that currently has focus.

Inheritance Hierarchy

Object

MarshalByRefObject

Framework

Class Information

Namespace	Framework
Assembly	()
Strong Name	,  Version=,  Culture=,  PublicKeyToken=

---

Send comments about this topic to Microsoft. © Microsoft Corporation. All rights reserved.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center