xtd 0.2.0
Loading...
Searching...
No Matches
xtd::drawing::imaging::encoder_parameters Class Referencefinal
Inheritance diagram for xtd::drawing::imaging::encoder_parameters:
xtd::object xtd::iequatable< encoder_parameters > xtd::interface

Definition

Encapsulates an array of EncoderParameter objects.

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

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 (size_t 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 Properties

const std::vector< xtd::drawing::imaging::encoder_parameter > & params () const noexcept
 Gets an array of EncoderParameter objects.
 
std::vector< xtd::drawing::imaging::encoder_parameter > & params () noexcept
 Gets an array of EncoderParameter objects.
 
void params (const std::vector< xtd::drawing::imaging::encoder_parameter > &value) noexcept
 Sets an array of EncoderParameter objects.
 

Public Methods

bool equals (const encoder_parameters &value) const noexcept override
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
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.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object.
 
virtual xtd::ustring to_string () const noexcept
 Returns a xtd::ustring 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
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

◆ 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 ( size_t  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

◆ params() [1/3]

const std::vector< xtd::drawing::imaging::encoder_parameter > & xtd::drawing::imaging::encoder_parameters::params ( ) const
inlinenoexcept

Gets an array of EncoderParameter objects.

Returns
The array of xtd::drawing::imaging::encoder_parameter objects.

◆ params() [2/3]

std::vector< xtd::drawing::imaging::encoder_parameter > & xtd::drawing::imaging::encoder_parameters::params ( )
inlinenoexcept

Gets an array of EncoderParameter objects.

Returns
The array of xtd::drawing::imaging::encoder_parameter objects.

◆ params() [3/3]

void xtd::drawing::imaging::encoder_parameters::params ( const std::vector< xtd::drawing::imaging::encoder_parameter > &  value)
inlinenoexcept

Sets an array of EncoderParameter objects.

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

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