xtd::drawing::imaging::encoder_parameter Class Reference

Inheritance diagram for xtd::drawing::imaging::encoder_parameter:

Definition

Used to pass a value, or an array of values, to an image encoder.

Namespace

xtd::drawing::imaging

Library

xtd.drawing

Public Constructors
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, xtd::byte value)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified xtd::drawing::imaging::encoder object and one unsigned 8-bit integer. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_byte, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, int16 value)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified xtd::drawing::imaging::encoder object and one unsigned 16-bit integer. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_short, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, int64 value)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified xtd::drawing::imaging::encoder object and one unsigned 16-bit integer. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_long, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, const xtd::string &value)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified xtd::drawing::imaging::encoder object and a character string. The string is converted to a null-terminated ASCII string before it is stored in the xtd::drawing::imaging::encoder_parameter object. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_ascii, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the length of the ASCII string including the NULL terminator.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, xtd::byte value, bool undefined)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and one 8-bit value. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_undefined or xtd::drawing::imaging::encoder_parameter_value_type::value_type_byte, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, std::vector< xtd::byte > value)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and an array of unsigned 8-bit integers. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_byte, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the array.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, std::vector< int16 > value)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and an array of signed 16-bit integers. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeShort, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the array.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, std::vector< int32 > value)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and an array of signed 32-bit integers. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeLong, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the array.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, std::vector< int64 > value)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and an array of signed 32-bit integers. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeLong, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the array.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, std::vector< xtd::byte > value, bool undefined)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and an array of bytes. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_undefined or xtd::drawing::imaging::encoder_parameter_value_type::value_type_byte, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the array.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, int32 numerator, int32 denominator)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified xtd::drawing::imaging::encoder object and a pair of 32-bit integers. The pair of integers represents a fraction, the first integer being the numerator, and the second integer being the denominator. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type:value_type_rational, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, int32 numerator1, int32 denominator1, int32 numerator2, int32 denominator2)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and four, 32-bit integers. The four integers represent a range of fractions. The first two integers represent the smallest fraction in the range, and the remaining two integers represent the largest fraction in the range. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeRationalRange, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, std::vector< int32 > numerator, std::vector< int32 > denominator)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and two arrays of 32-bit integers. The two arrays represent an array of fractions. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeRational, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the numerator array, which must be the same as the number of elements in the denominator array.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, std::vector< int64 > rangebegin, std::vector< int64 > rangeend)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and two arrays of 64-bit integers. The two arrays represent an array integer ranges. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeLongRange, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the rangebegin array, which must be the same as the number of elements in the rangeend array.
	encoder_parameter (const xtd::drawing::imaging::encoder &encoder, int32 number_values, xtd::drawing::imaging::encoder_parameter_value_type type, const std::vector< xtd::byte > &value)
	Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object, number of values, data type of the values, and a pointer to the values stored in the xtd::drawing::imaging::encoder_parameter object.

Public Properties
const xtd::drawing::imaging::encoder &	encoder () const noexcept
	Gets the Encoder object associated with this xtd::drawing::imaging::encoder_parameter object. The Encoder object encapsulates the globally unique identifier (GUID) that specifies the category (for example Quality, ColorDepth, or Compression) of the parameter stored in this xtd::drawing::imaging::encoder_parameter object.
encoder_parameter &	encoder (const xtd::drawing::imaging::encoder &value)
	Sets the Encoder object associated with this xtd::drawing::imaging::encoder_parameter object. The Encoder object encapsulates the globally unique identifier (GUID) that specifies the category (for example Quality, ColorDepth, or Compression) of the parameter stored in this xtd::drawing::imaging::encoder_parameter object.
size_t	number_of_values () const noexcept
	Gets the number of elements in the array of values stored in this xtd::drawing::imaging::encoder_parameter object.
xtd::drawing::imaging::encoder_parameter_value_type	value_type () const noexcept
	Gets the data type of the values stored in this xtd::drawing::imaging::encoder_parameter object.
const std::vector< xtd::byte > &	value () const noexcept
	Gets The data value.

