Struct D3D11DepthStencilViewDesc

Specifies the subresources of a texture that are accessible from a depth-stencil view.

Implements

IEquatable<D3D11DepthStencilViewDesc>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.D3D11

Assembly: JeremyAnsel.DirectX.D3D11.dll

Syntax

public struct D3D11DepthStencilViewDesc : IEquatable<D3D11DepthStencilViewDesc>

Constructors

D3D11DepthStencilViewDesc(D3D11DsvDimension)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11DsvDimension viewDimension)

Parameters

Type	Name	Description
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.

D3D11DepthStencilViewDesc(D3D11DsvDimension, DxgiFormat)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11DsvDimension viewDimension, DxgiFormat format)

Parameters

Type	Name	Description
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.

D3D11DepthStencilViewDesc(D3D11DsvDimension, DxgiFormat, uint)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice)

Parameters

Type	Name	Description
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.

D3D11DepthStencilViewDesc(D3D11DsvDimension, DxgiFormat, uint, uint)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firstArraySlice)

Parameters

Type	Name	Description
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firstArraySlice	The index of the first element to use in an array of elements.

D3D11DepthStencilViewDesc(D3D11DsvDimension, DxgiFormat, uint, uint, uint)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firstArraySlice, uint arraySize)

Parameters

Type	Name	Description
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firstArraySlice	The index of the first element to use in an array of elements.
uint	arraySize	The number of elements in the array.

D3D11DepthStencilViewDesc(D3D11DsvDimension, DxgiFormat, uint, uint, uint, D3D11DepthStencilViewOptions)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firstArraySlice, uint arraySize, D3D11DepthStencilViewOptions options)

Parameters

Type	Name	Description
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firstArraySlice	The index of the first element to use in an array of elements.
uint	arraySize	The number of elements in the array.
D3D11DepthStencilViewOptions	options	A value that describes whether the texture is read only.

D3D11DepthStencilViewDesc(D3D11Texture1D, D3D11DsvDimension)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture1D texture, D3D11DsvDimension viewDimension)

Parameters

Type	Name	Description
D3D11Texture1D	texture	A 1D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.

D3D11DepthStencilViewDesc(D3D11Texture1D, D3D11DsvDimension, DxgiFormat)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture1D texture, D3D11DsvDimension viewDimension, DxgiFormat format)

Parameters

Type	Name	Description
D3D11Texture1D	texture	A 1D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.

D3D11DepthStencilViewDesc(D3D11Texture1D, D3D11DsvDimension, DxgiFormat, uint)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture1D texture, D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice)

Parameters

Type	Name	Description
D3D11Texture1D	texture	A 1D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.

D3D11DepthStencilViewDesc(D3D11Texture1D, D3D11DsvDimension, DxgiFormat, uint, uint)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture1D texture, D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firstArraySlice)

Parameters

Type	Name	Description
D3D11Texture1D	texture	A 1D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firstArraySlice	The index of the first element to use in an array of elements.

D3D11DepthStencilViewDesc(D3D11Texture1D, D3D11DsvDimension, DxgiFormat, uint, uint, uint)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture1D texture, D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firstArraySlice, uint arraySize)

Parameters

Type	Name	Description
D3D11Texture1D	texture	A 1D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firstArraySlice	The index of the first element to use in an array of elements.
uint	arraySize	The number of elements in the array.

D3D11DepthStencilViewDesc(D3D11Texture1D, D3D11DsvDimension, DxgiFormat, uint, uint, uint, D3D11DepthStencilViewOptions)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture1D texture, D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firstArraySlice, uint arraySize, D3D11DepthStencilViewOptions options)

Parameters

Type	Name	Description
D3D11Texture1D	texture	A 1D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firstArraySlice	The index of the first element to use in an array of elements.
uint	arraySize	The number of elements in the array.
D3D11DepthStencilViewOptions	options	A value that describes whether the texture is read only.

D3D11DepthStencilViewDesc(D3D11Texture2D, D3D11DsvDimension)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture2D texture, D3D11DsvDimension viewDimension)

Parameters

Type	Name	Description
D3D11Texture2D	texture	A 2D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.

D3D11DepthStencilViewDesc(D3D11Texture2D, D3D11DsvDimension, DxgiFormat)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture2D texture, D3D11DsvDimension viewDimension, DxgiFormat format)

Parameters

Type	Name	Description
D3D11Texture2D	texture	A 2D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.

D3D11DepthStencilViewDesc(D3D11Texture2D, D3D11DsvDimension, DxgiFormat, uint)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture2D texture, D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice)

Parameters

Type	Name	Description
D3D11Texture2D	texture	A 2D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.

D3D11DepthStencilViewDesc(D3D11Texture2D, D3D11DsvDimension, DxgiFormat, uint, uint)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture2D texture, D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firstArraySlice)

