Hardware Dev Center

Collapse the table of content
Expand the table of content
Expand Minimize

CheckMultisampleQualityLevels routine

The CheckMultisampleQualityLevels function retrieves the number of quality levels that the device supports for the specified number of samples.

Syntax


PFND3D10DDI_CHECKMULTISAMPLEQUALITYLEVELS CheckMultisampleQualityLevels;

VOID APIENTRY CheckMultisampleQualityLevels(
  _In_  D3D10DDI_HDEVICE hDevice,
  _In_  DXGI_FORMAT      Format,
  _In_  UINT             SampleCount,
  _Out_ UINT             *pNumQualityLevels
)
{ ... }

Parameters

hDevice [in]

A handle to the display device (graphics context).

Format [in]

A DXGI_FORMAT-typed value that indicates the render-target format that the check is performed for.

SampleCount [in]

The number of samples to retrieve the quality levels for.

pNumQualityLevels [out]

A pointer to a variable that receives the number of quality levels that the device supports for the specified number of samples.

Return value

None

The driver can use the pfnSetErrorCb callback function to set an error code. The driver can set E_INVALIDARG if the format in the Format parameter does not exist or the pNumQualityLevels parameter is NULL.

Remarks

If the device does not support multiple sampling with the number of samples that is specified in the SampleCount parameter, the user-mode display driver should return 0 in the variable that the pNumQualityLevels parameter points to.

When the driver returns 1 or more in the variable that pNumQualityLevels points to, the driver indicates the number of device-specific sampling variations that are available with the given sample count. For example, if the driver returns 3, quality levels 0, 1, and 2 can be used to create resources with the given sample count. The device manufacturer defines these quality levels, which the Microsoft Direct3D runtime cannot query. However, different quality levels at a fixed sample count might refer to different spatial layouts of the sample locations or different methods of resolving.

If the driver receives 1 in SampleCount, the driver always returns 1 in the variable that pNumQualityLevels points to.

If the driver receives 0 or greater than 32 in SampleCount, the driver always returns 0 in the variable that pNumQualityLevels points to.

Requirements

Target platform

Desktop

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3d10umddi.h (include D3d10umddi.h)

See also

D3D10DDI_DEVICEFUNCS
pfnSetErrorCb

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft