Microsoft DirectX 9.0 SDK Update (October 2004)

Device.DepthStencilSurface Property

Language:

Note: This documentation is preliminary and is subject to change.

Retrieves or sets the depth stencil surface owned by the Device object.

Definition

Visual Basic .NET Public Property DepthStencilSurface As Surface
C# public Surface DepthStencilSurface { get; set; }
Managed C++ public: __property Surface* get_DepthStencilSurface();
public: __property void set_DepthStencilSurface(Surface*);
JScript .NET public function get DepthStencilSurface() : Surface
public function set DepthStencilSurface(Surface);

Property Value

Microsoft.DirectX.Direct3D.Surface . Returns a Surface object that represents the depth stencil surface. If no depth stencil buffer is associated with the device, the return value is null.

Setting this value to null disables the depth stencil operation.

This property is read/write. 

Remarks

The following restrictions apply when using this property.

These restrictions are validated only when using the debug runtime when any of the Device drawing methods are called.

Cube textures differ from other surfaces in that they are collections of surfaces. To set a new depth stencil surface with a cube texture, choose an individual face using CubeTexture.GetCubeMapSurface, and pass the resulting surface to this property.

Exceptions
NotFoundException Occurs if the device does not have a depth stencil buffer associated with it.
InvalidCallException Occurs if the method call is invalid. For example, a parameter may have an invalid value.


© 2004 Microsoft Corporation. All rights reserved. Terms of use.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center