xtd 0.2.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::equality_operators< type_t, equatable_t >

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

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

Public Methods

bool equals (const encoder &value) const noexcept override
 
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 Fields

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

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.
 
virtual xtd::string to_string () const noexcept
 Returns a xtd::string that represents the current object.
 
- Public Member Functions inherited from xtd::iequatable< encoder >
virtual bool equals (const encoder &) 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

◆ encoder()

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

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

static encoder xtd::drawing::imaging::encoder::chrominance_table ( )
inlinestaticnoexcept

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

static encoder xtd::drawing::imaging::encoder::color_depth ( )
inlinestaticnoexcept

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

static encoder xtd::drawing::imaging::encoder::compression ( )
inlinestaticnoexcept

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

static encoder xtd::drawing::imaging::encoder::luminance_table ( )
inlinestaticnoexcept

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

static encoder xtd::drawing::imaging::encoder::quality ( )
inlinestaticnoexcept

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

static encoder xtd::drawing::imaging::encoder::render_method ( )
inlinestaticnoexcept

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

static encoder xtd::drawing::imaging::encoder::save_flag ( )
inlinestaticnoexcept

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

static encoder xtd::drawing::imaging::encoder::scan_method ( )
inlinestaticnoexcept

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

static encoder xtd::drawing::imaging::encoder::transformation ( )
inlinestaticnoexcept

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

static encoder xtd::drawing::imaging::encoder::version ( )
inlinestaticnoexcept

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

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

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]

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
xtd::console::write_line
static void write_line()
Writes the current line terminator to the standard output stream using the specified format informati...
xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.h: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
xtd::object::equals
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:
Generated on Sun Nov 17 2024 19:44:01 for xtd by Gammasoft. All rights reserved.