Asposecpplib
System::Drawing::Imaging::EncoderParameter Class Reference

Serves as a container used to pass values to an image encoder. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Object.

Public Member Functions

 EncoderParameter ()
 Constructs a new instance of EncoderParameter class. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, uint8_t value, bool undefined=false)
 Constructs a new instance of EncoderParameter class. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, int16_t value)
 Constructs a new instance of EncoderParameter class. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, int64_t value)
 Constructs a new instance of EncoderParameter class. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, int32_t value)
 Constructs a new instance of EncoderParameter class. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, int32_t numerator, int32_t denominator)
 Constructs a new instance of EncoderParameter class that represents a fraction. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, int64_t rangebegin, int64_t rangeend)
 Constructs a new instance of EncoderParameter class that represents a range of integer values. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, int32_t numerator1, int32_t demoninator1, int32_t numerator2, int32_t demoninator2)
 Constructs a new instance of EncoderParameter class that represents a range of fractions. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, const String &value)
 Constructs a new instance of EncoderParameter class. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, const ArrayPtr< uint8_t > &value, bool undefined=false)
 Constructs a new instance of EncoderParameter class that represents an array of values. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, const ArrayPtr< int16_t > &value)
 Constructs a new instance of EncoderParameter class that represents an array of values. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, const ArrayPtr< int64_t > &value)
 Constructs a new instance of EncoderParameter class that represents an array of values. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, const ArrayPtr< int32_t > &numerator, const ArrayPtr< int32_t > &denominator)
 Constructs a new instance of EncoderParameter class that represents an array of fractions. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, const ArrayPtr< int64_t > &rangebegin, const ArrayPtr< int64_t > &rangeend)
 Constructs a new instance of EncoderParameter class that represents an array of ranges of integers. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, const ArrayPtr< int32_t > &numerator1, const ArrayPtr< int32_t > &denominator1, const ArrayPtr< int32_t > &numerator2, const ArrayPtr< int32_t > &denominator2)
 Constructs a new instance of EncoderParameter class that represents an array of ranges of fractions. More...
 
 EncoderParameter (const SharedPtr< Encoder > &encoder, int numberValues, EncoderParameterValueType type, void *value)
 Constructs a new instance of EncoderParameter class that represents the specified number of values of the specified type which are read from the specified buffer. More...
 
 ~EncoderParameter ()
 Destructor. More...
 
EncoderPtr get_Encoder () const
 Returns the Encoder object associated with the current EncoderParameter object. More...
 
void set_Encoder (const EncoderPtr &value)
 Associates the specified Encoder object with the current EncoderParameter object. More...
 
EncoderParameterValueType get_Type () const
 Returns the type of the value(s) represented by the current object. More...
 
