GrapeCity.Documents

GrapeCity.Documents.DX.Direct2D.RenderTargetProperties

Struct RenderTargetProperties

Namespace: GrapeCity.Documents.DX.Direct2D

Assembly: GcDocs.DX.Windows.dll

D2D1_RENDER_TARGET_PROPERTIES

public struct RenderTargetProperties

Inherited Members: System.ValueType.Equals(object)

System.ValueType.GetHashCode()

System.ValueType.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Constructors

RenderTargetProperties(PixelFormat)

Initializes a new instance of the RenderTargetProperties struct.

public RenderTargetProperties(PixelFormat pixelFormat)

Parameters

pixelFormat PixelFormat: The pixel format and alpha mode of the render target. You can use the {{D2D1::PixelFormat}} function to create a pixel format that specifies that Direct2D should select the pixel format and alpha mode for you. For a list of pixel formats and alpha modes supported by each render target, see {{Supported Pixel Formats and Alpha Modes}}.

RenderTargetProperties(RenderTargetType, PixelFormat, float, float, RenderTargetUsage, FeatureLevel)

Initializes a new instance of the RenderTargetProperties struct.

public RenderTargetProperties(RenderTargetType type, PixelFormat pixelFormat, float dpiX, float dpiY, RenderTargetUsage usage, FeatureLevel minLevel)

Parameters

type RenderTargetType: A value that specifies whether the render target should force hardware or software rendering. A value of Default specifies that the render target should use hardware rendering if it is available; otherwise, it uses software rendering. Note that WIC bitmap render targets do not support hardware rendering.
pixelFormat PixelFormat: The pixel format and alpha mode of the render target. You can use the {{D2D1::PixelFormat}} function to create a pixel format that specifies that Direct2D should select the pixel format and alpha mode for you. For a list of pixel formats and alpha modes supported by each render target, see {{Supported Pixel Formats and Alpha Modes}}.
dpiX float: The horizontal DPI of the render target. To use the default DPI, set dpiX and dpiY to 0. For more information, see the Remarks section.
dpiY float: The vertical DPI of the render target. To use the default DPI, set dpiX and dpiY to 0. For more information, see the Remarks section.
usage RenderTargetUsage: A value that specifies how the render target is remoted and whether it should be GDI-compatible. Set to None to create a render target that is not compatible with GDI and uses Direct3D command-stream remoting if it is available.
minLevel FeatureLevel: A value that specifies the minimum Direct3D feature level required for hardware rendering. If the specified minimum level is not available, the render target uses software rendering if the type member is set to Default; if type is set to to D2D1_RENDER_TARGET_TYPE_HARDWARE, render target creation fails. A value of Level_DEFAULT indicates that Direct2D should determine whether the Direct3D feature level of the device is adequate. This field is used only when creating WindowRenderTarget and DeviceContextRenderTarget objects.