Direct3D Diagnostics Capture Interfaces
The following interfaces are declared in vspixengine.h.
In this section
| Topic | Description |
|---|---|
Callback from engine indicating that it is done parsing any new frames added to the log. | |
Base of any request that can be canceled. Canceled requests can only be canceled if they are still in the queue, so a cancelation may be ignored. | |
Callback from engine to handle errors. | |
Callback from engine to return progress. | |
Not used. Formerly a callback to return all pixel history results at once. | |
Not used. Formerly a request for pixel history primitives and intersections together. | |
Callback to return pixel history intersections (draw call level) and primitives (triangle level) in two different results. | |
Request for pixel history intersections and primitives separately. | |
Callback to return a render target. The format of the returned render target is R8G8B8A8_UNORM regardless of the format of the in-engine rendertarget. | |
Callback to request a render target. | |
Not used. Formerly a request to start debugging a shader. | |
Callback to return the instructions generated from creating a shader trace. | |
Request to start debugging a shader. This request contains two parts: generate a trace, and debug a trace. | |
Request to cancel generating a shader trace. | |
Reserved. Request to live debug a shader. | |
Callback to return the contents of an object in XML form. | |
Request for the contents of an object in XML form. | |
Callback to return the contents of an object in buffer form for those that support it (buffers, textures). | |
Request for the contents of an object in buffer form for those that support it. | |
Callback to write a texture as a DDS file. | |
Request for a texture to be written as a DDS file. | |
Request for a tiled texture to be written as a DDS file. | |
Not used. Formerly a callback for pipeline stages data. | |
Not used. Formerly a callback for pipeline stages data. | |
Callback for pipeline stages data. | |
Not used. Formerly a request for pipeline stages data. | |
Not used. Formerly a request for pipeline stages data. | |
Request for pipeline stages data. | |
Callback to return callstack data. | |
Request for callstack data. | |
Passes symbol server information to the desktop capture engine. | |
Callback to return source file info from a callstack. | |
Request for source file info from a callstack. | |
Callback to return errors from the engine during capture. | |
Not used. Formerly a callback to respond to "capture frame" event. | |
Not used. Formerly a request for things like "capture frame" event. | |
Callback to return the list of frames with their event id and frame number. | |
Request for the list of frames with their event id and frame number. | |
Callback to return summary information (displayed in the properties window). | |
Request for summary information. | |
Callback to return a buffer containing the mesh of a pipeline stage. | |
Request for a buffer containing the mesh of a pipeline stage. | |
Callback to return the list of events in a frame. | |
Not used. | |
Request for returning the list of events in a frame. | |
Callback to return object table data. | |
Request for object table data. | |
Callback to save or end the experiment. Indicates file save is done. | |
Extensions to the original IPixEngine interface. | |
Original interface for communicating data about a vsglog . | |
Interface for remote communicating data about a vsglog. | |
Not used. | |
Extensions to the IPixEngine2 interface. | |
Extensions to the IPIxEngine3 interface. | |
Callback to update the contents of an object. | |
Request for updating the contents of an object. | |
Callbacks used for viewing textures. | |
Extensions to the IPixEngine4 interface containing additions for viewing textures. | |
Extensions to the IPixEngine5 interface containing additions for determining remote engine version. | |
Callback to return the versions of all the interfaces supported. This allows the consumer to be out of sync with the capture engine. | |
Extensions to the IPixEngine6 interface containing additions around versioning. | |
Callback to returns offline analysis data. | |
Request for offline analysis data. | |
Callback to return information on whether an offline request is cached or not. | |
Requests for information on whether an offline request is cached or not. | |
Not used. | |
Determines if the engine supports a singleton instance or not. | |
Determines if the engine is from Windows 10. |
Related topics
Direct3D Diagnostics Capture Interface Reference
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for