Struct D3D11RenderTargetViewDesc

Specifies the subresources from a resource that are accessible using a render-target view.

Implements

IEquatable<D3D11RenderTargetViewDesc>

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 D3D11RenderTargetViewDesc : IEquatable<D3D11RenderTargetViewDesc>

Constructors

D3D11RenderTargetViewDesc(D3D11Buffer, DxgiFormat, uint, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Buffer buffer, DxgiFormat format, uint firstElement, uint numElements)

Parameters

Type	Name	Description
D3D11Buffer	buffer	A buffer.
DxgiFormat	format	The viewing format.
uint	firstElement	The buffer and the first element to access.
uint	numElements	The total number of elements in the view.

D3D11RenderTargetViewDesc(D3D11RtvDimension)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11RtvDimension viewDimension)

Parameters

Type	Name	Description
D3D11RtvDimension	viewDimension	The resource type of the view.

D3D11RenderTargetViewDesc(D3D11RtvDimension, DxgiFormat)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11RtvDimension viewDimension, DxgiFormat format)

Parameters

Type	Name	Description
D3D11RtvDimension	viewDimension	The resource type of the view.
DxgiFormat	format	The viewing format.

D3D11RenderTargetViewDesc(D3D11RtvDimension, DxgiFormat, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11RtvDimension viewDimension, DxgiFormat format, uint mipSlice)

Parameters

Type	Name	Description
D3D11RtvDimension	viewDimension	The resource type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.

D3D11RenderTargetViewDesc(D3D11RtvDimension, DxgiFormat, uint, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11RtvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firtArraySlice)

Parameters

Type	Name	Description
D3D11RtvDimension	viewDimension	The resource type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firtArraySlice	The index of the first element to use in an array of elements.

D3D11RenderTargetViewDesc(D3D11RtvDimension, DxgiFormat, uint, uint, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11RtvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firtArraySlice, uint arraySize)

Parameters

Type	Name	Description
D3D11RtvDimension	viewDimension	The resource type of the view.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firtArraySlice	The index of the first element to use in an array of elements.
uint	arraySize	The number of elements in the array.

D3D11RenderTargetViewDesc(D3D11Texture1D, D3D11RtvDimension)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture1D texture, D3D11RtvDimension viewDimension)

Parameters

Type	Name	Description
D3D11Texture1D	texture	A 1D texture.
D3D11RtvDimension	viewDimension	The resource type of the view.

D3D11RenderTargetViewDesc(D3D11Texture1D, D3D11RtvDimension, DxgiFormat)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture1D texture, D3D11RtvDimension viewDimension, DxgiFormat format)

Parameters

Type	Name	Description
D3D11Texture1D	texture	A 1D texture.
D3D11RtvDimension	viewDimension	The resource type of the view.
DxgiFormat	format	The viewing format.

D3D11RenderTargetViewDesc(D3D11Texture1D, D3D11RtvDimension, DxgiFormat, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture1D texture, D3D11RtvDimension viewDimension, DxgiFormat format, uint mipSlice)

Parameters

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

D3D11RenderTargetViewDesc(D3D11Texture1D, D3D11RtvDimension, DxgiFormat, uint, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture1D texture, D3D11RtvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firtArraySlice)

Parameters

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

D3D11RenderTargetViewDesc(D3D11Texture1D, D3D11RtvDimension, DxgiFormat, uint, uint, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture1D texture, D3D11RtvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firtArraySlice, uint arraySize)

Parameters

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

D3D11RenderTargetViewDesc(D3D11Texture2D, D3D11RtvDimension)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture2D texture, D3D11RtvDimension viewDimension)

Parameters

Type	Name	Description
D3D11Texture2D	texture	A 2D texture.
D3D11RtvDimension	viewDimension	The resource type of the view.

D3D11RenderTargetViewDesc(D3D11Texture2D, D3D11RtvDimension, DxgiFormat)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture2D texture, D3D11RtvDimension viewDimension, DxgiFormat format)

Parameters

Type	Name	Description
D3D11Texture2D	texture	A 2D texture.
D3D11RtvDimension	viewDimension	The resource type of the view.
DxgiFormat	format	The viewing format.

D3D11RenderTargetViewDesc(D3D11Texture2D, D3D11RtvDimension, DxgiFormat, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture2D texture, D3D11RtvDimension viewDimension, DxgiFormat format, uint mipSlice)

Parameters

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

D3D11RenderTargetViewDesc(D3D11Texture2D, D3D11RtvDimension, DxgiFormat, uint, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture2D texture, D3D11RtvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firtArraySlice)

Parameters

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