int get_NumberOfValues () const
 Returns the number of value represented by the current object. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Serves as a container used to pass values to an image encoder. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ EncoderParameter() [1/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( )

Constructs a new instance of EncoderParameter class.

◆ EncoderParameter() [2/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
uint8_t  value,
bool  undefined = false 
)

Constructs a new instance of EncoderParameter class.

Parameters
encoderSpecifies the parameter category
valueAn unsigend 8-bit integer value to be represted by the object being created
undefinedTrue if the value should be treated as having an undefined type, otherwise - false

◆ EncoderParameter() [3/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
int16_t  value 
)

Constructs a new instance of EncoderParameter class.

Parameters
encoderSpecifies the parameter category
valueA 16-bit integer value to be represted by the object being created

◆ EncoderParameter() [4/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
int64_t  value 
)

Constructs a new instance of EncoderParameter class.

Parameters
encoderSpecifies the parameter category
valueA 64-bit integer value to be represted by the object being created

◆ EncoderParameter() [5/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
int32_t  value 
)

Constructs a new instance of EncoderParameter class.

Parameters
encoderSpecifies the parameter category
valueA 32-bit integer value to be represted by the object being created

◆ EncoderParameter() [6/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
int32_t  numerator,
int32_t  denominator 
)

Constructs a new instance of EncoderParameter class that represents a fraction.

Parameters
encoderSpecifies the parameter category
numeratorA numerator of the fraction to be represented by the object being created
denominatorA denominator of the fraction to be represented by the object being created

◆ EncoderParameter() [7/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
int64_t  rangebegin,
int64_t  rangeend 
)

Constructs a new instance of EncoderParameter class that represents a range of integer values.

Parameters
encoderSpecifies the parameter category
rangebeginThe smallest value in the range
rangeendThe largest value in the range

◆ EncoderParameter() [8/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
int32_t  numerator1,
int32_t  demoninator1,
int32_t  numerator2,
int32_t  demoninator2 
)

Constructs a new instance of EncoderParameter class that represents a range of fractions.

Parameters
encoderSpecifies the parameter category
numerator1A numerator of the smallest fraction in the range
numerator2A numerator of the largest fraction in the range
demoninator1A denominator of the smallest fraction in the range
demoninator2A denominator of the largest fraction in the range

◆ EncoderParameter() [9/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
const String value 
)

Constructs a new instance of EncoderParameter class.

Parameters
encoderSpecifies the parameter category
valueA string to be represted by the object being created

◆ EncoderParameter() [10/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
const ArrayPtr< uint8_t > &  value,
bool  undefined = false 
)

Constructs a new instance of EncoderParameter class that represents an array of values.

Parameters
encoderSpecifies the parameter category
valueAn array of unsigend 8-bit integer values to be represted by the object being created
undefinedTrue if the values in value array should be treated as having an undefined type, otherwise - false

◆ EncoderParameter() [11/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
const ArrayPtr< int16_t > &  value 
)

Constructs a new instance of EncoderParameter class that represents an array of values.

Parameters
encoderSpecifies the parameter category
valueAn array of 16-bit integer values to be represted by the object being created

◆ EncoderParameter() [12/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
const ArrayPtr< int64_t > &  value 
)

Constructs a new instance of EncoderParameter class that represents an array of values.

Parameters
encoderSpecifies the parameter category
valueAn array of 64-bit integer values to be represted by the object being created

◆ EncoderParameter() [13/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
const ArrayPtr< int32_t > &  numerator,
const ArrayPtr< int32_t > &  denominator 
)

Constructs a new instance of EncoderParameter class that represents an array of fractions.

Parameters
encoderSpecifies the parameter category
numeratorAn array of numerators of the fractions to be represented by the object being created
denominatorAn array of denominators of the fractions to be represented by the object being created

◆ EncoderParameter() [14/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
const ArrayPtr< int64_t > &  rangebegin,
const ArrayPtr< int64_t > &  rangeend 
)

Constructs a new instance of EncoderParameter class that represents an array of ranges of integers.

Parameters
encoderSpecifies the parameter category
rangebeginAn array that contains the smallest values of each range
rangeendAn arry that contains the largest values of each range

◆ EncoderParameter() [15/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
const ArrayPtr< int32_t > &  numerator1,
const ArrayPtr< int32_t > &  denominator1,
const ArrayPtr< int32_t > &  numerator2,
const ArrayPtr< int32_t > &  denominator2 
)

Constructs a new instance of EncoderParameter class that represents an array of ranges of fractions.

Parameters
encoderSpecifies the parameter category
numerator1An array that contains numerators of the smallest fractions of each range
numerator2An array that contains numerators of the fractions fractions of each range
denominator1An array that contains denominators of the smallest fractions of each range
denominator2An array that contains denominators of the largest fractions of each range

◆ EncoderParameter() [16/16]

System::Drawing::Imaging::EncoderParameter::EncoderParameter ( const SharedPtr< Encoder > &  encoder,
int  numberValues,
EncoderParameterValueType  type,
void *  value 
)

Constructs a new instance of EncoderParameter class that represents the specified number of values of the specified type which are read from the specified buffer.

Parameters
encoderSpecifies the parameter category
numberValuesSpecifies the number of values
typeSpecifies the type of values
valueA pointer to the buffer to read the values from

◆ ~EncoderParameter()

System::Drawing::Imaging::EncoderParameter::~EncoderParameter ( )

Destructor.

Member Function Documentation

◆ get_Encoder()

EncoderPtr System::Drawing::Imaging::EncoderParameter::get_Encoder ( ) const

Returns the Encoder object associated with the current EncoderParameter object.

◆ get_NumberOfValues()

int System::Drawing::Imaging::EncoderParameter::get_NumberOfValues ( ) const

Returns the number of value represented by the current object.

◆ get_Type()

EncoderParameterValueType System::Drawing::Imaging::EncoderParameter::get_Type ( ) const

Returns the type of the value(s) represented by the current object.

◆ set_Encoder()

void System::Drawing::Imaging::EncoderParameter::set_Encoder ( const EncoderPtr value)

Associates the specified Encoder object with the current EncoderParameter object.

Parameters
valueThe Encoder object to associate the current EncoderParameter object with