xtd 0.2.0
Loading...
Searching...
No Matches
xtd::drawing::imaging::image_format Class Referencefinal
Inheritance diagram for xtd::drawing::imaging::image_format:
xtd::object xtd::icomparable< image_format > xtd::iequatable< image_format > xtd::interface xtd::comparison_operators< type_t, comparable_t > xtd::interface xtd::equality_operators< type_t, equatable_t >

Definition

Specifies the file format of the image. Not inheritable.

Namespace
xtd::drawing::imaging
Library
xtd.drawing

Public Constructors

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

Public Properties

const xtd::guid guid () const noexcept
 Gets a guid structure that represents this image_format object.
 

Public Methods

int32 compare_to (const image_format &value) const noexcept override
 
bool equals (const image_format &value) const noexcept override
 
xtd::string to_string () const noexcept override
 Converts this image_format object to a human-readable string.
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
template<typename object_a_t , typename object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 

Public Static Properties

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

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
- Public Member Functions inherited from xtd::icomparable< image_format >
virtual int32 compare_to (const image_format &obj) const noexcept=0
 Compares the current instance with another object of the same type.
 
- Public Member Functions inherited from xtd::iequatable< image_format >
virtual bool equals (const image_format &) const noexcept=0
 Indicates whether the current object is equal to another object of the same type.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
template<typename object_a_t , typename object_b_t >
static bool reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 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)
inlineexplicit

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

Parameters
guidThe 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()

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

Gets a guid structure that represents this image_format object.

Returns
A guid structure that represents this image_format object.

◆ bmp()

static image_format xtd::drawing::imaging::image_format::bmp ( )
inlinestaticnoexcept

Gets the bitmap (BMP) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ emf()

static image_format xtd::drawing::imaging::image_format::emf ( )
inlinestaticnoexcept

Gets the enhanced metafile (EMF) image format.

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

◆ exif()

static image_format xtd::drawing::imaging::image_format::exif ( )
inlinestaticnoexcept

Gets the Exchangeable Image File (Exif) format.

Returns
An image_format object that indicates the Exif format.

◆ gif()

static image_format xtd::drawing::imaging::image_format::gif ( )
inlinestaticnoexcept

Gets the Graphics Interchange Format (GIF) image format.

Returns
An image_format object that indicates the GIF image format.

◆ ico()

static image_format xtd::drawing::imaging::image_format::ico ( )
inlinestaticnoexcept

Gets the windows icon (ico) image format.

Returns
An image_format object that indicates the icon image format.

◆ jpeg()

static image_format xtd::drawing::imaging::image_format::jpeg ( )
inlinestaticnoexcept

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

Returns
An image_format object that indicates the JOEG image format.

◆ memory_bmp()

static image_format xtd::drawing::imaging::image_format::memory_bmp ( )
inlinestaticnoexcept

Gets the format of a bitmap in memory.

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

◆ png()

static image_format xtd::drawing::imaging::image_format::png ( )
inlinestaticnoexcept

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

Returns
An image_format object that indicates the PNG image format.

◆ tiff()

static image_format xtd::drawing::imaging::image_format::tiff ( )
inlinestaticnoexcept

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

Returns
An image_format object that indicates the TIFF image format.

◆ wmf()

static image_format xtd::drawing::imaging::image_format::wmf ( )
inlinestaticnoexcept

Gets the Windows metafile (WMF) image format.

Returns
An image_format object that indicates the WMF image format.

◆ memory_gif()

static image_format xtd::drawing::imaging::image_format::memory_gif ( )
inlinestaticnoexcept

Gets the GIF memory format.

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

◆ memory_ico()

static image_format xtd::drawing::imaging::image_format::memory_ico ( )
inlinestaticnoexcept

Gets the ICO memory format.

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

◆ memory_jpeg()

static image_format xtd::drawing::imaging::image_format::memory_jpeg ( )
inlinestaticnoexcept

Gets the JPEG memory format.

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

◆ memory_png()

static image_format xtd::drawing::imaging::image_format::memory_png ( )
inlinestaticnoexcept

Gets the PNG memory format.

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

◆ memory_tiff()

static image_format xtd::drawing::imaging::image_format::memory_tiff ( )
inlinestaticnoexcept

Gets the TIFF memory.

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

◆ cur()

static image_format xtd::drawing::imaging::image_format::cur ( )
inlinestaticnoexcept

Gets the cursor (CUR) image format.

Returns
An image_format object that indicates the cursor image format.

◆ memory_cur()

static image_format xtd::drawing::imaging::image_format::memory_cur ( )
inlinestaticnoexcept

Gets the CUR memory.

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

◆ xbm()

static image_format xtd::drawing::imaging::image_format::xbm ( )
inlinestaticnoexcept

Gets the x bitmap (XBM) image format.

Returns
An image_format object that indicates the XBM image format.

◆ memory_xbm()

static image_format xtd::drawing::imaging::image_format::memory_xbm ( )
inlinestaticnoexcept

Gets the XMB memory.

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

◆ xpm()

static image_format xtd::drawing::imaging::image_format::xpm ( )
inlinestaticnoexcept

