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

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
 
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.
 

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_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<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_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.

◆ 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
static void write_line()
Writes the current line terminator to the standard output stream using the specified format informati...
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
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: