Manager.CheckDeviceFormat Method

Article
10/15/2009

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Determines whether a surface format is available as a specified resource type and can be used as a texture, depth stencil buffer, render target, or any combination of the three, on a device representing the current adapter.

Namespace: Microsoft.WindowsMobile.DirectX.Direct3D
Assembly: Microsoft.WindowsMobile.DirectX (in Microsoft.WindowsMobile.DirectX.dll)

Syntax

'Declaration
Public Shared Function CheckDeviceFormat ( _
    adapter As Integer, _
    deviceType As DeviceType, _
    adapterFormat As Format, _
    usage As Usage, _
    resourceType As ResourceType, _
    checkFormat As Format _
) As Boolean
'Usage
Dim adapter As Integer
Dim deviceType As DeviceType
Dim adapterFormat As Format
Dim usage As Usage
Dim resourceType As ResourceType
Dim checkFormat As Format
Dim returnValue As Boolean

returnValue = Manager.CheckDeviceFormat(adapter, _
    deviceType, adapterFormat, usage, _
    resourceType, checkFormat)

public static bool CheckDeviceFormat(
    int adapter,
    DeviceType deviceType,
    Format adapterFormat,
    Usage usage,
    ResourceType resourceType,
    Format checkFormat
)

public:
static bool CheckDeviceFormat(
    int adapter, 
    DeviceType deviceType, 
    Format adapterFormat, 
    Usage usage, 
    ResourceType resourceType, 
    Format checkFormat
)

static member CheckDeviceFormat : 
        adapter:int * 
        deviceType:DeviceType * 
        adapterFormat:Format * 
        usage:Usage * 
        resourceType:ResourceType * 
        checkFormat:Format -> bool

Parameters

adapter
Type: System.Int32
Ordinal number that denotes the display adapter to query. AdapterListCollection.Default is always the primary display adapter.

deviceType
Type: Microsoft.WindowsMobile.DirectX.Direct3D.DeviceType
Member of the DeviceType enumeration that identifies the device type.

adapterFormat
Type: Microsoft.WindowsMobile.DirectX.Direct3D.Format
Member of the Format enumeration that identifies the format of the display mode into which the adapter will be placed.

usage
Type: Microsoft.WindowsMobile.DirectX.Direct3D.Usage
Requested usage options for the surface. Usage options are any combination of Usage enumeration values (only a subset of the Usage values are valid for CheckDeviceFormat). For more information, see Usage .

resourceType
Type: Microsoft.WindowsMobile.DirectX.Direct3D.ResourceType
A ResourceType requested for use with the queried format.

checkFormat
Type: Microsoft.WindowsMobile.DirectX.Direct3D.Format
Member of the Format enumeration that identifies the format of the surfaces that can be used, as defined by usage.

Return Value

Type: System.Boolean
true if the method succeeds; otherwise, false.

Examples

The following code example shows how to determine whether a specific texture format is supported on a device.

' check support for a Format.A16B16R16F render target
If Not Microsoft.WindowsMobile.DirectX.Direct3D.Manager.CheckDeviceFormat(0, DeviceType.Default, Format.A1R5G5B5, Usage.RenderTarget, ResourceType.BackBuffer, Format.A1R5G5B5) Then
    MsgBox("Supported")
End If

// check support for a Format.A16B16R16F render target
if (!Microsoft.WindowsMobile.DirectX.Direct3D.Manager.CheckDeviceFormat(0, DeviceType.Default, Format.A1R5G5B5,
                                  Usage.RenderTarget, ResourceType.BackBuffer,
                                  Format.A1R5G5B5))
    MessageBox.Show("Supported");

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Compact Framework

Supported in: 3.5, 2.0