PFND3D10DDI_CREATESAMPLER callback function (d3d10umddi.h)

Article
02/22/2024

The CreateSampler function creates a sampler.

Syntax

PFND3D10DDI_CREATESAMPLER Pfnd3d10ddiCreatesampler;

void Pfnd3d10ddiCreatesampler(
  D3D10DDI_HDEVICE unnamedParam1,
  const D3D10_DDI_SAMPLER_DESC *unnamedParam2,
  D3D10DDI_HSAMPLER unnamedParam3,
  D3D10DDI_HRTSAMPLER unnamedParam4
)
{...}

Parameters

unnamedParam1

hDevice [in]

A handle to the display device (graphics context).

unnamedParam2

pSamplerDesc [in]

A pointer to a D3D10_DDI_SAMPLER_DESC structure that describes the parameters that the user-mode display driver uses to create a sampler.

unnamedParam3

hSampler [in]

A handle to the driver's private data for the sampler. The driver returns the size, in bytes, of the memory region that the Microsoft Direct3D runtime must allocate for the private data from a call to the driver's CalcPrivateSamplerSize function. The handle is really just a pointer to a region of memory, the size of which the driver requested. The driver uses this region of memory to store internal data structures that are related to its sampler object.

unnamedParam4

hRTSampler [in]

A handle to the sampler that the driver should use anytime it calls back into the Direct3D runtime.

Return value

None

Remarks

The driver can use the pfnSetErrorCb callback function to set an error code.

The driver can pass E_OUTOFMEMORY (if the driver runs out of memory) or D3DDDIERR_DEVICEREMOVED (if the device has been removed) in a call to the pfnSetErrorCb function. The Direct3D runtime will determine that any other errors are critical. If the driver passes any errors, including D3DDDIERR_DEVICEREMOVED, the Direct3D runtime will determine that the handle is invalid; therefore, the runtime will not call the DestroySampler function to destroy the handle that the hSampler parameter specifies.

The user-mode display driver is not required to create more than 4,096 unique instances of sampler objects on a device at a time.

Requirements

Requirement	Value
Minimum supported client	Available in Windows Vista and later versions of the Windows operating systems.
Target Platform	Desktop
Header	d3d10umddi.h (include D3d10umddi.h)