Struct D2D1RenderTargetProperties

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

Implements
Inherited Members
Namespace: JeremyAnsel.DirectX.D2D1
Assembly: JeremyAnsel.DirectX.D2D1.dll
Syntax
public struct D2D1RenderTargetProperties : IEquatable<D2D1RenderTargetProperties>

Constructors

| Edit this page View Source

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

| Edit this page View Source

Default

Gets default properties.

Declaration
public static D2D1RenderTargetProperties Default { get; }
Property Value
Type Description
D2D1RenderTargetProperties
| Edit this page View Source

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
| Edit this page View Source

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
| Edit this page View Source

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
| Edit this page View Source

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
| Edit this page View Source

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
| Edit this page View Source

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

| Edit this page View Source

Equals(D2D1RenderTargetProperties)

Declaration
public readonly bool Equals(D2D1RenderTargetProperties other)
Parameters
Type Name Description
D2D1RenderTargetProperties other
Returns
Type Description
bool
| Edit this page View Source

Equals(object?)

Declaration
public override readonly bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
| Edit this page View Source

GetHashCode()

Declaration
public override readonly int GetHashCode()
Returns
Type Description
int
Overrides
| Edit this page View Source

NativeReadFrom(nint)

Declaration
public static D2D1RenderTargetProperties NativeReadFrom(nint buffer)
Parameters
Type Name Description
nint buffer
Returns
Type Description
D2D1RenderTargetProperties
| Edit this page View Source

NativeReadFrom(nint, Span<D2D1RenderTargetProperties>)

Declaration
public static void NativeReadFrom(nint buffer, Span<D2D1RenderTargetProperties> objects)
Parameters
Type Name Description
nint buffer
Span<D2D1RenderTargetProperties> objects
| Edit this page View Source

NativeRequiredSize()

Declaration
public static int NativeRequiredSize()
Returns
Type Description
int
| Edit this page View Source

NativeRequiredSize(int)

Declaration
public static int NativeRequiredSize(int count)
Parameters
Type Name Description
int count
Returns
Type Description
int
| Edit this page View Source

NativeWriteTo(nint, in D2D1RenderTargetProperties)

Declaration
public static void NativeWriteTo(nint buffer, in D2D1RenderTargetProperties obj)
Parameters
Type Name Description
nint buffer
D2D1RenderTargetProperties obj
| Edit this page View Source

NativeWriteTo(nint, ReadOnlySpan<D2D1RenderTargetProperties>)

Declaration
public static void NativeWriteTo(nint buffer, ReadOnlySpan<D2D1RenderTargetProperties> objects)
Parameters
Type Name Description
nint buffer
ReadOnlySpan<D2D1RenderTargetProperties> objects

Operators

| Edit this page View Source

operator ==(D2D1RenderTargetProperties, D2D1RenderTargetProperties)

Declaration
public static bool operator ==(D2D1RenderTargetProperties left, D2D1RenderTargetProperties right)
Parameters
Type Name Description
D2D1RenderTargetProperties left
D2D1RenderTargetProperties right
Returns
Type Description
bool
| Edit this page View Source

operator !=(D2D1RenderTargetProperties, D2D1RenderTargetProperties)

Declaration
public static bool operator !=(D2D1RenderTargetProperties left, D2D1RenderTargetProperties right)
Parameters
Type Name Description
D2D1RenderTargetProperties left
D2D1RenderTargetProperties right
Returns
Type Description
bool

Implements