xtd::drawing::image_converter Class Reference

Inheritance diagram for xtd::drawing::image_converter:

Definition

Converts images to and from xtd::drawing::image class. This class cannot be inherited.

class drawing_export_ image_converter final static_

Inheritance

xtd::static_object → xtd::drawing::image_converter

Namespace

xtd::drawing

Library

xtd.drawing

Public Static Methods
static auto	from_base64_string (const xtd::string &value) -> xtd::drawing::image
	Convert specified base64 string to image.
static auto	to_array (const xtd::drawing::image &value) -> xtd::array< xtd::byte >
	Convert specified image to byte array.
static auto	to_base64_string (const xtd::drawing::image &value) -> xtd::string
	Convert specified image to base64 string.
static auto	to_file (const xtd::drawing::image &value, const xtd::string &filename) -> void
	Convert specified image to file.
static auto	to_file (const xtd::drawing::image &value, const xtd::string &filename, const xtd::drawing::imaging::image_format &format) -> void
	Convert specified image to file.
static auto	to_image (const xtd::array< xtd::byte > &value) -> xtd::drawing::image
	Convert specified byte array to image.
static auto	to_image (const xtd::read_only_span< xtd::byte > &value) -> xtd::drawing::image
	Convert specified bytes span to image.
static auto	to_image (const xtd::string &filename) -> xtd::drawing::image
	Convert specified file name string.
static auto	to_image (std::istream &stream) -> xtd::drawing::image
	Convert specified stream to image.
static auto	to_stream (const xtd::drawing::image &value, std::ostream &stream, const xtd::drawing::imaging::image_format &format) -> void
	Convert specified image to stream.

Member Function Documentation

from_base64_string()

auto xtd::drawing::image_converter::from_base64_string ( const xtd::string & value ) -> xtd::drawing::image

staticnodiscard

Convert specified base64 string to image.

Parameters

value

A base64 string that contains the image.

Returns

The converted image from base64 string.

Remarks

The first eight bytes contain the width followed by the height of the image. The following bytes contain the ARGB components of the image pixels.

to_array()

auto xtd::drawing::image_converter::to_array ( const xtd::drawing::image & value ) -> xtd::array< xtd::byte >

staticnodiscard

Convert specified image to byte array.

Parameters

value

The image to convert into byte array.

Returns

A byte array that contains the image.

Remarks

The first eight bytes contain the width followed by the height of the image. The following bytes contain the ARGB components of the image pixels.

to_base64_string()

auto xtd::drawing::image_converter::to_base64_string ( const xtd::drawing::image & value ) -> xtd::string

staticnodiscard

Convert specified image to base64 string.

Parameters

value

The image to convert into base64 string.

Returns

A base64 string that contains the image.

Remarks

The first eight bytes contain the width followed by the height of the image. The following bytes contain the ARGB components of the image pixels.

to_file() [1/2]

auto xtd::drawing::image_converter::to_file ( const xtd::drawing::image & value, const xtd::string & filename ) -> void

static

Convert specified image to file.

Parameters

value	The image to convert into base64 string.
filename	A string that contains the name of the file to which to save this xtd::drawing::image.

Remarks

If no encoder exists for the file format of the image, the Portable Network Graphics (PNG) encoder is used. When you use the xtd::drawing::image::save method to save a graphic image as a Windows Metafile Format (WMF) or Enhanced Metafile Format (EMF) file, the resulting file is saved as a Portable Network Graphics (PNG) file. This behavior occurs because the GDI+ component of the .NET Framework does not have an encoder that you can use to save files as .wmf or .emf files.

Saving the image to the same file it was constructed from is not allowed and throws an exception.

to_file() [2/2]

auto xtd::drawing::image_converter::to_file ( const xtd::drawing::image & value, const xtd::string & filename, const xtd::drawing::imaging::image_format & format ) -> void

static

Convert specified image to file.

Parameters

value	The image to convert into base64 string.
filename	A string that contains the name of the file to which to save this xtd::drawing::image.
format	The xtd::drawing::imaging::image_format for this xtd::drawing::image.

to_image() [1/4]

auto xtd::drawing::image_converter::to_image ( const xtd::array< xtd::byte > & value ) -> xtd::drawing::image

staticnodiscard

Convert specified byte array to image.

Parameters

value

A byte array that contains the image.

Returns

The converted image from byte array.

Remarks

The first eight bytes contain the width followed by the height of the image. The following bytes contain the ARGB components of the image pixels.

to_image() [2/4]

auto xtd::drawing::image_converter::to_image ( const xtd::read_only_span< xtd::byte > & value ) -> xtd::drawing::image

staticnodiscard

Convert specified bytes span to image.

Parameters

value

A bytes span that contains the image.

Returns

The converted image from byte array.

Remarks

The first eight bytes contain the width followed by the height of the image. The following bytes contain the ARGB components of the image pixels.

to_image() [3/4]

auto xtd::drawing::image_converter::to_image ( const xtd::string & filename ) -> xtd::drawing::image

staticnodiscard

Convert specified file name string.

Parameters

filename

A file name string that contains the image.

Returns

The converted image from file name string.

to_image() [4/4]

auto xtd::drawing::image_converter::to_image ( std::istream & stream ) -> xtd::drawing::image

staticnodiscard

Convert specified stream to image.

Parameters

stream

The input stream that contains the image.

Returns

The converted image from stream.

to_stream()

auto xtd::drawing::image_converter::to_stream ( const xtd::drawing::image & value, std::ostream & stream, const xtd::drawing::imaging::image_format & format ) -> void

static

Convert specified image to stream.

Parameters

value	The image to convert.
stream	The output stream where to write the image.
format	The xtd::drawing::imaging::image_format for this xtd::drawing::image.

Remarks

You should avoid saving an image to the same stream that was used to construct it. Doing so might damage the stream.

The image must be saved to the stream at an offset of zero. If any additional data has been written to the stream before saving the image, the image data in the stream will be corrupted.

---

The documentation for this class was generated from the following file:

• xtd.drawing/include/xtd/drawing/image_converter.hpp