DXDiagnostics Class


DXDiagnostics Class

DXDiagnostics class contains static properties that define which diagnostics features of the DXEngine will be turned on.

Inheritance Hierarchy

SystemObject
Ab3d.DirectXDXDiagnostics

Namespace: Ab3d.DirectX
Assembly: Ab3d.DXEngine (in Ab3d.DXEngine.dll) Version: 7.0.8865.1045

Syntax

Copy

public static class DXDiagnostics

The DXDiagnostics type exposes the following members.

Properties

	Name	Description
	CreateDebugDirectXDevice	Gets or sets a static Boolean that specifies if the DirectX device is created with debug flat that enabled DirectX debug layer. To use debug layer the Windows SDK or DirectX SDK must be installed. To check if the device was created with the debug layer, see the IsDebugDevice property after the DXDevice was created.
	CurrentDXView	Gets or sets a DXView (or DXViewportView) that is currently shown. This value is used by DXEngineSnoop to find the DXView control. The value is stored in a private WeakReference to prevent rooting the object by a static filed.
	IsCollectingStatistics	Gets or sets a static Boolean that specifies if DXEngine is collecting rendering statistics to RenderingStatistics class that can be read from Statistics property.
	IsD3DPerformanceEventGroupingEnabled	Gets or sets a Boolean that specifies if D3DPerf_BeginEvent and D3DPerf_EndEvent are called when running each rendering step. This can be used to Graphics debugger to simplify rendering debugging. This requires using DirectX layer (CreateDebugDirectXDevice. When using SharpDX 3.1 or newer you need to add reference to SharpDX.Desktop. Default value is false.
	IsResourceTrackingEnabled	Gets or sets a Boolean that specifies if DirectX resources construction and disposal is tracked with DXEngine. After resource tracing is enabled, you can get the report by calling GetTrackedResourcesReport(Boolean) method. Default value if false.
	IsWritingLogToOutput	Gets or sets a Boolean that specifies if log messages are written to Visual Studio Output window.
	LogAction	Gets or sets an action that is called when a Warning or Error log message is written to log.
	LogFileName	Gets to sets a string that specifies the file name that is used to store log messages. By default this property is set to null. This prevents writing log messages to file. You can also set this property to "desktop" and this will created the "DXEngine.log" on the user's desktop folder.
	LogLevel	Gets or sets a log level that specifies which DXEngine messages are written to Output Window and to LogFileName file (if specified). Default value is Error.
	ReportLiveDeviceObjectsOnDispose	Gets or sets a static Boolean that specifies if ReportLiveDeviceObjects method is called when the DirectX device is disposed. This method reports all live (not disposed) DirectX objects to the Visual Studio Output window. CreateDebugDirectXDevice must be set to true and DirectX debug layer must be enabled for this property to work. See remarks for more info.

Top

Methods

	Name	Description
	CaptureNextFrame	CaptureNextFrame programmatically captures the next rendered frame with Visual Studio Graphics Debugging. This works for DirectXOverlay and DirectXImage presentation type. Capture is supported on Windows 8.1 and newer operating system, with installed Windows Software Development Kit (SDK) and only when the Visual Studio Graphics Debugging is running. The method returns true when capture is supported. If capture is not supported, false is returned.
	GetTrackedResourcesReport	Gets a formated string with tracked resources (resource tracking must be enabled with IsResourceTrackingEnabled before calling this method or null is returned).
	IsCaptureFrameSupported	Returns true if programmatical capture of frame into Visual Studio Graphics Debugging is supported. Capture is supported on Windows 8.1 and newer operating system, with installed Windows Software Development Kit (SDK) and only when the Visual Studio Graphics Debugging is running.

Top

Reference

Ab3d.DirectX Namespace