Parameters

Type	Name	Description
D3D11Texture2D	texture	A 2D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firstArraySlice	The index of the first element to use in an array of elements.

D3D11DepthStencilViewDesc(D3D11Texture2D, D3D11DsvDimension, DxgiFormat, uint, uint, uint)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture2D texture, D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firstArraySlice, uint arraySize)

Parameters

Type	Name	Description
D3D11Texture2D	texture	A 2D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firstArraySlice	The index of the first element to use in an array of elements.
uint	arraySize	The number of elements in the array.

D3D11DepthStencilViewDesc(D3D11Texture2D, D3D11DsvDimension, DxgiFormat, uint, uint, uint, D3D11DepthStencilViewOptions)

Initializes a new instance of the D3D11DepthStencilViewDesc struct.

Declaration

public D3D11DepthStencilViewDesc(D3D11Texture2D texture, D3D11DsvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firstArraySlice, uint arraySize, D3D11DepthStencilViewOptions options)

Parameters

Type	Name	Description
D3D11Texture2D	texture	A 2D texture.
D3D11DsvDimension	viewDimension	The depth-stencil type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firstArraySlice	The index of the first element to use in an array of elements.
uint	arraySize	The number of elements in the array.
D3D11DepthStencilViewOptions	options	A value that describes whether the texture is read only.

Properties

Format

Gets or sets the resource data format.

Declaration

public DxgiFormat Format { get; set; }

Property Value

Type	Description
DxgiFormat

Options

Gets or sets a value that describes whether the texture is read only.

Declaration

public D3D11DepthStencilViewOptions Options { get; set; }

Property Value

Type	Description
D3D11DepthStencilViewOptions

Texture1D

Gets or sets a 1D texture subresource.

Declaration

public D3D11Texture1DDsv Texture1D { get; set; }

Property Value

Type	Description
D3D11Texture1DDsv

Texture1DArray

Gets or sets an array of 1D texture subresources.

Declaration

public D3D11Texture1DArrayDsv Texture1DArray { get; set; }

Property Value

Type	Description
D3D11Texture1DArrayDsv

Texture2D

Gets or sets a 2D texture subresource.

Declaration

public D3D11Texture2DDsv Texture2D { get; set; }

Property Value

Type	Description
D3D11Texture2DDsv

Texture2DArray

Gets or sets an array of 2D texture subresources.

Declaration

public D3D11Texture2DArrayDsv Texture2DArray { get; set; }

Property Value

Type	Description
D3D11Texture2DArrayDsv

Texture2DMs

Gets or sets a multisampled 2D texture.

Declaration

public D3D11Texture2DMsDsv Texture2DMs { get; set; }

Property Value

Type	Description
D3D11Texture2DMsDsv

Texture2DMsArray

Gets or sets an array of multisampled 2D textures.

Declaration

public D3D11Texture2DMsArrayDsv Texture2DMsArray { get; set; }

Property Value

Type	Description
D3D11Texture2DMsArrayDsv

ViewDimension

Gets or sets the type of resource. Specifies how a depth-stencil resource will be accessed; the value is stored in the union in this structure.

Declaration

public D3D11DsvDimension ViewDimension { get; set; }

Property Value

Type	Description
D3D11DsvDimension

Methods

Equals(D3D11DepthStencilViewDesc)

Determines whether the specified object is equal to the current object.

Declaration

public bool Equals(D3D11DepthStencilViewDesc other)

Parameters

Type	Name	Description
D3D11DepthStencilViewDesc	other	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

Operators

operator ==(D3D11DepthStencilViewDesc, D3D11DepthStencilViewDesc)

Compares two D3D11DepthStencilViewDesc objects. The result specifies whether the values of the two objects are equal.

Declaration

public static bool operator ==(D3D11DepthStencilViewDesc left, D3D11DepthStencilViewDesc right)

Parameters

Type	Name	Description
D3D11DepthStencilViewDesc	left	The left D3D11DepthStencilViewDesc to compare.
D3D11DepthStencilViewDesc	right	The right D3D11DepthStencilViewDesc to compare.

Returns

Type	Description
bool	true if the values of left and right are equal; otherwise, false.

operator !=(D3D11DepthStencilViewDesc, D3D11DepthStencilViewDesc)

Compares two D3D11DepthStencilViewDesc objects. The result specifies whether the values of the two objects are unequal.

Declaration

public static bool operator !=(D3D11DepthStencilViewDesc left, D3D11DepthStencilViewDesc right)

Parameters

Type	Name	Description
D3D11DepthStencilViewDesc	left	The left D3D11DepthStencilViewDesc to compare.
D3D11DepthStencilViewDesc	right	The right D3D11DepthStencilViewDesc to compare.

Returns

Type	Description
bool	true if the values of left and right differ; otherwise, false.

Implements

IEquatable<T>