Create Method

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.

Declaration

public static BitmapRenderTarget Create(RenderTarget renderTarget, CompatibleRenderTargetOptions options)

Public Shared Function Create(renderTarget As RenderTarget, options As CompatibleRenderTargetOptions) As BitmapRenderTarget

Parameters

Type	Name	Description
RenderTarget	renderTarget	an instance of RenderTarget
CompatibleRenderTargetOptions	options	A value that specifies whether the new render target must be compatible with GDI.

Returns

Type	Description
BitmapRenderTarget

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.

Declaration

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

Public Shared Function Create(renderTarget As RenderTarget, options As CompatibleRenderTargetOptions, desiredSize As Size2F) As BitmapRenderTarget

Parameters

Type	Name	Description
RenderTarget	renderTarget	an instance of RenderTarget
CompatibleRenderTargetOptions	options	A value that specifies whether the new render target must be compatible with GDI.
Size2F	desiredSize	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

Type	Description
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.

Declaration

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

Public Shared Function Create(renderTarget As RenderTarget, options As CompatibleRenderTargetOptions, desiredFormat As PixelFormat?) As BitmapRenderTarget

Parameters

Type	Name	Description
RenderTarget	renderTarget	an instance of RenderTarget
CompatibleRenderTargetOptions	options	A value that specifies whether the new render target must be compatible with GDI.
PixelFormat?	desiredFormat	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

Type	Description
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.

Declaration

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

Public Shared Function Create(renderTarget As RenderTarget, options As CompatibleRenderTargetOptions, desiredSize As Size2F?, desiredPixelSize As Size2L?, desiredFormat As PixelFormat?) As BitmapRenderTarget

Parameters

Type	Name	Description
RenderTarget	renderTarget	an instance of RenderTarget
CompatibleRenderTargetOptions	options	A value that specifies whether the new render target must be compatible with GDI.
Size2F?	desiredSize	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.
Size2L?	desiredPixelSize	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.
PixelFormat?	desiredFormat	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

Type	Description
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.