RenderTargetFormat Structure

Describes the size and format of a texture or a render target.

Namespace: DigitalRune.Graphics
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)

Syntax

C++

Copy

public struct RenderTargetFormat : IEquatable<RenderTargetFormat>

Public Structure RenderTargetFormat
	Implements IEquatable(Of RenderTargetFormat)

public value class RenderTargetFormat : IEquatable<RenderTargetFormat>

[<SealedAttribute>]
type RenderTargetFormat =  
    struct
        interface IEquatable<RenderTargetFormat>
    end

The RenderTargetFormat type exposes the following members.

Constructors

	Name	Description
	RenderTargetFormat(RenderTarget2D)	Initializes a new instance of the RenderTargetFormat struct.
	RenderTargetFormat(RenderTargetCube)	Initializes a new instance of the RenderTargetFormat struct.
	RenderTargetFormat(Texture2D)	Initializes a new instance of the RenderTargetFormat struct.
	RenderTargetFormat(TextureCube)	Initializes a new instance of the RenderTargetFormat struct.
	RenderTargetFormat(NullableInt32, NullableInt32, NullableBoolean, NullableSurfaceFormat, NullableDepthFormat)	Initializes a new instance of the RenderTargetFormat struct.
	RenderTargetFormat(NullableInt32, NullableInt32, NullableBoolean, NullableSurfaceFormat, NullableDepthFormat, NullableInt32, NullableRenderTargetUsage)	Initializes a new instance of the RenderTargetFormat struct.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to this instance. (Overrides ValueTypeEquals(Object).)
	Equals(RenderTargetFormat)	Indicates whether the current object is equal to another object of the same type.
	GetHashCode	Returns a hash code for this instance. (Overrides ValueTypeGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsCompatibleWith	Determines whether this instance is compatible with the specified render target format.
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Operators

	Name	Description
	Equality	Compares RenderTargetFormat to determine whether they are the same.
	Inequality	Compares RenderTargetFormat to determine whether they are different.

Top

Properties

	Name	Description
	DepthStencilFormat	Gets or sets the depth/stencil buffer format.
	Height	Gets or sets the height (in pixels).
	Mipmap	Gets or sets a value indicating whether the texture uses mipmapping.
	MultiSampleCount	Gets or sets the number of sample locations during multisampling.
	RenderTargetUsage	Gets or sets the render target usage.
	SurfaceFormat	Gets or sets the surface format.
	Width	Gets or sets the width (in pixels).

Top

Remarks

All properties are Nullable. A value of means that the property is undefined. For example, if Width is , then it is undefined and the user may choose any suitable width.

A RenderTargetFormat can be also be used to describe cube maps. In this case the Width defines the size of the cube map and Height should be ignored because cube map faces are always quadratic.

Reference

DigitalRune.Graphics Namespace