Public Methods
bool	equals (const encoder_parameter &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_parameter >
virtual bool	equals (const encoder_parameter &) 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_parameter() [1/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		xtd::byte	value
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified xtd::drawing::imaging::encoder object and one unsigned 8-bit integer. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_byte, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
value	An 8-bit unsigned integer that specifies the value stored in the xtd::drawing::imaging::encoder_parameter object.

encoder_parameter() [2/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		int16	value
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified xtd::drawing::imaging::encoder object and one unsigned 16-bit integer. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_short, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
value	An 16-bit signed integer that specifies the value stored in the xtd::drawing::imaging::encoder_parameter object.

encoder_parameter() [3/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		int64	value
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified xtd::drawing::imaging::encoder object and one unsigned 16-bit integer. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_long, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
value	A 64-bit integer that specifies the value stored in the xtd::drawing::imaging::encoder_parameter object. Must be nonnegative. This parameter is converted to a 32-bit integer before it is stored in the xtd::drawing::imaging::encoder_parameter object.

encoder_parameter() [4/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		const xtd::string &	value
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified xtd::drawing::imaging::encoder object and a character string. The string is converted to a null-terminated ASCII string before it is stored in the xtd::drawing::imaging::encoder_parameter object. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_ascii, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the length of the ASCII string including the NULL terminator.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
value	A xtd::utring that specifies the value stored in the xtd::drawing::imaging::encoder_parameter object.

encoder_parameter() [5/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		xtd::byte	value,
		bool	undefined
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and one 8-bit value. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_undefined or xtd::drawing::imaging::encoder_parameter_value_type::value_type_byte, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
value	A byte that specifies the value stored in the xtd::drawing::imaging::encoder_parameter object.
undefined	If true, the xtd::drawing::imaging::encoder_parameter::value_type property is set to xtd::drawing::imaging::encoder_parameter_value_type::value_type_undefined; otherwise, the xtd::drawing::imaging::encoder_parameter::value_type property is set to xtd::drawing::imaging::encoder_parameter_value_type::value_type_byte.

encoder_parameter() [6/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		std::vector< xtd::byte >	value
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and an array of unsigned 8-bit integers. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_byte, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the array.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
value	An array of 8-bit unsigned integers that specifies the values stored in the xtd::drawing::imaging::encoder_parameter object.

encoder_parameter() [7/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		std::vector< int16 >	value
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and an array of signed 16-bit integers. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeShort, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the array.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
value	An array of 16-bit signed integers that specifies the values stored in the xtd::drawing::imaging::encoder_parameter object.

encoder_parameter() [8/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		std::vector< int32 >	value
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and an array of signed 32-bit integers. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeLong, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the array.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
value	An array of 32-bit signed integers that specifies the values stored in the xtd::drawing::imaging::encoder_parameter object.

encoder_parameter() [9/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		std::vector< int64 >	value
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and an array of signed 32-bit integers. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeLong, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the array.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
value	An array of 64-bit integers that specifies the values stored in the xtd::drawing::imaging::encoder_parameter object. The integers in the array must be nonnegative. The 64-bit integers are converted to 32-bit integers before they are stored in the xtd::drawing::imaging::encoder_parameter object.

encoder_parameter() [10/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		std::vector< xtd::byte >	value,
		bool	undefined
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and an array of bytes. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type::value_type_undefined or xtd::drawing::imaging::encoder_parameter_value_type::value_type_byte, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the array.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
value	An array of bytes that specifies the values stored in the xtd::drawing::imaging::encoder_parameter object.
undefined	If true, the xtd::drawing::imaging::encoder_parameter::value_type property is set to xtd::drawing::imaging::encoder_parameter_value_type::value_type_undefined; otherwise, the xtd::drawing::imaging::encoder_parameter::value_type property is set to xtd::drawing::imaging::encoder_parameter_value_type::value_type_byte.

encoder_parameter() [11/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		int32	numerator,
		int32	denominator
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified xtd::drawing::imaging::encoder object and a pair of 32-bit integers. The pair of integers represents a fraction, the first integer being the numerator, and the second integer being the denominator. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to xtd::drawing::imaging::encoder_parameter_value_type:value_type_rational, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
numerator	A 32-bit integer that represents the numerator of a fraction. Must be nonnegative.
denominator	A 32-bit integer that represents the denominator of a fraction. Must be nonnegative.

encoder_parameter() [12/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		int32	numerator1,
		int32	denominator1,
		int32	numerator2,
		int32	denominator2
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and four, 32-bit integers. The four integers represent a range of fractions. The first two integers represent the smallest fraction in the range, and the remaining two integers represent the largest fraction in the range. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeRationalRange, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to 1.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
numerator1	A 32-bit integer that represents the numerator of the smallest fraction in the range. Must be nonnegative.
denominator1	A 32-bit integer that represents the denominator of the smallest fraction in the range. Must be nonnegative.
numerator2	A 32-bit integer that represents the denominator of the smallest fraction in the range. Must be nonnegative.
denominator2	A 32-bit integer that represents the numerator of the largest fraction in the range. Must be nonnegative.

encoder_parameter() [13/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		std::vector< int32 >	numerator,
		std::vector< int32 >	denominator
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and two arrays of 32-bit integers. The two arrays represent an array of fractions. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeRational, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the numerator array, which must be the same as the number of elements in the denominator array.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
numerator	An array of 32-bit integers that specifies the numerators of the fractions. The integers in the array must be nonnegative.
denominator1	An array of 32-bit integers that specifies the denominators of the fractions. The integers in the array must be nonnegative. A denominator of a given index is paired with the numerator of the same index.

encoder_parameter() [14/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		std::vector< int64 >	rangebegin,
		std::vector< int64 >	rangeend
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object and two arrays of 64-bit integers. The two arrays represent an array integer ranges. Sets the xtd::drawing::imaging::encoder_parameter::value_type property to ValueTypeLongRange, and sets the xtd::drawing::imaging::encoder_parameter::number_of_values property to the number of elements in the rangebegin array, which must be the same as the number of elements in the rangeend array.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
rangebegin	An array of 64-bit integers that specifies the minimum values for the integer ranges. The integers in the array must be nonnegative. The 64-bit integers are converted to 32-bit integers before they are stored in the xtd::drawing::imaging::encoder_parameter object.
rangeend	An array of 64-bit integers that specifies the maximum values for the integer ranges. The integers in the array must be nonnegative. The 64-bit integers are converted to 32-bit integers before they are stored in the EncoderParameters object. A maximum value of a given index is paired with the minimum value of the same index.

encoder_parameter() [15/15]

xtd::drawing::imaging::encoder_parameter::encoder_parameter	(	const xtd::drawing::imaging::encoder &	encoder,
		int32	number_values,
		xtd::drawing::imaging::encoder_parameter_value_type	type,
		const std::vector< xtd::byte > &	value
	)

Initializes a new instance of the xtd::drawing::imaging::encoder_parameter class with the specified Encoder object, number of values, data type of the values, and a pointer to the values stored in the xtd::drawing::imaging::encoder_parameter object.

Parameters

encoder	An xtd::drawing::imaging::encoder object that encapsulates the globally unique identifier of the parameter category.
type
value

Member Function Documentation

encoder() [1/2]

const xtd::drawing::imaging::encoder & xtd::drawing::imaging::encoder_parameter::encoder ( ) const

noexcept

Gets the Encoder object associated with this xtd::drawing::imaging::encoder_parameter object. The Encoder object encapsulates the globally unique identifier (GUID) that specifies the category (for example Quality, ColorDepth, or Compression) of the parameter stored in this xtd::drawing::imaging::encoder_parameter object.

Returns

An Encoder object that encapsulates the GUID that specifies the category of the parameter stored in this xtd::drawing::imaging::encoder_parameter object.

encoder() [2/2]

encoder_parameter & xtd::drawing::imaging::encoder_parameter::encoder

(

const xtd::drawing::imaging::encoder &

value

)

Sets the Encoder object associated with this xtd::drawing::imaging::encoder_parameter object. The Encoder object encapsulates the globally unique identifier (GUID) that specifies the category (for example Quality, ColorDepth, or Compression) of the parameter stored in this xtd::drawing::imaging::encoder_parameter object.

Parameters

value

An Encoder object that encapsulates the GUID that specifies the category of the parameter stored in this xtd::drawing::imaging::encoder_parameter object.

Returns

This current instance.

number_of_values()

size_t xtd::drawing::imaging::encoder_parameter::number_of_values ( ) const

noexcept

Gets the number of elements in the array of values stored in this xtd::drawing::imaging::encoder_parameter object.

Returns

An integer that indicates the number of elements in the array of values stored in this xtd::drawing::imaging::encoder_parameter object.

value_type()

xtd::drawing::imaging::encoder_parameter_value_type xtd::drawing::imaging::encoder_parameter::value_type ( ) const

noexcept

Gets the data type of the values stored in this xtd::drawing::imaging::encoder_parameter object.

Returns

A member of the EncoderParameterValueType enumeration that indicates the data type of the values stored in this xtd::drawing::imaging::encoder_parameter object.

value()

const std::vector< xtd::byte > & xtd::drawing::imaging::encoder_parameter::value ( ) const

noexcept

Gets The data value.

Returns

The data value.

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

obj	The 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

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_a	The first object to compare.
object_b	The 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

---

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

• xtd.drawing/include/xtd/drawing/imaging/encoder_parameter.h