Goblin - A Platform for 3D AR and VR Applications

Framework Members

Framework overview

Public Static Fields

DefaultSizeHeight 
DefaultSizeWidth 
TrueIntPtr 

Public Instance Constructors

Framework Constructor Constructor, init data here

Public Instance Properties

BackBufferSurfaceDescription Returns the back buffer surface description
CanAutomaticallyChangeMonitorDetermines if the adapter can automatically change monitors
ClientRectangle Client rectangle size
Device Returns the device current in use for the framework
DeviceCaps Returns the device capabilities
DeviceSettings Return the device settings of the current device. If no device exists yet, then return blank device settings
DeviceStats Device statistics
ExitCode Exit code from the framework
FPS Frames per second application is running at
FrameStats Frame statistics
IsD3DSettingsDialogShowing Returns whether the settings is showing
IsIgnoringSizeChangesShould the framework ignore size changes?
IsNotifiedOnMouseMoveShould the framework also notify for mouse moves
IsOverridingFullScreenShould the framework override and start fullscreen?
IsWindowed Return if windowed in the current device. If no device exists yet, return false
OverridingAdapterOrdinalShould the framework override the monitor to use?
PresentParameters Return the present params of the current device. If no device exists yet, then return blank present params
Window Get the current window used for rendering
WindowClientRectangle Client rectangle size
WindowDeviceFullscreen Get the current window used for full screen rendering
WindowDeviceWindowed Get the current window used for windowed rendering
WindowFocus Get the current focus window

Public Instance Methods

CloseWindowWill close the window
CreateDeviceOverloaded. Creates a Direct3D device. If CreateWindow or SetWindow has not already been called, it will call CreateWindow with default parameters. Instead of calling this, you can call SetDevice or CreateDeviceFromSettings
CreateDeviceFromSettingsOverloaded. Tells the framework to change to a device created from the passed in device settings If CreateWindow() has not already been called, it will call it with the default parameters. Instead of calling this, you can call CreateDevice() or SetDevice()
CreateWindowOverloaded. Creates a window with the specified title, icon, menu, and starting position. If Init hasn't been called, this will call with default params. Instead of calling this, you can call SetWindow to use an existing window
DisplayErrorMessage Display an custom error msg box
DisposeShut down the sample framework
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
Initialize 
KillTimerKills an already created timer
LoadFirstIconFromResourceWill try to load the first icon from the resources
MainLoop Handles app's message loop and rendering when idle. If CreateDevice*() or SetDevice() has not already been called, it will call CreateDevice() with the default parameters.
Pause Pauses time or rendering. Keeps a ref count so pausing can be layered
Render3DEnvironment 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() If you're not using MainLoop, consider using Render3DEnvironment
Reset3DEnvironment 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
ResetStateResets the state associated with the sample framework
SetCallbackInterface 
SetConstantFrameTimeOverloaded. Allows to set constant time per frame
SetCursorSettingsHandles setting up the cursor settings for fullscreen
SetDevice Passes a previously created Direct3D device for use by the framework. If CreateWindow() has not already been called, it will call it with the default parameters. Instead of calling this, you can call CreateDevice() or CreateDeviceFromSettings()
SetDeviceCreationInterface 
SetKeyboardCallback 
SetMouseCallback 
SetTimerAdds a timer to the list of timers for the application
SetWindow Sets a previously created window for the framework to use. If Init has not already been called, it will call it with default parameters. Instead of calling this you can call CreateWindow to create a new window.
SetWndProcCallback 
ShowSettingsDialog Show the settings dialog, and create if needed
ToggleFullscreen Toggle between full screen and windowed
ToggleReference Toggle between Hardware and Reference
ToString (inherited from Object) Returns a String that represents the current Object.

Public Instance Events

DeviceCreatedThe event fired for when the device is created
DeviceLostThe event fired for when the device is lost
DeviceResetThe event fired for when the device is reset
DisposingThe event fired for disposing of the device

See Also

Framework Class | Microsoft.Samples.DirectX.UtilityToolkit Namespace