D3D11RenderTargetViewDesc(D3D11Texture2D, D3D11RtvDimension, DxgiFormat, uint, uint, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture2D texture, D3D11RtvDimension viewDimension, DxgiFormat format, uint mipSlice, uint firtArraySlice, uint arraySize)

Parameters

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

D3D11RenderTargetViewDesc(D3D11Texture3D)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture3D texture)

Parameters

Type	Name	Description
D3D11Texture3D	texture	A 3D texture.

D3D11RenderTargetViewDesc(D3D11Texture3D, DxgiFormat)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture3D texture, DxgiFormat format)

Parameters

Type	Name	Description
D3D11Texture3D	texture	A 3D texture.
DxgiFormat	format	The viewing format.

D3D11RenderTargetViewDesc(D3D11Texture3D, DxgiFormat, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture3D texture, DxgiFormat format, uint mipSlice)

Parameters

Type	Name	Description
D3D11Texture3D	texture	A 3D texture.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.

D3D11RenderTargetViewDesc(D3D11Texture3D, DxgiFormat, uint, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture3D texture, DxgiFormat format, uint mipSlice, uint firtWSlice)

Parameters

Type	Name	Description
D3D11Texture3D	texture	A 3D texture.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firtWSlice	The first depth level to use.

D3D11RenderTargetViewDesc(D3D11Texture3D, DxgiFormat, uint, uint, uint)

Initializes a new instance of the D3D11RenderTargetViewDesc struct.

Declaration

public D3D11RenderTargetViewDesc(D3D11Texture3D texture, DxgiFormat format, uint mipSlice, uint firtWSlice, uint wsize)

Parameters

Type	Name	Description
D3D11Texture3D	texture	A 3D texture.
DxgiFormat	format	The viewing format.
uint	mipSlice	The index of the mipmap level to use mip slice.
uint	firtWSlice	The first depth level to use.
uint	wsize	The number of depth levels to use in the render-target view.

Properties

Buffer

Gets or sets a value indicating which buffer elements can be accessed.

Declaration

public D3D11BufferRtv Buffer { get; set; }

Property Value

Type	Description
D3D11BufferRtv

Format

Gets or sets the data format.

Declaration

public DxgiFormat Format { get; set; }

Property Value

Type	Description
DxgiFormat

Texture1D

Gets or sets the subresources in a 1D texture that can be accessed.

Declaration

public D3D11Texture1DRtv Texture1D { get; set; }

Property Value

Type	Description
D3D11Texture1DRtv

Texture1DArray

Gets or sets the subresources in a 1D texture array that can be accessed.

Declaration

public D3D11Texture1DArrayRtv Texture1DArray { get; set; }

Property Value

Type	Description
D3D11Texture1DArrayRtv

Texture2D

Gets or sets the subresources in a 2D texture that can be accessed.

Declaration

public D3D11Texture2DRtv Texture2D { get; set; }

Property Value

Type	Description
D3D11Texture2DRtv

Texture2DArray

Gets or sets the subresources in a 2D texture array that can be accessed.

Declaration

public D3D11Texture2DArrayRtv Texture2DArray { get; set; }

Property Value

Type	Description
D3D11Texture2DArrayRtv

Texture2DMs

Gets or sets a single subresource because a multisampled 2D texture only contains one subresource.

Declaration

public D3D11Texture2DMsRtv Texture2DMs { get; set; }

Property Value

Type	Description
D3D11Texture2DMsRtv

Texture2DMsArray

Gets or sets the subresources in a multisampled 2D texture array that can be accessed.

Declaration

public D3D11Texture2DMsArrayRtv Texture2DMsArray { get; set; }

Property Value

Type	Description
D3D11Texture2DMsArrayRtv

Texture3D

Gets or sets the subresources in a 3D texture that can be accessed.

Declaration

public D3D11Texture3DRtv Texture3D { get; set; }

Property Value

Type	Description
D3D11Texture3DRtv

ViewDimension

Gets or sets the resource type.

Declaration

public D3D11RtvDimension ViewDimension { get; set; }

Property Value

Type	Description
D3D11RtvDimension

Methods

Equals(D3D11RenderTargetViewDesc)

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

Declaration

public bool Equals(D3D11RenderTargetViewDesc other)

Parameters

Type	Name	Description
D3D11RenderTargetViewDesc	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 ==(D3D11RenderTargetViewDesc, D3D11RenderTargetViewDesc)

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

Declaration

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

Parameters

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

Returns

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

operator !=(D3D11RenderTargetViewDesc, D3D11RenderTargetViewDesc)

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

Declaration

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

Parameters

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

Returns

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

Implements

IEquatable<T>