xtd 1.0.0
Loading...
Searching...
No Matches
List of all members
xtd::drawing::imaging::encoder Class Referencefinal
﹡ libraries » xtd.drawing
Inheritance diagram for xtd::drawing::imaging::encoder:
xtd::object xtd::iequatable< encoder > xtd::interface xtd::extensions::equality_operators< encoder, iequatable< encoder > >

Definition

An Encoder object encapsulates a globally unique identifier (GUID) that identifies the category of an image encoder parameter.

Namespace
xtd::drawing::imaging
Library
xtd.drawing
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an EncoderParameter object. One of the fields of the EncoderParameter object is a GUID that specifies the category of the parameter. Use the static fields of the Encoder class to retrieve an Encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.
Category GUID
chrominance_table f2e455dc-09b3-4316-8260-676ada32481c
color_depth 66087055-ad66-4c7c-9a18-38a2310b8337
compression e09d739d-ccd4-44ee-8eba-3fbf8be4fc58
luminance_table edb33bce-0266-4a77-b904-27216099e717
quality 1d5be4b5-fa4a-452d-9cdd-5db35105e7eb
render_method 6d42c53a-229a-4825-8bb7-5c99e2b9a8b8
save_flag 292266fc-ac40-47bf-8cfc-a85b89a655de
scan_method 3a4e2661-3109-4e56-8536-42c156e7dcfa
transformation 8d0eb2d1-a58e-4ea8-aa14-108074b7b6f9
version 24d18c76-814a-41a4-bf53-1c219cccf797

Public Constructors

 encoder (const xtd::guid &guid)
 Initializes a new instance of the xtd::drawing::imaging::encoder class from the specified globally unique identifier (GUID). The GUID specifies an image encoder parameter category.

Public Properties

auto guid () const noexcept -> const xtd::guid &
 Gets a globally unique identifier (GUID) that identifies an image encoder parameter category.

Public Methods

auto equals (const object &obj) const noexcept -> bool override
 Determines whether the specified object is equal to the current object.
