xtd - Reference Guide  0.1.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Member Functions | Static Public Member Functions | List of all members
xtd::drawing::imaging::image_format Class Referencefinal

#include <image_format.h>

Definition

Specifies the file format of the image. Not inheritable.

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

Inherits xtd::object.

Public Member Functions

 image_format (const guid &guid)
 Initializes a new instance of the image_format class by using the specified guid structure.
 
const xtd::guid guid () const
 Gets a guid structure that represents this image_format object.
 
xtd::ustring to_string () const noexcept override
 Converts this image_format object to a human-readable string.
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance.
 
virtual xtd::ustring to_string () const noexcept
 Returns a std::string that represents the current object.
 

Static Public Member Functions

static image_format ani ()
 Gets the animated file cursor (ani) image format.
 
static image_format bmp ()
 Gets the bitmap (BMP) image format.
 
static image_format cur ()
 Gets the cursor (cur) image format.
 
static image_format cursor ()
 Gets the apple cursor) image format.
 
static image_format emf ()
 Gets the enhanced metafile (EMF) image format.
 
static image_format exif ()
 Gets the Exchangeable Image File (Exif) format.
 
static image_format gif ()
 Gets the Graphics Interchange Format (GIF) image format.
 
static image_format ico ()
 Gets the windows icon (ico) image format.
 
static image_format icon ()
 Gets the apple icon (pict) image format.
 
static image_format iif ()
 Gets the iif image format.
 
static image_format jpeg ()
 Gets the Joint Photographic Experts Group (JPEG) image format.
 
static image_format memory_bmp ()
 Gets the format of a bitmap in memory.
 
static image_format memory_cur ()
 Gets the cur memory.
 
static image_format memory_cursor ()
 Gets the cursor memory.
 
static image_format memory_gif ()
 Gets the gif memory format.
 
static image_format memory_ico ()
 Gets the ico memory format.
 
static image_format memory_icon ()
 Gets the icon memory.
 
static image_format memory_jpeg ()
 Gets the jpeg memory format.
 
static image_format memory_pcx ()
 Gets the pcx memory.
 
static image_format memory_pict ()
 Gets the pict memory.
 
static image_format memory_png ()
 Gets the ipng memory format.
 
static image_format memory_pnm ()
 Gets the pnm memory.
 
static image_format memory_tiff ()
 Gets the tiff memory.
 
static image_format memory_xbm ()
 Gets the xbm memory.
 
static image_format memory_xpm ()
 Gets the xpm memory.
 
static image_format pcx ()
 Gets the pcx (pcx) image format.
 
static image_format pict ()
 Gets the apple pict (pict) image format.
 
static image_format png ()
 Gets the W3C Portable Network Graphics (PNG) image format.
 
static image_format pnm ()
 Gets the portable pixmap (pnm) image format.
 
static image_format tga ()
 Gets the truevision targa (tga) image format.
 
static image_format tiff ()
 Gets the Tagged Image File Format (TIFF) image format.
 
static image_format wmf ()
 Gets the Windows metafile (WMF) image format.
 
static image_format xbm ()
 Gets the x bitmap (xbm) image format.
 
static image_format xpm ()
 Gets the x pixmap (xpm) image format.
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
static bool reference_equals (const object &object_a, const object &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

◆ ani()

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

Gets the animated file cursor (ani) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ bmp()

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

Gets the bitmap (BMP) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ cur()

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

Gets the cursor (cur) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ cursor()

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

Gets the apple cursor) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ emf()

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

Gets the enhanced metafile (EMF) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ exif()

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

Gets the Exchangeable Image File (Exif) format.

Returns
An image_format object that indicates the bitmap image format.

◆ gif()

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

Gets the Graphics Interchange Format (GIF) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ guid()

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

Gets a guid structure that represents this image_format object.

Returns
A guid structure that represents this image_format object.

◆ ico()

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

Gets the windows icon (ico) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ icon()

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

Gets the apple icon (pict) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ iif()

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

Gets the iif image format.

Returns
An image_format object that indicates the bitmap image format.

◆ jpeg()

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

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

Returns
An image_format object that indicates the bitmap image format.

◆ memory_bmp()

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

Gets the format of a bitmap in memory.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_cur()

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

Gets the cur memory.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_cursor()

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

Gets the cursor memory.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_gif()

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

Gets the gif memory format.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_ico()

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

Gets the ico memory format.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_icon()

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

Gets the icon memory.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_jpeg()

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

Gets the jpeg memory format.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_pcx()

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

Gets the pcx memory.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_pict()

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

Gets the pict memory.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_png()

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

Gets the ipng memory format.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_pnm()

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

Gets the pnm memory.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_tiff()

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

Gets the tiff memory.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_xbm()

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

Gets the xbm memory.

Returns
An image_format object that indicates the bitmap image format.

◆ memory_xpm()

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

Gets the xpm memory.

Returns
An image_format object that indicates the bitmap image format.

◆ pcx()

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

Gets the pcx (pcx) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ pict()

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

Gets the apple pict (pict) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ png()

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

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

Returns
An image_format object that indicates the bitmap image format.

◆ pnm()

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

Gets the portable pixmap (pnm) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ tga()

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

Gets the truevision targa (tga) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ tiff()

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

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

Returns
An image_format object that indicates the bitmap image format.

◆ to_string()

xtd::ustring 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.

◆ wmf()

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

Gets the Windows metafile (WMF) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ xbm()

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

Gets the x bitmap (xbm) image format.

Returns
An image_format object that indicates the bitmap image format.

◆ xpm()

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

Gets the x pixmap (xpm) image format.

Returns
An image_format object that indicates the bitmap image format.

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