PIXEndCapture
PIXBeginCapture によって開始された、プログラムによって制御されるキャプチャを停止します。
構文
HRESULT PIXEndCapture(
BOOL discard
)
パラメーター
discard
型: BOOL
キャプチャを破棄するかどうかを示します。
- discard が TRUE の場合、キャプチャされたデータは破棄され、キャプチャは PIX に表示されません。
- discard が FALSE の場合、キャプチャされたデータは保存され、PIX は結果として得られたキャプチャを表示します。
discard パラメーターは、検索条件を満たさなかったキャプチャを破棄するのに役立ちます。 たとえば、PIXBeginCapture と PIXEndCapture を使用して、あらかじめ定義された時間範囲に収まる関数の呼び出しをキャプチャーすることができます。 その範囲に収まる関数の呼び出しのキャプチャのみを表示することもできます。
戻り値
型: HRESULT
キャプチャが正常に完了したかどうかを示します。 成功した場合は、S_OK が返されます。 この操作は非同期です。キャプチャが完全に停止されるまで、E_PENDING を返します。 結果が E_PENDING である間は、タイトルを終了したり、新しいキャプチャを開始したりしてはいけません。
解説
PIXBeginCapture を使用して PIX キャプチャを開始します。
PIX キャプチャを開始するための要件の詳細については、PIXBeginCapture の「解説」セクションを参照してください。
次の C++ サンプルでは、PIX キャプチャを開始および終了する方法を示します。
//
// timing capture
//
PIXCaptureParameters captureParams = {};
captureParams.TimingCaptureParameters.CaptureGpuTiming = TRUE;
captureParams.TimingCaptureParameters.CaptureCallstacks = TRUE;
captureParams.TimingCaptureParameters.CaptureCpuSamples = TRUE;
captureParams.TimingCaptureParameters.CpuSamplesPerSecond = 4000;
captureParams.TimingCaptureParameters.CaptureStorage = PIXCaptureParameters::Memory;
captureParams.TimingCaptureParameters.FileName = wstrFilename;
captureParams.TimingCaptureParameters.MaximumToolingMemorySizeMb = 4096;
XSF_ERROR_IF_FAILED(PIXBeginCapture(PIX_CAPTURE_TIMING, &captureParams));
while (PIXEndCapture(FALSE) == E_PENDING)
{
// Keep running
}
要件
ヘッダー: pix3.h
ライブラリ: pixevt.lib
サポートされているプラットフォーム: Xbox One ファミリー本体、Xbox Series 本体