Expand Minimize

CreateSampler routine

The CreateSampler function creates a sampler.

Syntax


PFND3D10DDI_CREATESAMPLER CreateSampler;

VOID APIENTRY CreateSampler(
  _In_       D3D10DDI_HDEVICE       hDevice,
  _In_ const D3D10_DDI_SAMPLER_DESC *pSamplerDesc,
  _In_       D3D10DDI_HSAMPLER      hSampler,
  _In_       D3D10DDI_HRTSAMPLER    hRTSampler
)
{ ... }

Parameters

hDevice [in]

A handle to the display device (graphics context).

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.

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.

hRTSampler [in]

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

Return value

None

The driver can use the pfnSetErrorCb callback function to set an error code. For more information about setting error codes, see the following Remarks section.

Remarks

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

Target platform

Desktop

Version

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

Header

D3d10umddi.h (include D3d10umddi.h)

See also

CalcPrivateSamplerSize
D3D10_DDI_SAMPLER_DESC
D3D10DDI_DEVICEFUNCS
DestroySampler
pfnSetErrorCb

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft