EncoderParameter

EncoderParameter class

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.

class EncoderParameter : public System::Object

Methods

MethodDescription
EncoderParameter()Constructs a new instance of EncoderParameter class.
EncoderParameter(const SharedPtr<Encoder>&, uint8_t, bool)Constructs a new instance of EncoderParameter class.
EncoderParameter(const SharedPtr<Encoder>&, int16_t)Constructs a new instance of EncoderParameter class.
EncoderParameter(const SharedPtr<Encoder>&, int64_t)Constructs a new instance of EncoderParameter class.
EncoderParameter(const SharedPtr<Encoder>&, int32_t)Constructs a new instance of EncoderParameter class.
EncoderParameter(const SharedPtr<Encoder>&, int32_t, int32_t)Constructs a new instance of EncoderParameter class that represents a fraction.
EncoderParameter(const SharedPtr<Encoder>&, int64_t, int64_t)Constructs a new instance of EncoderParameter class that represents a range of integer values.
EncoderParameter(const SharedPtr<Encoder>&, int32_t, int32_t, int32_t, int32_t)Constructs a new instance of EncoderParameter class that represents a range of fractions.
EncoderParameter(const SharedPtr<Encoder>&, const String&)Constructs a new instance of EncoderParameter class.
EncoderParameter(const SharedPtr<Encoder>&, const ArrayPtr<uint8_t>&, bool)Constructs a new instance of EncoderParameter class that represents an array of values.
EncoderParameter(const SharedPtr<Encoder>&, const ArrayPtr<int16_t>&)Constructs a new instance of EncoderParameter class that represents an array of values.
EncoderParameter(const SharedPtr<Encoder>&, const ArrayPtr<int64_t>&)Constructs a new instance of EncoderParameter class that represents an array of values.
EncoderParameter(const SharedPtr<Encoder>&, const ArrayPtr<int32_t>&, const ArrayPtr<int32_t>&)Constructs a new instance of EncoderParameter class that represents an array of fractions.
EncoderParameter(const SharedPtr<Encoder>&, const ArrayPtr<int64_t>&, const ArrayPtr<int64_t>&)Constructs a new instance of EncoderParameter class that represents an array of ranges of integers.
EncoderParameter(const SharedPtr<Encoder>&, const ArrayPtr<int32_t>&, const ArrayPtr<int32_t>&, const ArrayPtr<int32_t>&, const ArrayPtr<int32_t>&)Constructs a new instance of EncoderParameter class that represents an array of ranges of fractions.
EncoderParameter(const SharedPtr<Encoder>&, int, EncoderParameterValueType, void *)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.
virtual bool Equals(ptr)Compares objects using C# Object.Equals semantics.
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares reference type objects in C# style.
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares value type objects in C# style.
static bool Equals(float const&, float const&)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.
static bool Equals(double const&, double const&)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.
virtual bool FastCast(const Details::FastRttiBase&, void **) constFor internal purposes only.
EncoderPtr get_Encoder() constReturns the Encoder object associated with the current EncoderParameter object.
int get_NumberOfValues() constReturns the number of value represented by the current object.
EncoderParameterValueType get_Type() constReturns the type of the value(s) represented by the current object.
Detail::SmartPtrCounter * GetCounter()Gets reference counter data structure associated with the object.
virtual int32_t GetHashCode() constAnalog of C# Object.GetHashCode() method. Enables hashing of custom objects.
virtual const TypeInfo& GetType() constGets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) constCheck if object represents an instance of type described by targetType. Analog of C# ‘is’ operator.
void Lock()Implements C# lock() statement locking. Call directly or use LockContext sentry object.
virtual ptr MemberwiseClone() constAnalog of C# Object.MemberwiseClone() method. Enables cloning custom types.
Object()Creates object. Initializes all internal data structures.
Object(Object const&)Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
Object& operator=(Object const&)Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
static bool ReferenceEquals(ptr const&, ptr const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t)Reference-compares value type object with nullptr.
bool ReferenceEquals(String const&, std::nullptr_t)Specialization of Object::ReferenceEquals for case of string and nullptr.
bool ReferenceEquals(String const&, String const&)Specialization of Object::ReferenceEquals for case of strings.
int RemovedSharedRefs(int)Decreases shared reference count by specified value.
void set_Encoder(const EncoderPtr&)Associates the specified Encoder object with the current EncoderParameter object.
virtual void SetTemplateWeakPtr(uint32_t)Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
int SharedCount() constGets current value of shared reference counter.
Object * SharedRefAdded()Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
int SharedRefRemovedSafe()Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual String ToString() constAnalog of C# Object.ToString() method. Enables converting custom objects to string.
static const TypeInfo& Type()Implements C# typeof(System.Object) construct.
void Unlock()Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
Detail::SmartPtrCounter * WeakRefAdded()Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
void WeakRefRemoved()Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
~EncoderParameter()Destructor.
virtual ~Object()Destroys object. Frees all internal data structures.

See Also