Struct D2D1RenderTargetProperties

Contains rendering options (hardware or software), pixel format, DPI information, remoting options, and Direct3D support requirements for a render target.

Implements

IEquatable<D2D1RenderTargetProperties>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.D2D1

Assembly: JeremyAnsel.DirectX.D2D1.dll

Syntax

public struct D2D1RenderTargetProperties : IEquatable<D2D1RenderTargetProperties>

Constructors

D2D1RenderTargetProperties(D2D1RenderTargetType, D2D1PixelFormat, float, float, D2D1RenderTargetUsages, D2D1FeatureLevel)

Initializes a new instance of the D2D1RenderTargetProperties struct.

Declaration

public D2D1RenderTargetProperties(D2D1RenderTargetType renderTargetType, D2D1PixelFormat pixelFormat, float dpiX, float dpiY, D2D1RenderTargetUsages usage, D2D1FeatureLevel minLevel)

Parameters

Type	Name	Description
D2D1RenderTargetType	renderTargetType	A value that specifies whether the render target should force hardware or software rendering.
D2D1PixelFormat	pixelFormat	The pixel format and alpha mode of the render target.
float	dpiX	The horizontal DPI of the render target. To use the default DPI, set dpiX and dpiY to 0.
float	dpiY	The vertical DPI of the render target. To use the default DPI, set dpiX and dpiY to 0.
D2D1RenderTargetUsages	usage	A value that specifies how the render target is remoted and whether it should be GDI-compatible.
D2D1FeatureLevel	minLevel	A value that specifies the minimum Direct3D feature level required for hardware rendering.

Properties

Default

Gets default properties.

Declaration

public static D2D1RenderTargetProperties Default { get; }

Property Value

Type	Description
D2D1RenderTargetProperties

DpiX

Gets or sets the horizontal DPI of the render target. To use the default DPI, set dpiX and dpiY to 0.

Declaration

public float DpiX { get; set; }

Property Value

Type	Description
float

DpiY

Gets or sets the vertical DPI of the render target. To use the default DPI, set dpiX and dpiY to 0.

Declaration

public float DpiY { get; set; }

Property Value

Type	Description
float

MinLevel

Gets or sets a value that specifies the minimum Direct3D feature level required for hardware rendering.

Declaration

public D2D1FeatureLevel MinLevel { get; set; }

Property Value

Type	Description
D2D1FeatureLevel

PixelFormat

Gets or sets the pixel format and alpha mode of the render target.

Declaration

public D2D1PixelFormat PixelFormat { get; set; }

Property Value

Type	Description
D2D1PixelFormat

RenderTargetType

Gets or sets a value that specifies whether the render target should force hardware or software rendering.

Declaration

public D2D1RenderTargetType RenderTargetType { get; set; }

Property Value

Type	Description
D2D1RenderTargetType

Usage

Gets or sets a value that specifies how the render target is remoted and whether it should be GDI-compatible.

Declaration

public D2D1RenderTargetUsages Usage { get; set; }

Property Value

Type	Description
D2D1RenderTargetUsages

Methods

Equals(D2D1RenderTargetProperties)

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

Declaration

public bool Equals(D2D1RenderTargetProperties other)

Parameters

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

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

Declaration

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

Parameters

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

Returns

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

operator !=(D2D1RenderTargetProperties, D2D1RenderTargetProperties)

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

Declaration

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

Parameters

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

Returns

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

Implements

IEquatable<T>