IDebugShaderRequest::BeginDebugShader method

Requests to start a shader debugging session for the specified pipeline stage, pixel/vertex if applicable, event, and frame.

Syntax

HRESULT BeginDebugShader(
   IPixErrorCallback *     errorCallback,
   EventID                 eventID,
   DWORD                   frameNumber,
   DWORD                   vertex,
   Point2D                 pixel,
   PipeLineStages          stage,
   PixelHistoryOperation * pPixelHistory,
   DWORD *                 pDevice
);

Parameters

errorCallback
The address of a callback for errors that might occur during debugging.

eventID
The specified event.

frameNumber
The specified frame.

vertex
The specified vertex. Only applies when debugging a vertex shader.

pixel
The specified pixel. Only applies when debugging a pixel shader.

stage
The specified pipeline stage.

pPixelHistory
The address of pixel history results used for finding the associated pixel to debug. Only applies when debugging a pixel shader.

pDevice
The address to pass to the debug engine for communicating with this debug session (debug engine readprocessmemory on this address).

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

See also

IDebugShaderRequest