Gets the x pixmap (XPM) image format.

Returns
An image_format object that indicates the XPM image format.

◆ memory_xpm()

static image_format xtd::drawing::imaging::image_format::memory_xpm ( )
inlinestaticnoexcept

Gets the XPM memory.

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

◆ pnm()

static image_format xtd::drawing::imaging::image_format::pnm ( )
inlinestaticnoexcept

Gets the portable pixmap (PNM) image format.

Returns
An image_format object that indicates the PNM image format.

◆ memory_pnm()

static image_format xtd::drawing::imaging::image_format::memory_pnm ( )
inlinestaticnoexcept

Gets the PNM memory.

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

◆ pcx()

static image_format xtd::drawing::imaging::image_format::pcx ( )
inlinestaticnoexcept

Gets the pcx (PCX) image format.

Returns
An image_format object that indicates the PCX image format.

◆ memory_pcx()

static image_format xtd::drawing::imaging::image_format::memory_pcx ( )
inlinestaticnoexcept

Gets the PCX memory.

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

◆ pict()

static image_format xtd::drawing::imaging::image_format::pict ( )
inlinestaticnoexcept

Gets the apple pict (PICT) image format.

Returns
An image_format object that indicates the PICT image format.

◆ memory_pict()

static image_format xtd::drawing::imaging::image_format::memory_pict ( )
inlinestaticnoexcept

Gets the PICT memory.

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

◆ icon()

static image_format xtd::drawing::imaging::image_format::icon ( )
inlinestaticnoexcept

Gets the apple icon (ICON) image format.

Returns
An image_format object that indicates the ICON image format.

◆ memory_icon()

static image_format xtd::drawing::imaging::image_format::memory_icon ( )
inlinestaticnoexcept

Gets the ICON memory.

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

◆ cursor()

static image_format xtd::drawing::imaging::image_format::cursor ( )
inlinestaticnoexcept

Gets the apple cursor (CURSOR) image format.

Returns
An image_format object that indicates the CURSOR format.

◆ memory_cursor()

static image_format xtd::drawing::imaging::image_format::memory_cursor ( )
inlinestaticnoexcept

Gets the CURSOR memory.

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

◆ ani()

static image_format xtd::drawing::imaging::image_format::ani ( )
inlinestaticnoexcept

Gets the animated file cursor (ANI) image format.

Returns
An image_format object that indicates the ANI image format.

◆ iif()

static image_format xtd::drawing::imaging::image_format::iif ( )
inlinestaticnoexcept

Gets the iif (IIF) image format.

Returns
An image_format object that indicates the IIF image format.

◆ tga()

static image_format xtd::drawing::imaging::image_format::tga ( )
inlinestaticnoexcept

Gets the truevision targa (TGA) image format.

Returns
An image_format object that indicates the TGA image format.

◆ to_string()

xtd::string xtd::drawing::imaging::image_format::to_string ( ) const
inlineoverridevirtualnoexcept

Converts this image_format object to a human-readable string.

Returns
A string that represents this image_format object.

Reimplemented from xtd::object.

◆ equals() [1/2]

virtual bool xtd::object::equals ( const object obj) const
virtualnoexcept

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

Parameters
objThe object to compare with the current object.
Returns
true if the specified object is equal to the current object. otherwise, false.
Examples
The following code example compares the current instance with another object.
#include <xtd/console>
using namespace xtd;
auto main() -> int {
auto object1 = new_ptr<object>();
auto object2 = new_ptr<object>();
auto object3 = object2;
console::write_line(object1->equals(*object3));
console::write_line(*object1 == *object3);
object3 = object1;
console::write_line(object1->equals(*object3));
console::write_line(*object1 == *object3);
}
// This code produces the following output :
//
// false
// false
// true
// true
static void write_line()
Writes the current line terminator to the standard output stream using the specified format informati...
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.hpp:10

Reimplemented from xtd::object.

◆ equals() [2/2]

template<typename object_a_t , typename object_b_t >
static bool xtd::object::equals ( const object_a_t &  object_a,
const object_b_t &  object_b 
)
inlinestaticnoexcept

Determines whether the specified object instances are considered equal.

Parameters
object_aThe first object to compare.
object_bThe second object to compare.
Returns
true if object_a is the same instance as object_b or if both are null references or if object_a(object_b) returns true. otherwise, false.
Examples
The following code example compares different objects.
#include <xtd/console>
using namespace xtd;
auto main() -> int {
string s1 = "Tom";
string s2 = "Carol";
console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
s1 = "Tom";
s2 = "Tom";
console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
s1 = "";
s2 = "Tom";
console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
s1 = "Carol";
s2 = "";
console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
s1 = "";
s2 = "";
console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
}
// This code produces the following output :
//
// object::equals("Tom", "Carol") => false
// object::equals("Tom", "Tom") => true
// object::equals("", "Tom") => false
// object::equals("Carol", "") => false
// object::equals("", "") => true
virtual bool equals(const object &obj) const noexcept
Determines whether the specified object is equal to the current object.

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