Inheritance diagram for xtd::drawing::imaging::image_format:

Definition

Specifies the file format of the image. Not inheritable.

Namespace: xtd::drawing::imaging

Library: xtd.drawing

Public Constructors
	image_format (const guid &guid) noexcept
	Initializes a new instance of the image_format class by using the specified guid structure.

Public Properties
auto	guid () const noexcept -> const xtd::guid
	Gets a guid structure that represents this image_format object.

Public Methods
auto	compare_to (const image_format &value) const noexcept -> int32 override
	Compares the current instance with another object of the same type.
auto	equals (const object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const image_format &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.
auto	to_string () const noexcept -> xtd::string override
	Converts this image_format object to a human-readable string.

Public Static Properties
static auto	bmp () noexcept -> image_format
	Gets the bitmap (BMP) image format.
static auto	emf () noexcept -> image_format
	Gets the enhanced metafile (EMF) image format.
static auto	exif () noexcept -> image_format
	Gets the Exchangeable Image File (Exif) format.
static auto	gif () noexcept -> image_format
	Gets the Graphics Interchange Format (GIF) image format.
static auto	ico () noexcept -> image_format
	Gets the windows icon (ico) image format.
static auto	jpeg () noexcept -> image_format
	Gets the Joint Photographic Experts Group (JPEG) image format.
static auto	memory_bmp () noexcept -> image_format
	Gets the format of a bitmap in memory.
static auto	png () noexcept -> image_format
	Gets the W3C Portable Network Graphics (PNG) image format.
static auto	tiff () noexcept -> image_format
	Gets the Tagged Image File Format (TIFF) image format.
static auto	wmf () noexcept -> image_format
	Gets the Windows metafile (WMF) image format.
static auto	memory_gif () noexcept -> image_format
	Gets the GIF memory format.
static auto	memory_ico () noexcept -> image_format
	Gets the ICO memory format.
static auto	memory_jpeg () noexcept -> image_format
	Gets the JPEG memory format.
static auto	memory_png () noexcept -> image_format
	Gets the PNG memory format.
static auto	memory_tiff () noexcept -> image_format
	Gets the TIFF memory.
static auto	cur () noexcept -> image_format
	Gets the cursor (CUR) image format.
static auto	memory_cur () noexcept -> image_format
	Gets the CUR memory.
static auto	xbm () noexcept -> image_format
	Gets the x bitmap (XBM) image format.
static auto	memory_xbm () noexcept -> image_format
	Gets the XMB memory.
static auto	xpm () noexcept -> image_format
	Gets the x pixmap (XPM) image format.
static auto	memory_xpm () noexcept -> image_format
	Gets the XPM memory.
static auto	pnm () noexcept -> image_format
	Gets the portable pixmap (PNM) image format.
static auto	memory_pnm () noexcept -> image_format
	Gets the PNM memory.
static auto	pcx () noexcept -> image_format
	Gets the pcx (PCX) image format.
static auto	memory_pcx () noexcept -> image_format
	Gets the PCX memory.
static auto	pict () noexcept -> image_format
	Gets the apple pict (PICT) image format.
static auto	memory_pict () noexcept -> image_format
	Gets the PICT memory.
static auto	icon () noexcept -> image_format
	Gets the apple icon (ICON) image format.
static auto	memory_icon () noexcept -> image_format
	Gets the ICON memory.
static auto	cursor () noexcept -> image_format
	Gets the apple cursor (CURSOR) image format.
static auto	memory_cursor () noexcept -> image_format
	Gets the CURSOR memory.
static auto	ani () noexcept -> image_format
	Gets the animated file cursor (ANI) image format.
static auto	iif () noexcept -> image_format
	Gets the iif (IIF) image format.
static auto	tga () noexcept -> image_format
	Gets the truevision targa (TGA) image format.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	compare_to (const image_format &obj) const noexcept -> xtd::int32=0
	Compares the current instance with another object of the same type.
virtual auto	equals (const image_format &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

◆ image_format()

xtd::drawing::imaging::image_format::image_format ( const guid & guid )

explicitnoexcept

Initializes a new instance of the image_format class by using the specified guid structure.

Parameters

guid	The guid structure that specifies a particular image format.

Remarks: Typically you use the static properties of the image_format class to specify a particular format such as Png or Jpeg, rather than constructing a new image_format.

Member Function Documentation

◆ guid()

auto xtd::drawing::imaging::image_format::guid ( ) const -> const xtd::guid

nodiscardnoexcept

Gets a guid structure that represents this image_format object.

Returns: A guid structure that represents this image_format object.

◆ bmp()

auto xtd::drawing::imaging::image_format::bmp ( ) -> image_format

staticnodiscardnoexcept

Gets the bitmap (BMP) image format.

Returns: An image_format object that indicates the bitmap image format.

◆ emf()

auto xtd::drawing::imaging::image_format::emf ( ) -> image_format

staticnodiscardnoexcept

Gets the enhanced metafile (EMF) image format.

Returns: An image_format object that indicates the enhanced metafile image format.

◆ exif()

auto xtd::drawing::imaging::image_format::exif ( ) -> image_format

staticnodiscardnoexcept

Gets the Exchangeable Image File (Exif) format.

Returns: An image_format object that indicates the Exif format.

◆ gif()

auto xtd::drawing::imaging::image_format::gif ( ) -> image_format

staticnodiscardnoexcept

Gets the Graphics Interchange Format (GIF) image format.

Returns: An image_format object that indicates the GIF image format.

◆ ico()

auto xtd::drawing::imaging::image_format::ico ( ) -> image_format

staticnodiscardnoexcept

Gets the windows icon (ico) image format.

Returns: An image_format object that indicates the icon image format.

◆ jpeg()

auto xtd::drawing::imaging::image_format::jpeg ( ) -> image_format

staticnodiscardnoexcept

Gets the Joint Photographic Experts Group (JPEG) image format.

Returns: An image_format object that indicates the JOEG image format.

◆ memory_bmp()

auto xtd::drawing::imaging::image_format::memory_bmp ( ) -> image_format

staticnodiscardnoexcept

Gets the format of a bitmap in memory.

Returns: An image_format object that indicates the bitmap memory image format.

◆ png()

auto xtd::drawing::imaging::image_format::png ( ) -> image_format

staticnodiscardnoexcept

Gets the W3C Portable Network Graphics (PNG) image format.

Returns: An image_format object that indicates the PNG image format.

◆ tiff()

auto xtd::drawing::imaging::image_format::tiff ( ) -> image_format

staticnodiscardnoexcept

Gets the Tagged Image File Format (TIFF) image format.

Returns: An image_format object that indicates the TIFF image format.

◆ wmf()

auto xtd::drawing::imaging::image_format::wmf ( ) -> image_format

staticnodiscardnoexcept

Gets the Windows metafile (WMF) image format.

Returns: An image_format object that indicates the WMF image format.

◆ memory_gif()

auto xtd::drawing::imaging::image_format::memory_gif ( ) -> image_format

staticnodiscardnoexcept

Gets the GIF memory format.

Returns: An image_format object that indicates the GIF mempry image format.

◆ memory_ico()

auto xtd::drawing::imaging::image_format::memory_ico ( ) -> image_format

staticnodiscardnoexcept

Gets the ICO memory format.

Returns: An image_format object that indicates the icon memory image format.

◆ memory_jpeg()

auto xtd::drawing::imaging::image_format::memory_jpeg ( ) -> image_format

staticnodiscardnoexcept

Gets the JPEG memory format.

Returns: An image_format object that indicates the JPEG memory image format.

◆ memory_png()

auto xtd::drawing::imaging::image_format::memory_png ( ) -> image_format

staticnodiscardnoexcept

Gets the PNG memory format.

Returns: An image_format object that indicates the PNG memory image format.

◆ memory_tiff()

auto xtd::drawing::imaging::image_format::memory_tiff ( ) -> image_format

staticnodiscardnoexcept

Gets the TIFF memory.

Returns: An image_format object that indicates the TIFF memory image format.

◆ cur()

auto xtd::drawing::imaging::image_format::cur ( ) -> image_format

staticnodiscardnoexcept

Gets the cursor (CUR) image format.

Returns: An image_format object that indicates the cursor image format.

◆ memory_cur()

auto xtd::drawing::imaging::image_format::memory_cur ( ) -> image_format

staticnodiscardnoexcept

Gets the CUR memory.

Returns: An image_format object that indicates the CUR memory image format.

◆ xbm()

auto xtd::drawing::imaging::image_format::xbm ( ) -> image_format

staticnodiscardnoexcept

Gets the x bitmap (XBM) image format.

Returns: An image_format object that indicates the XBM image format.

◆ memory_xbm()

auto xtd::drawing::imaging::image_format::memory_xbm ( ) -> image_format

staticnodiscardnoexcept

Gets the XMB memory.

Returns: An image_format object that indicates the XBM memory image format.

◆ xpm()

auto xtd::drawing::imaging::image_format::xpm ( ) -> image_format

staticnodiscardnoexcept

Gets the x pixmap (XPM) image format.

Returns: An image_format object that indicates the XPM image format.

◆ memory_xpm()

auto xtd::drawing::imaging::image_format::memory_xpm ( ) -> image_format

staticnodiscardnoexcept

Gets the XPM memory.

Returns: An image_format object that indicates the XPM memory image format.

◆ pnm()

auto xtd::drawing::imaging::image_format::pnm ( ) -> image_format

staticnodiscardnoexcept

Gets the portable pixmap (PNM) image format.

Returns: An image_format object that indicates the PNM image format.

◆ memory_pnm()

auto xtd::drawing::imaging::image_format::memory_pnm ( ) -> image_format

staticnodiscardnoexcept

Gets the PNM memory.

Returns: An image_format object that indicates the PNM memory image format.

◆ pcx()

auto xtd::drawing::imaging::image_format::pcx ( ) -> image_format

staticnodiscardnoexcept

Gets the pcx (PCX) image format.

Returns: An image_format object that indicates the PCX image format.

◆ memory_pcx()

auto xtd::drawing::imaging::image_format::memory_pcx ( ) -> image_format

staticnodiscardnoexcept

Gets the PCX memory.

Returns: An image_format object that indicates the PCX memory image format.

◆ pict()

auto xtd::drawing::imaging::image_format::pict ( ) -> image_format

staticnodiscardnoexcept

Gets the apple pict (PICT) image format.

Returns: An image_format object that indicates the PICT image format.

◆ memory_pict()

auto xtd::drawing::imaging::image_format::memory_pict ( ) -> image_format

staticnodiscardnoexcept

Gets the PICT memory.

Returns: An image_format object that indicates the PICT memory image format.

◆ icon()

auto xtd::drawing::imaging::image_format::icon ( ) -> image_format

staticnodiscardnoexcept

Gets the apple icon (ICON) image format.

Returns: An image_format object that indicates the ICON image format.

◆ memory_icon()

auto xtd::drawing::imaging::image_format::memory_icon ( ) -> image_format

staticnodiscardnoexcept

Gets the ICON memory.

Returns: An image_format object that indicates the ICOM memory image format.

◆ cursor()

auto xtd::drawing::imaging::image_format::cursor ( ) -> image_format

staticnodiscardnoexcept

Gets the apple cursor (CURSOR) image format.

Returns: An image_format object that indicates the CURSOR format.

◆ memory_cursor()

auto xtd::drawing::imaging::image_format::memory_cursor ( ) -> image_format

staticnodiscardnoexcept

Gets the CURSOR memory.

Returns: An image_format object that indicates the CURSOR memory image format.

◆ ani()

auto xtd::drawing::imaging::image_format::ani ( ) -> image_format

staticnodiscardnoexcept

Gets the animated file cursor (ANI) image format.

Returns: An image_format object that indicates the ANI image format.

◆ iif()

auto xtd::drawing::imaging::image_format::iif ( ) -> image_format

staticnodiscardnoexcept

Gets the iif (IIF) image format.

Returns: An image_format object that indicates the IIF image format.

◆ tga()

auto xtd::drawing::imaging::image_format::tga ( ) -> image_format

staticnodiscardnoexcept

Gets the truevision targa (TGA) image format.

Returns: An image_format object that indicates the TGA image format.

◆ compare_to()

auto xtd::drawing::imaging::image_format::compare_to ( const image_format & value ) const -> int32

nodiscardoverridenoexcept

Compares the current instance with another object of the same type.

Parameters

obj	An object to compare with this instance.

Returns: A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Condition
Less than zero	This instance is less than obj.
Zero	This instance is equal to obj.
Greater than zero	This instance is greater than obj.

◆ equals() [1/2]

auto xtd::drawing::imaging::image_format::equals ( const object & obj ) const -> bool

nodiscardoverridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns: true if the specified object is equal to the current object. otherwise, false.

Reimplemented from xtd::object.

◆ equals() [2/2]

auto xtd::drawing::imaging::image_format::equals ( const image_format & other ) const -> bool

nodiscardoverridenoexcept

Determines whether the specified object is equal to the current object.

Parameters

other The object to compare with the current object.

Returns: true if the specified object is equal to the current object. otherwise, false.

◆ get_hash_code()

auto xtd::drawing::imaging::image_format::get_hash_code ( ) const -> xtd::usize

nodiscardoverridevirtualnoexcept

Serves as a hash function for a particular type.

Returns: A hash code for the current object.

Reimplemented from xtd::object.

◆ to_string()

auto xtd::drawing::imaging::image_format::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Converts this image_format object to a human-readable string.

Returns: A string that represents this image_format object.

Reimplemented from xtd::object.

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

xtd.drawing/include/xtd/drawing/imaging/image_format.hpp

Definition

Public Constructors

Public Properties

Public Methods

Public Static Properties

Additional Inherited Members

Constructor & Destructor Documentation

◆ image_format()

Member Function Documentation

◆ guid()

◆ bmp()

◆ emf()

◆ exif()

◆ gif()

◆ ico()

◆ jpeg()

◆ memory_bmp()

◆ png()

◆ tiff()

◆ wmf()

◆ memory_gif()

◆ memory_ico()

◆ memory_jpeg()

◆ memory_png()

◆ memory_tiff()

◆ cur()

◆ memory_cur()

◆ xbm()

◆ memory_xbm()

◆ xpm()

◆ memory_xpm()

◆ pnm()

◆ memory_pnm()

◆ pcx()

◆ memory_pcx()

◆ pict()

◆ memory_pict()

◆ icon()

◆ memory_icon()

◆ cursor()

◆ memory_cursor()

◆ ani()

◆ iif()

◆ tga()

◆ compare_to()

◆ equals() [1/2]

◆ equals() [2/2]

◆ get_hash_code()

◆ to_string()