auto equals (const encoder &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.

Public Fields

static auto chrominance_table () noexcept -> encoder
 An Encoder object that is initialized with the globally unique identifier for the chrominance table parameter category.
static auto color_depth () noexcept -> encoder
 An Encoder object that is initialized with the globally unique identifier for the color depth parameter category.
static auto compression () noexcept -> encoder
 An Encoder object that is initialized with the globally unique identifier for the compression parameter category.
static auto luminance_table () noexcept -> encoder
 An Encoder object that is initialized with the globally unique identifier for the luminance table parameter category.
static auto quality () noexcept -> encoder
 An Encoder object that is initialized with the globally unique identifier for the quality parameter category.
static auto render_method () noexcept -> encoder
 An Encoder object that is initialized with the globally unique identifier for the renderer method category.
static auto save_flag () noexcept -> encoder
 An Encoder object that is initialized with the globally unique identifier for the save flag category.
static auto scan_method () noexcept -> encoder
 An Encoder object that is initialized with the globally unique identifier for the scan method category.
static auto transformation () noexcept -> encoder
 An Encoder object that is initialized with the globally unique identifier for the transformation category.
static auto version () noexcept -> encoder
 An Encoder object that is initialized with the globally unique identifier for the version category.

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 to_string () const -> xtd::string
 Returns a xtd::string that represents the current object.
virtual auto equals (const encoder &) 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

◆ encoder()

xtd::drawing::imaging::encoder::encoder ( const xtd::guid & guid)
explicit

Initializes a new instance of the xtd::drawing::imaging::encoder class from the specified globally unique identifier (GUID). The GUID specifies an image encoder parameter category.

Parameters
guidA globally unique identifier that identifies an image encoder parameter category.

Member Function Documentation

◆ chrominance_table()

auto xtd::drawing::imaging::encoder::chrominance_table ( ) -> encoder
staticnodiscardnoexcept

An Encoder object that is initialized with the globally unique identifier for the chrominance table parameter category.

Returns
The encoder.
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an xtd::drawing::image::encoder_parameter object. One of the fields of the xtd::drawing::image::encoder_parameter object is a GUID that specifies the category of the parameter. Use the static fields of the xtd::drawing::imaging:encoder class to retrieve an xtd::drawing::imaging:encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

◆ color_depth()

auto xtd::drawing::imaging::encoder::color_depth ( ) -> encoder
staticnodiscardnoexcept

An Encoder object that is initialized with the globally unique identifier for the color depth parameter category.

Returns
The encoder.
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an xtd::drawing::image::encoder_parameter object. One of the fields of the xtd::drawing::image::encoder_parameter object is a GUID that specifies the category of the parameter. Use the static fields of the xtd::drawing::imaging:encoder class to retrieve an xtd::drawing::imaging:encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

◆ compression()

auto xtd::drawing::imaging::encoder::compression ( ) -> encoder
staticnodiscardnoexcept

An Encoder object that is initialized with the globally unique identifier for the compression parameter category.

Returns
The encoder.
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an xtd::drawing::image::encoder_parameter object. One of the fields of the xtd::drawing::image::encoder_parameter object is a GUID that specifies the category of the parameter. Use the static fields of the xtd::drawing::imaging:encoder class to retrieve an xtd::drawing::imaging:encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

◆ luminance_table()

auto xtd::drawing::imaging::encoder::luminance_table ( ) -> encoder
staticnodiscardnoexcept

An Encoder object that is initialized with the globally unique identifier for the luminance table parameter category.

Returns
The encoder.
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an xtd::drawing::image::encoder_parameter object. One of the fields of the xtd::drawing::image::encoder_parameter object is a GUID that specifies the category of the parameter. Use the static fields of the xtd::drawing::imaging:encoder class to retrieve an xtd::drawing::imaging:encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

◆ quality()

auto xtd::drawing::imaging::encoder::quality ( ) -> encoder
staticnodiscardnoexcept

An Encoder object that is initialized with the globally unique identifier for the quality parameter category.

Returns
The encoder.
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an xtd::drawing::image::encoder_parameter object. One of the fields of the xtd::drawing::image::encoder_parameter object is a GUID that specifies the category of the parameter. Use the static fields of the xtd::drawing::imaging:encoder class to retrieve an xtd::drawing::imaging:encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

◆ render_method()

auto xtd::drawing::imaging::encoder::render_method ( ) -> encoder
staticnodiscardnoexcept

An Encoder object that is initialized with the globally unique identifier for the renderer method category.

Returns
The encoder.
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an xtd::drawing::image::encoder_parameter object. One of the fields of the xtd::drawing::image::encoder_parameter object is a GUID that specifies the category of the parameter. Use the static fields of the xtd::drawing::imaging:encoder class to retrieve an xtd::drawing::imaging:encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

◆ save_flag()

auto xtd::drawing::imaging::encoder::save_flag ( ) -> encoder
staticnodiscardnoexcept

An Encoder object that is initialized with the globally unique identifier for the save flag category.

Returns
The encoder.
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an xtd::drawing::image::encoder_parameter object. One of the fields of the xtd::drawing::image::encoder_parameter object is a GUID that specifies the category of the parameter. Use the static fields of the xtd::drawing::imaging:encoder class to retrieve an xtd::drawing::imaging:encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

◆ scan_method()

auto xtd::drawing::imaging::encoder::scan_method ( ) -> encoder
staticnodiscardnoexcept

An Encoder object that is initialized with the globally unique identifier for the scan method category.

Returns
The encoder.
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an xtd::drawing::image::encoder_parameter object. One of the fields of the xtd::drawing::image::encoder_parameter object is a GUID that specifies the category of the parameter. Use the static fields of the xtd::drawing::imaging:encoder class to retrieve an xtd::drawing::imaging:encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

◆ transformation()

auto xtd::drawing::imaging::encoder::transformation ( ) -> encoder
staticnodiscardnoexcept

An Encoder object that is initialized with the globally unique identifier for the transformation category.

Returns
The encoder.
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an xtd::drawing::image::encoder_parameter object. One of the fields of the xtd::drawing::image::encoder_parameter object is a GUID that specifies the category of the parameter. Use the static fields of the xtd::drawing::imaging:encoder class to retrieve an xtd::drawing::imaging:encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

◆ version()

auto xtd::drawing::imaging::encoder::version ( ) -> encoder
staticnodiscardnoexcept

An Encoder object that is initialized with the globally unique identifier for the version category.

Returns
The encoder.
Remarks
When you pass a parameter to an image encoder, the parameter is encapsulated in an xtd::drawing::image::encoder_parameter object. One of the fields of the xtd::drawing::image::encoder_parameter object is a GUID that specifies the category of the parameter. Use the static fields of the xtd::drawing::imaging:encoder class to retrieve an xtd::drawing::imaging:encoder that contains parameters of the desired category.
The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

◆ guid()

auto xtd::drawing::imaging::encoder::guid ( ) const -> const xtd::guid &
nodiscardnoexcept

Gets a globally unique identifier (GUID) that identifies an image encoder parameter category.

Returns
The GUID that identifies an image encoder parameter category.

◆ equals() [1/2]

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

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.

Reimplemented from xtd::object.

◆ equals() [2/2]

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

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

Parameters
otherThe 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::encoder::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.

The documentation for this class was generated from the following file:
Generated on for xtd by Gammasoft. All rights reserved.