Manager.CheckDepthStencilMatch 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 depth stencil format is compatible with a render target format in a particular display mode.

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

Syntax

'Declaration
Public Shared Function CheckDepthStencilMatch ( _
    adapter As Integer, _
    deviceType As DeviceType, _
    adapterFormat As Format, _
    renderTargetFormat As Format, _
    depthStencilFormat As DepthFormat _
) As Boolean
'Usage
Dim adapter As Integer
Dim deviceType As DeviceType
Dim adapterFormat As Format
Dim renderTargetFormat As Format
Dim depthStencilFormat As DepthFormat
Dim returnValue As Boolean

returnValue = Manager.CheckDepthStencilMatch(adapter, _
    deviceType, adapterFormat, renderTargetFormat, _
    depthStencilFormat)

public static bool CheckDepthStencilMatch(
    int adapter,
    DeviceType deviceType,
    Format adapterFormat,
    Format renderTargetFormat,
    DepthFormat depthStencilFormat
)

public:
static bool CheckDepthStencilMatch(
    int adapter, 
    DeviceType deviceType, 
    Format adapterFormat, 
    Format renderTargetFormat, 
    DepthFormat depthStencilFormat
)

static member CheckDepthStencilMatch : 
        adapter:int * 
        deviceType:DeviceType * 
        adapterFormat:Format * 
        renderTargetFormat:Format * 
        depthStencilFormat:DepthFormat -> 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.

renderTargetFormat
Type: Microsoft.WindowsMobile.DirectX.Direct3D.Format
Member of the Format enumeration that identifies the format of the render target surface to be tested.

depthStencilFormat
Type: Microsoft.WindowsMobile.DirectX.Direct3D.DepthFormat
Member of the DepthFormat enumeration that identifies the format of the depth stencil surface to be tested.

Return Value

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

Remarks

The CheckDepthStencilMatch method enables applications to work with hardware that requires that certain depth formats work only with certain render target formats.

Examples

The following code example shows how to use CheckDeviceFormat method to validate a depth stencil format.

' 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