Direct3D Diagnostics Capture Interfaces

The following interfaces are declared in vspixengine.h.

In this section

TopicDescription

INewFramesCallback

Callback from engine indicating that it is done parsing any new frames added to the log.

IPixCancelableRequest

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.

IPixErrorCallback

Callback from engine to handle errors.

IPixProgressCallback

Callback from engine to return progress.

IPixelHistoryCallback

Not used. Formerly a callback to return all pixel history results at once.

IPixelHistoryRequest

Not used. Formerly a request for pixel history primitives and intersections together.

IPixelHistoryCallback2

Callback to return pixel history intersections (draw call level) and primitives (triangle level) in two different results.

IPixelHistoryRequest2

Request for pixel history intersections and primitives separately.

IFrameBufferCallback

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.

IFrameBufferRequest

Callback to request a render target.

IDebugShaderRequest

Not used. Formerly a request to start debugging a shader.

IDebugShaderCallback

Callback to return the instructions generated from creating a shader trace.

IDebugShaderRequest2

Request to start debugging a shader. This request contains two parts: generate a trace, and debug a trace.

IDebugShaderCancel

Request to cancel generating a shader trace.

IDebugLiveShaderRequest

Reserved. Request to live debug a shader.

IGenericBufferDataCallback

Callback to return the contents of an object in XML form.

IGenericBufferDataRequest

Request for the contents of an object in XML form.

IBufferObjectDataCallback

Callback to return the contents of an object in buffer form for those that support it (buffers, textures).

IBufferObjectDataRequest

Request for the contents of an object in buffer form for those that support it.

ITextureCallback

Callback to write a texture as a DDS file.

ITextureRequest

Request for a texture to be written as a DDS file.

ITileRequest

Request for a tiled texture to be written as a DDS file.

IPipeLineStagesCallback

Not used. Formerly a callback for pipeline stages data.

IPipeLineStagesCallback2

Not used. Formerly a callback for pipeline stages data.

IPipeLineStagesCallback3

Callback for pipeline stages data.

IPipeLineStagesRequest

Not used. Formerly a request for pipeline stages data.

IPipeLineStagesRequest2

Not used. Formerly a request for pipeline stages data.

IPipeLineStagesRequest3

Request for pipeline stages data.

ICallStackCallback

Callback to return callstack data.

ICallStackRequest

Request for callstack data.

ISymbolSettings

Passes symbol server information to the desktop capture engine.

ISourceFileInfoCallback

Callback to return source file info from a callstack.

ISourceFileInfoRequest

Request for source file info from a callstack.

IRunExperimentCallback

Callback to return errors from the engine during capture.

IRunActionCallback

Not used. Formerly a callback to respond to "capture frame" event.

IRunActionRequest

Not used. Formerly a request for things like "capture frame" event.

IFrameListCallback

Callback to return the list of frames with their event id and frame number.

IFrameListRequest

Request for the list of frames with their event id and frame number.

ISummaryCallback

Callback to return summary information (displayed in the properties window).

ISummaryRequest

Request for summary information.

IMeshCallback

Callback to return a buffer containing the mesh of a pipeline stage.

IMeshRequest

Request for a buffer containing the mesh of a pipeline stage.

IFrameEventsCallback

Callback to return the list of events in a frame.

ISingleEventRequest

Not used.

IFrameEventsRequest

Request for returning the list of events in a frame.

IObjectTableCallback

Callback to return object table data.

IObjectTableRequest

Request for object table data.

IFileIOCallback

Callback to save or end the experiment. Indicates file save is done.

IPixEngine2

Extensions to the original IPixEngine interface.

IPixEngine

Original interface for communicating data about a vsglog .

IPeerToPeerEngine

Interface for remote communicating data about a vsglog.

IServerConnectionCallback

Not used.

IPixEngine3

Extensions to the IPixEngine2 interface.

IPixEngine4

Extensions to the IPIxEngine3 interface.

IUpdateObjectCallback

Callback to update the contents of an object.

IUpdateObject

Request for updating the contents of an object.

IPixEngine5Callbacks

Callbacks used for viewing textures.

IPixEngine5

Extensions to the IPixEngine4 interface containing additions for viewing textures.

IPixEngine6

Extensions to the IPixEngine5 interface containing additions for determining remote engine version.

IVersionCallback

Callback to return the versions of all the interfaces supported. This allows the consumer to be out of sync with the capture engine.

IPixEngine7

Extensions to the IPixEngine6 interface containing additions around versioning.

IOfflineAnalysisCallback

Callback to returns offline analysis data.

IOfflineAnalysisRequest

Request for offline analysis data.

IOfflineAnalysisCacheCallback

Callback to return information on whether an offline request is cached or not.

IOfflineAnalysisCacheRequest

Requests for information on whether an offline request is cached or not.

IStatusCallback

Not used.

IPixEngineSingleton

Determines if the engine supports a singleton instance or not.

IPixEngineWin10

Determines if the engine is from Windows 10.

 

Direct3D Diagnostics Capture Interface Reference