Convert(NPixelFormat,Boolean) Method

In This Topic

Returns a raster with the specified pixel format, using the current raster as a source.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function Convert( _
   ByVal destFormat As NPixelFormat, _
   ByVal copySource As System.Boolean _
) As NRaster

'Usage
 
Dim instance As NRaster
Dim destFormat As NPixelFormat
Dim copySource As System.Boolean
Dim value As NRaster
 
value = instance.Convert(destFormat, copySource)

public NRaster Convert( 
   NPixelFormat destFormat,
   System.bool copySource
)

Parameters

destFormat: The target pixel format of the destination raster.
copySource: Specifies wheteher a copy of this raster must be returned in case that conversion is not necessary.

Return Value

Returns a NRaster object containing the image data from the current raster, converted to the pixel format specified by destFormat. If destFormat is the same as the current raster's pixel format and copySource is set to false - then a reference to the current raster is returned.

Remarks

Throws an exception if either the source or the destination pixel format is not convertible.

Requirements

Target Platforms: Windows 11, Windows 10, Windows 7, Windows Server 2019, Windows Server 2016, Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later)

Reference

NRaster Class
NRaster Members
Overload List

Send Feedback