Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This method is used to determine if a specified pixel format is valid for a specified usage on a specified device. This includes formats for color buffers, depth buffers, and all other Direct3D Mobile resource types except vertex and index buffers.

Syntax 

HRESULT CheckDeviceFormat(
  UINT 
Adapter,
  D3DMDEVTYPE 
DeviceType,
  D3DMFORMAT 
AdapterFormat,
  ULONG 
Usage,
  D3DMRESOURCETYPE 
RType,
  D3DMFORMAT 
CheckFormat
);

Parameters

Adapter

[in] A value that indicates which device to provide information for. For possible values, see D3DMADAPTER Values.

DeviceType

[in] A D3DMDEVTYPEenumeration value that specifies the type of device.

AdapterFormat

[in] A legacy parameter provided for compatibility with older versions of Direct3D on Windows-based desktop systems. You must set this parameter to the D3DMFORMATenumeration value for the current format of the display adapter.

Usage

[in] A combination of D3DMUSAGE valuesthat specifies the desired use for the resource specified by RType.

RType

[in] A D3DMRESOURCETYPEenumeration value that specifies the type of resource to test the device for.

CheckFormat

[in] A D3DMFORMATenumeration value that specifies the pixel format to test the device for.

Return Value

This method returns D3DM_OK if the format is supported and D3DMERR_NOTAVAILABLE if it is not supported.

In addition, this method may also return D3DMERR_INVALIDCALL if it fails. For more information, see D3DMERR Values.

Requirements

Header d3dm.h
Library D3dm.lib, D3dmguid.lib
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also