xtd 0.2.0
xtd::drawing::imaging::encoder_parameters Struct Referencefinal
Inheritance diagram for xtd::drawing::imaging::encoder_parameters:
xtd::object xtd::iequatable< encoder_parameters > xtd::interface xtd::extensions::equality_operators< type_t, equatable_t >

Definition

Encapsulates an array of EncoderParameter objects.

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

Public Properties

xtd::array< xtd::drawing::imaging::encoder_parameterparams
 Gets or sets an array of EncoderParameter objects.
 

Public Constructors

 encoder_parameters ()
 Initializes a new instance of the xtd::drawing::imaging::encoder_parameters class that can contain one xtd::drawing::imaging::encoder_parameter object.
 
 encoder_parameters (xtd::size count)
 Initializes a new instance of the xtd::drawing::imaging::encoder_parameters class that can contain the specified number of xtd::drawing::imaging::encoder_parameter objects.
 

Public Methods

bool equals (const object &obj) const noexcept override
 Determines whether the specified object is equal to the current object.
 
bool equals (const encoder_parameters &other) const noexcept override
 Determines whether the specified object is equal to the current object.
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual xtd::size 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<class 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_parameters >
virtual bool equals (const encoder_parameters &) 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<class object_a_t , class 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<class object_a_t , class 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_parameters() [1/2]

xtd::drawing::imaging::encoder_parameters::encoder_parameters ( )
inlineexplicit

Initializes a new instance of the xtd::drawing::imaging::encoder_parameters class that can contain one xtd::drawing::imaging::encoder_parameter object.

Remarks
Some of the xtd::drawing::image::save and xtd::drawing::image::ssave_add methods receive an xtd::drawing::imaging::encoder_parameters object as an argument. The xtd::drawing::image::get_encoder_parameter_list method returns an xtd::drawing::imaging::encoder_parameters object.

◆ encoder_parameters() [2/2]

xtd::drawing::imaging::encoder_parameters::encoder_parameters ( xtd::size  count)
inlineexplicit

Initializes a new instance of the xtd::drawing::imaging::encoder_parameters class that can contain the specified number of xtd::drawing::imaging::encoder_parameter objects.

Parameters
countA size_t that specifies the number of xtd::drawing::imaging::encoder_parameter objects that the xtd::drawing::imaging::encoder_parameters object can contain.
Remarks
Some of the xtd::drawing::image::save and xtd::drawing::image::ssave_add methods receive an xtd::drawing::imaging::encoder_parameters object as an argument. The xtd::drawing::image::get_encoder_parameter_list method returns an xtd::drawing::imaging::encoder_parameters object.

Member Function Documentation

◆ equals() [1/2]

bool xtd::drawing::imaging::encoder_parameters::equals ( const object obj) const
inlineoverridevirtualnoexcept

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]

bool xtd::drawing::imaging::encoder_parameters::equals ( const encoder_parameters other) const
inlineoverridenoexcept

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.

Member Data Documentation

◆ params

xtd::array<xtd::drawing::imaging::encoder_parameter> xtd::drawing::imaging::encoder_parameters::params

Gets or sets an array of EncoderParameter objects.

Parameters
paramsThe array of xtd::drawing::imaging::encoder_parameter objects.

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