RenderStateManager.StencilFunction Property

Articolo
10/15/2009

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

Gets or sets the comparison function for the stencil test.

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

Syntax

'Declaration
Public Property StencilFunction As Compare
    Get
    Set
'Usage
Dim instance As RenderStateManager
Dim value As Compare

value = instance.StencilFunction

instance.StencilFunction = value

public Compare StencilFunction { get; set; }

public:
property Compare StencilFunction {
    Compare get ();
    void set (Compare value);
}

member StencilFunction : Compare with get, set

Property Value

Type: Microsoft.WindowsMobile.DirectX.Direct3D.Compare
A value a Compare that represents the comparison function to set or retrieve. The default is Always.

Remarks

The comparison function is used to compare the reference value to a stencil buffer entry. This comparison applies only to the bits in the reference value and stencil buffer entry that are set in the stencil mask by this property. If the comparison is true, the stencil test passes.

.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

Condividi tramite