xtd 1.0.0
Loading...
Searching...
No Matches
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< encoder_parameters, iequatable< encoder_parameters > >

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::usize 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

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

Additional Inherited Members

 object ()=default
 Create a new instance of the ultimate base class object.
virtual auto get_hash_code () const noexcept -> xtd::usize
 Serves as a hash function for a particular type.
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_parameters &) 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_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::usize 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 xtd::usize 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]

auto xtd::drawing::imaging::encoder_parameters::equals ( const object & obj) const -> bool
inlinenodiscardoverridevirtualnoexcept

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_parameters::equals ( const encoder_parameters & other) const -> bool
inlinenodiscardoverridenoexcept

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: