Skip to content

Latest commit

 

History

History
106 lines (72 loc) · 4.64 KB

ns-d3dkmddi-_dxgkarg_formathistorybuffer.md

File metadata and controls

106 lines (72 loc) · 4.64 KB
UID title description old-location ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos tech.root req.typenames f1_keywords topic_type api_type api_location api_name
NS:d3dkmddi._DXGKARG_FORMATHISTORYBUFFER
_DXGKARG_FORMATHISTORYBUFFER (d3dkmddi.h)
Contains info for the display miniport driver to format a history buffer.
display\dxgkarg_formathistorybuffer.htm
05/10/2018
DXGKARG_FORMATHISTORYBUFFER structure
DXGKARG_FORMATHISTORYBUFFER, DXGKARG_FORMATHISTORYBUFFER structure [Display Devices], _DXGKARG_FORMATHISTORYBUFFER, d3dkmddi/DXGKARG_FORMATHISTORYBUFFER, display.dxgkarg_formathistorybuffer
d3dkmddi.h
D3dkmddi.h
Windows
Windows 8.1,WDDM 1.3 and later
Windows Server 2012 R2
Windows
display
DXGKARG_FORMATHISTORYBUFFER
_DXGKARG_FORMATHISTORYBUFFER
d3dkmddi/_DXGKARG_FORMATHISTORYBUFFER
DXGKARG_FORMATHISTORYBUFFER
d3dkmddi/DXGKARG_FORMATHISTORYBUFFER
APIRef
kbSyntax
HeaderDef
D3dkmddi.h
_DXGKARG_FORMATHISTORYBUFFER
DXGKARG_FORMATHISTORYBUFFER

_DXGKARG_FORMATHISTORYBUFFER structure

-description

Contains info for the display miniport driver to format a history buffer.

-struct-fields

-field pHistoryBuffer

A pointer to the unformatted DXGK_HISTORY_BUFFER history buffer that was populated by the GPU.

-field HistoryBufferSize

The size, in bytes, of the buffer pointed to by pHistoryBuffer.

-field pFormattedBuffer

A pointer to a segment of non-paged system memory that the driver uses to store time stamp info that it derives from the provided unformatted history buffer.

The buffer pointed to by pFormattedBuffer should be managed as a large array of time stamps of precision specified by Precision. The buffer should not contain any header info that already exists in the original history buffer.

-field FormattedBufferSize

The size, in bytes, of the buffer pointed to by pFormattedBuffer. The driver should ensure that it doesn't write data beyond this buffer size.

-field NumTimestamps

The number of time stamps. On completion of a call to the DxgkDdiFormatHistoryBuffer function, the driver should set this value to the number of time stamps that are written to the formatted buffer pointed to by pFormattedBuffer.

Note that the number of time stamps that will be in the formatted output buffer won't be known until the driver completes the formatted buffer pointed to by pFormattedBuffer.

-field Precision

A DXGKARG_HISTORYBUFFERPRECISION structure that the driver fills with info on the precision of the time stamps that will be logged to the Event Tracing for Windows (ETW) facility.

The value of the DXGKARG_HISTORYBUFFERPRECISION.PrecisionBits member cannot be zero.

-field Offset

On input to a call to the DxgkDdiFormatHistoryBuffer function, the value of this member is the offset to the first time stamp at which formatting should start. On completion of the function call, the driver should set the value to zero if it successfully formatted all the time stamps in the history buffer.

If nonzero, the driver could not format all the time stamps in the history buffer without filling the formatted buffer. In this case, the value represents the offset that should be continued from in the next function call.

-remarks

The driver should obtain time stamp entries and the number of usable time stamps from the header of the provided history buffer. Any additional data that the driver needs for calculations should be stored in private data.

-see-also

DXGKARG_HISTORYBUFFERPRECISION

DXGK_HISTORY_BUFFER

DxgkDdiFormatHistoryBuffer