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

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

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

Definition

Public Constructors

Public Properties

Public Methods

Additional Inherited Members