[]
        
(Showing Draft Content)

GrapeCity.Documents.DX.Direct2D.BitmapRenderTarget

Class BitmapRenderTarget

Namespace
GrapeCity.Documents.DX.Direct2D
Assembly
GcDocs.DX.Windows.dll

ID2D1BitmapRenderTarget

[Guid("2cd90695-12e2-11dc-9fed-001143a055f9")]
public class BitmapRenderTarget : RenderTarget, IDisposable, IUnknown
Inheritance
object
BitmapRenderTarget
Implements
System.IDisposable
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()

Constructors

BitmapRenderTarget(IntPtr)

Initializes a new instance of the BitmapRenderTarget class.

public BitmapRenderTarget(IntPtr nativePtr)

Parameters

nativePtr System.IntPtr

The native pointer.

Methods

Create(RenderTarget, CompatibleRenderTargetOptions, Size2F)

Creates a bitmap render target for use during intermediate offscreen drawing that is compatible with the current render target with same pixel size and pixel format.

public static BitmapRenderTarget Create(RenderTarget renderTarget, CompatibleRenderTargetOptions options, Size2F desiredSize)

Parameters

renderTarget RenderTarget

an instance of RenderTarget

options CompatibleRenderTargetOptions

A value that specifies whether the new render target must be compatible with GDI.

desiredSize Size2F

The desired size of the new render target in device-independent pixels if it should be different from the original render target. For more information, see the Remarks section.

Returns

BitmapRenderTarget

Create(RenderTarget, CompatibleRenderTargetOptions, PixelFormat?)

Creates a bitmap render target for use during intermediate offscreen drawing that is compatible with the current render target with same size and pixel size.

public static BitmapRenderTarget Create(RenderTarget renderTarget, CompatibleRenderTargetOptions options, PixelFormat? desiredFormat)

Parameters

renderTarget RenderTarget

an instance of RenderTarget

options CompatibleRenderTargetOptions

A value that specifies whether the new render target must be compatible with GDI.

desiredFormat PixelFormat?

The desired pixel format and alpha mode of the new render target. If the pixel format is set to DXGI_FORMAT_UNKNOWN, the new render target uses the same pixel format as the original render target. If the alpha mode is Unknown, the alpha mode of the new render target defaults to D2D1_ALPHA_MODE_PREMULTIPLIED. For information about supported pixel formats, see {{Supported Pixel Formats and Alpha Modes}}.

Returns

BitmapRenderTarget

Create(RenderTarget, CompatibleRenderTargetOptions, Size2F?, Size2L?, PixelFormat?)

Creates a bitmap render target for use during intermediate offscreen drawing that is compatible with the current render target.

public static BitmapRenderTarget Create(RenderTarget renderTarget, CompatibleRenderTargetOptions options, Size2F? desiredSize, Size2L? desiredPixelSize, PixelFormat? desiredFormat)

Parameters

renderTarget RenderTarget

an instance of RenderTarget

options CompatibleRenderTargetOptions

A value that specifies whether the new render target must be compatible with GDI.

desiredSize Size2F?

The desired size of the new render target in device-independent pixels if it should be different from the original render target. For more information, see the Remarks section.

desiredPixelSize Size2L?

The desired size of the new render target in pixels if it should be different from the original render target. For more information, see the Remarks section.

desiredFormat PixelFormat?

The desired pixel format and alpha mode of the new render target. If the pixel format is set to DXGI_FORMAT_UNKNOWN, the new render target uses the same pixel format as the original render target. If the alpha mode is Unknown, the alpha mode of the new render target defaults to D2D1_ALPHA_MODE_PREMULTIPLIED. For information about supported pixel formats, see {{Supported Pixel Formats and Alpha Modes}}.

Returns

BitmapRenderTarget

Remarks

The pixel size and DPI of the new render target can be altered by specifying values for desiredSize or desiredPixelSize: If desiredSize is specified but desiredPixelSize is not, the pixel size is computed from the desired size using the parent target DPI. If the desiredSize maps to a integer-pixel size, the DPI of the compatible render target is the same as the DPI of the parent target. If desiredSize maps to a fractional-pixel size, the pixel size is rounded up to the nearest integer and the DPI for the compatible render target is slightly higher than the DPI of the parent render target. In all cases, the coordinate (desiredSize.width, desiredSize.height) maps to the lower-right corner of the compatible render target.If the desiredPixelSize is specified and desiredSize is not, the DPI of the new render target is the same as the original render target.If both desiredSize and desiredPixelSize are specified, the DPI of the new render target is computed to account for the difference in scale.If neither desiredSize nor desiredPixelSize is specified, the new render target size and DPI match the original render target.

Create(RenderTarget, CompatibleRenderTargetOptions)

Creates a bitmap render target for use during intermediate offscreen drawing that is compatible with the current render targe with same size, pixel size and pixel format.

public static BitmapRenderTarget Create(RenderTarget renderTarget, CompatibleRenderTargetOptions options)

Parameters

renderTarget RenderTarget

an instance of RenderTarget

options CompatibleRenderTargetOptions

A value that specifies whether the new render target must be compatible with GDI.

Returns

BitmapRenderTarget

GetBitmap()

HRESULT ID2D1BitmapRenderTarget::GetBitmap([Out] ID2D1Bitmap** bitmap)

public Bitmap GetBitmap()

Returns

Bitmap

Operators

explicit operator BitmapRenderTarget(IntPtr)

Performs an explicit conversion from System.IntPtr to BitmapRenderTarget.

public static explicit operator BitmapRenderTarget(IntPtr nativePointer)

Parameters

nativePointer System.IntPtr

Returns

BitmapRenderTarget