RenderStateManager.StencilFunction Property

Article
12/12/2007

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
'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);
}

/** @property */
public Compare get_StencilFunction ()

/** @property */
public void set_StencilFunction (Compare value)

public function get StencilFunction () : Compare

public function set StencilFunction (value : Compare)

Not applicable.

Property Value

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.

Platforms

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Compact Framework

Supported in: 2.0

Share via