API reference - Class QCameraImageProcessing

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QCameraImageProcessing

Class hierarchy: QCameraImageProcessing » QObject

Sub-classes: ColorFilter, QFlags_ColorFilter, WhiteBalanceMode, QFlags_WhiteBalanceMode

Public methods

[const]QCameraImageProcessing ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]doublebrightnessMethod double QCameraImageProcessing::brightness()
voidbrightness=(double value)Method void QCameraImageProcessing::setBrightness(double value)
[const]QCameraImageProcessing_ColorFiltercolorFilterMethod QCameraImageProcessing::ColorFilter QCameraImageProcessing::colorFilter()
voidcolorFilter=(const QCameraImageProcessing_ColorFilter filter)Method void QCameraImageProcessing::setColorFilter(QCameraImageProcessing::ColorFilter filter)
[const]doublecontrastMethod double QCameraImageProcessing::contrast()
voidcontrast=(double value)Method void QCameraImageProcessing::setContrast(double value)
[const]doubledenoisingLevelMethod double QCameraImageProcessing::denoisingLevel()
voiddenoisingLevel=(double value)Method void QCameraImageProcessing::setDenoisingLevel(double value)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QCameraImageProcessing::destroyed(QObject *)
[const]boolisAvailable?Method bool QCameraImageProcessing::isAvailable()
[const]boolisColorFilterSupported?(const QCameraImageProcessing_ColorFilter filter)Method bool QCameraImageProcessing::isColorFilterSupported(QCameraImageProcessing::ColorFilter filter)
[const]boolisWhiteBalanceModeSupported?(const QCameraImageProcessing_WhiteBalanceMode mode)Method bool QCameraImageProcessing::isWhiteBalanceModeSupported(QCameraImageProcessing::WhiteBalanceMode mode)
[const]doublemanualWhiteBalanceMethod double QCameraImageProcessing::manualWhiteBalance()
voidmanualWhiteBalance=(double colorTemperature)Method void QCameraImageProcessing::setManualWhiteBalance(double colorTemperature)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QCameraImageProcessing::objectNameChanged(const QString &objectName)
[const]doublesaturationMethod double QCameraImageProcessing::saturation()
voidsaturation=(double value)Method void QCameraImageProcessing::setSaturation(double value)
voidsetBrightness(double value)Method void QCameraImageProcessing::setBrightness(double value)
voidsetColorFilter(const QCameraImageProcessing_ColorFilter filter)Method void QCameraImageProcessing::setColorFilter(QCameraImageProcessing::ColorFilter filter)
voidsetContrast(double value)Method void QCameraImageProcessing::setContrast(double value)
voidsetDenoisingLevel(double value)Method void QCameraImageProcessing::setDenoisingLevel(double value)
voidsetManualWhiteBalance(double colorTemperature)Method void QCameraImageProcessing::setManualWhiteBalance(double colorTemperature)
voidsetSaturation(double value)Method void QCameraImageProcessing::setSaturation(double value)
voidsetSharpeningLevel(double value)Method void QCameraImageProcessing::setSharpeningLevel(double value)
voidsetWhiteBalanceMode(const QCameraImageProcessing_WhiteBalanceMode mode)Method void QCameraImageProcessing::setWhiteBalanceMode(QCameraImageProcessing::WhiteBalanceMode mode)
[const]doublesharpeningLevelMethod double QCameraImageProcessing::sharpeningLevel()
voidsharpeningLevel=(double value)Method void QCameraImageProcessing::setSharpeningLevel(double value)
[const]QCameraImageProcessing_WhiteBalanceModewhiteBalanceModeMethod QCameraImageProcessing::WhiteBalanceMode QCameraImageProcessing::whiteBalanceMode()
voidwhiteBalanceMode=(const QCameraImageProcessing_WhiteBalanceMode mode)Method void QCameraImageProcessing::setWhiteBalanceMode(QCameraImageProcessing::WhiteBalanceMode mode)

Public static methods and constants

[static,const]QCameraImageProcessing_ColorFilterColorFilterAquaEnum constant QCameraImageProcessing::ColorFilterAqua
[static,const]QCameraImageProcessing_ColorFilterColorFilterBlackboardEnum constant QCameraImageProcessing::ColorFilterBlackboard
[static,const]QCameraImageProcessing_ColorFilterColorFilterGrayscaleEnum constant QCameraImageProcessing::ColorFilterGrayscale
[static,const]QCameraImageProcessing_ColorFilterColorFilterNegativeEnum constant QCameraImageProcessing::ColorFilterNegative
[static,const]QCameraImageProcessing_ColorFilterColorFilterNoneEnum constant QCameraImageProcessing::ColorFilterNone
[static,const]QCameraImageProcessing_ColorFilterColorFilterPosterizeEnum constant QCameraImageProcessing::ColorFilterPosterize
[static,const]QCameraImageProcessing_ColorFilterColorFilterSepiaEnum constant QCameraImageProcessing::ColorFilterSepia
[static,const]QCameraImageProcessing_ColorFilterColorFilterSolarizeEnum constant QCameraImageProcessing::ColorFilterSolarize
[static,const]QCameraImageProcessing_ColorFilterColorFilterVendorEnum constant QCameraImageProcessing::ColorFilterVendor
[static,const]QCameraImageProcessing_ColorFilterColorFilterWhiteboardEnum constant QCameraImageProcessing::ColorFilterWhiteboard
[static,const]QCameraImageProcessing_WhiteBalanceModeWhiteBalanceAutoEnum constant QCameraImageProcessing::WhiteBalanceAuto
[static,const]QCameraImageProcessing_WhiteBalanceModeWhiteBalanceCloudyEnum constant QCameraImageProcessing::WhiteBalanceCloudy
[static,const]QCameraImageProcessing_WhiteBalanceModeWhiteBalanceFlashEnum constant QCameraImageProcessing::WhiteBalanceFlash
[static,const]QCameraImageProcessing_WhiteBalanceModeWhiteBalanceFluorescentEnum constant QCameraImageProcessing::WhiteBalanceFluorescent
[static,const]QCameraImageProcessing_WhiteBalanceModeWhiteBalanceManualEnum constant QCameraImageProcessing::WhiteBalanceManual
[static,const]QCameraImageProcessing_WhiteBalanceModeWhiteBalanceShadeEnum constant QCameraImageProcessing::WhiteBalanceShade
[static,const]QCameraImageProcessing_WhiteBalanceModeWhiteBalanceSunlightEnum constant QCameraImageProcessing::WhiteBalanceSunlight
[static,const]QCameraImageProcessing_WhiteBalanceModeWhiteBalanceSunsetEnum constant QCameraImageProcessing::WhiteBalanceSunset
[static,const]QCameraImageProcessing_WhiteBalanceModeWhiteBalanceTungstenEnum constant QCameraImageProcessing::WhiteBalanceTungsten
[static,const]QCameraImageProcessing_WhiteBalanceModeWhiteBalanceVendorEnum constant QCameraImageProcessing::WhiteBalanceVendor
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QCameraImageProcessing::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QCameraImageProcessing::trUtf8(const char *s, const char *c, int n)

Detailed description

ColorFilterAqua

Signature: [static,const] QCameraImageProcessing_ColorFilter ColorFilterAqua

Description: Enum constant QCameraImageProcessing::ColorFilterAqua

Python specific notes:
The object exposes a readable attribute 'ColorFilterAqua'. This is the getter.

ColorFilterBlackboard

Signature: [static,const] QCameraImageProcessing_ColorFilter ColorFilterBlackboard

Description: Enum constant QCameraImageProcessing::ColorFilterBlackboard

Python specific notes:
The object exposes a readable attribute 'ColorFilterBlackboard'. This is the getter.

ColorFilterGrayscale

Signature: [static,const] QCameraImageProcessing_ColorFilter ColorFilterGrayscale

Description: Enum constant QCameraImageProcessing::ColorFilterGrayscale

Python specific notes:
The object exposes a readable attribute 'ColorFilterGrayscale'. This is the getter.

ColorFilterNegative

Signature: [static,const] QCameraImageProcessing_ColorFilter ColorFilterNegative

Description: Enum constant QCameraImageProcessing::ColorFilterNegative

Python specific notes:
The object exposes a readable attribute 'ColorFilterNegative'. This is the getter.

ColorFilterNone

Signature: [static,const] QCameraImageProcessing_ColorFilter ColorFilterNone

Description: Enum constant QCameraImageProcessing::ColorFilterNone

Python specific notes:
The object exposes a readable attribute 'ColorFilterNone'. This is the getter.

ColorFilterPosterize

Signature: [static,const] QCameraImageProcessing_ColorFilter ColorFilterPosterize

Description: Enum constant QCameraImageProcessing::ColorFilterPosterize

Python specific notes:
The object exposes a readable attribute 'ColorFilterPosterize'. This is the getter.

ColorFilterSepia

Signature: [static,const] QCameraImageProcessing_ColorFilter ColorFilterSepia

Description: Enum constant QCameraImageProcessing::ColorFilterSepia

Python specific notes:
The object exposes a readable attribute 'ColorFilterSepia'. This is the getter.

ColorFilterSolarize

Signature: [static,const] QCameraImageProcessing_ColorFilter ColorFilterSolarize

Description: Enum constant QCameraImageProcessing::ColorFilterSolarize

Python specific notes:
The object exposes a readable attribute 'ColorFilterSolarize'. This is the getter.

ColorFilterVendor

Signature: [static,const] QCameraImageProcessing_ColorFilter ColorFilterVendor

Description: Enum constant QCameraImageProcessing::ColorFilterVendor

Python specific notes:
The object exposes a readable attribute 'ColorFilterVendor'. This is the getter.

ColorFilterWhiteboard

Signature: [static,const] QCameraImageProcessing_ColorFilter ColorFilterWhiteboard

Description: Enum constant QCameraImageProcessing::ColorFilterWhiteboard

Python specific notes:
The object exposes a readable attribute 'ColorFilterWhiteboard'. This is the getter.

WhiteBalanceAuto

Signature: [static,const] QCameraImageProcessing_WhiteBalanceMode WhiteBalanceAuto

Description: Enum constant QCameraImageProcessing::WhiteBalanceAuto

Python specific notes:
The object exposes a readable attribute 'WhiteBalanceAuto'. This is the getter.

WhiteBalanceCloudy

Signature: [static,const] QCameraImageProcessing_WhiteBalanceMode WhiteBalanceCloudy

Description: Enum constant QCameraImageProcessing::WhiteBalanceCloudy

Python specific notes:
The object exposes a readable attribute 'WhiteBalanceCloudy'. This is the getter.

WhiteBalanceFlash

Signature: [static,const] QCameraImageProcessing_WhiteBalanceMode WhiteBalanceFlash

Description: Enum constant QCameraImageProcessing::WhiteBalanceFlash

Python specific notes:
The object exposes a readable attribute 'WhiteBalanceFlash'. This is the getter.

WhiteBalanceFluorescent

Signature: [static,const] QCameraImageProcessing_WhiteBalanceMode WhiteBalanceFluorescent

Description: Enum constant QCameraImageProcessing::WhiteBalanceFluorescent

Python specific notes:
The object exposes a readable attribute 'WhiteBalanceFluorescent'. This is the getter.

WhiteBalanceManual

Signature: [static,const] QCameraImageProcessing_WhiteBalanceMode WhiteBalanceManual

Description: Enum constant QCameraImageProcessing::WhiteBalanceManual

Python specific notes:
The object exposes a readable attribute 'WhiteBalanceManual'. This is the getter.

WhiteBalanceShade

Signature: [static,const] QCameraImageProcessing_WhiteBalanceMode WhiteBalanceShade

Description: Enum constant QCameraImageProcessing::WhiteBalanceShade

Python specific notes:
The object exposes a readable attribute 'WhiteBalanceShade'. This is the getter.

WhiteBalanceSunlight

Signature: [static,const] QCameraImageProcessing_WhiteBalanceMode WhiteBalanceSunlight

Description: Enum constant QCameraImageProcessing::WhiteBalanceSunlight

Python specific notes:
The object exposes a readable attribute 'WhiteBalanceSunlight'. This is the getter.

WhiteBalanceSunset

Signature: [static,const] QCameraImageProcessing_WhiteBalanceMode WhiteBalanceSunset

Description: Enum constant QCameraImageProcessing::WhiteBalanceSunset

Python specific notes:
The object exposes a readable attribute 'WhiteBalanceSunset'. This is the getter.

WhiteBalanceTungsten

Signature: [static,const] QCameraImageProcessing_WhiteBalanceMode WhiteBalanceTungsten

Description: Enum constant QCameraImageProcessing::WhiteBalanceTungsten

Python specific notes:
The object exposes a readable attribute 'WhiteBalanceTungsten'. This is the getter.

WhiteBalanceVendor

Signature: [static,const] QCameraImageProcessing_WhiteBalanceMode WhiteBalanceVendor

Description: Enum constant QCameraImageProcessing::WhiteBalanceVendor

Python specific notes:
The object exposes a readable attribute 'WhiteBalanceVendor'. This is the getter.

_const_cast

Signature: [const] QCameraImageProcessing ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

brightness

Signature: [const] double brightness

Description: Method double QCameraImageProcessing::brightness()

Python specific notes:
The object exposes a readable attribute 'brightness'. This is the getter.

brightness=

Signature: void brightness= (double value)

Description: Method void QCameraImageProcessing::setBrightness(double value)

Python specific notes:
The object exposes a writable attribute 'brightness'. This is the setter.

colorFilter

Signature: [const] QCameraImageProcessing_ColorFilter colorFilter

Description: Method QCameraImageProcessing::ColorFilter QCameraImageProcessing::colorFilter()

Python specific notes:
The object exposes a readable attribute 'colorFilter'. This is the getter.

colorFilter=

Signature: void colorFilter= (const QCameraImageProcessing_ColorFilter filter)

Description: Method void QCameraImageProcessing::setColorFilter(QCameraImageProcessing::ColorFilter filter)

Python specific notes:
The object exposes a writable attribute 'colorFilter'. This is the setter.

contrast

Signature: [const] double contrast

Description: Method double QCameraImageProcessing::contrast()

Python specific notes:
The object exposes a readable attribute 'contrast'. This is the getter.

contrast=

Signature: void contrast= (double value)

Description: Method void QCameraImageProcessing::setContrast(double value)

Python specific notes:
The object exposes a writable attribute 'contrast'. This is the setter.

denoisingLevel

Signature: [const] double denoisingLevel

Description: Method double QCameraImageProcessing::denoisingLevel()

Python specific notes:
The object exposes a readable attribute 'denoisingLevel'. This is the getter.

denoisingLevel=

Signature: void denoisingLevel= (double value)

Description: Method void QCameraImageProcessing::setDenoisingLevel(double value)

Python specific notes:
The object exposes a writable attribute 'denoisingLevel'. This is the setter.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QCameraImageProcessing::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

isAvailable?

Signature: [const] bool isAvailable?

Description: Method bool QCameraImageProcessing::isAvailable()

isColorFilterSupported?

Signature: [const] bool isColorFilterSupported? (const QCameraImageProcessing_ColorFilter filter)

Description: Method bool QCameraImageProcessing::isColorFilterSupported(QCameraImageProcessing::ColorFilter filter)

isWhiteBalanceModeSupported?

Signature: [const] bool isWhiteBalanceModeSupported? (const QCameraImageProcessing_WhiteBalanceMode mode)

Description: Method bool QCameraImageProcessing::isWhiteBalanceModeSupported(QCameraImageProcessing::WhiteBalanceMode mode)

manualWhiteBalance

Signature: [const] double manualWhiteBalance

Description: Method double QCameraImageProcessing::manualWhiteBalance()

Python specific notes:
The object exposes a readable attribute 'manualWhiteBalance'. This is the getter.

manualWhiteBalance=

Signature: void manualWhiteBalance= (double colorTemperature)

Description: Method void QCameraImageProcessing::setManualWhiteBalance(double colorTemperature)

Python specific notes:
The object exposes a writable attribute 'manualWhiteBalance'. This is the setter.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QCameraImageProcessing::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

saturation

Signature: [const] double saturation

Description: Method double QCameraImageProcessing::saturation()

Python specific notes:
The object exposes a readable attribute 'saturation'. This is the getter.

saturation=

Signature: void saturation= (double value)

Description: Method void QCameraImageProcessing::setSaturation(double value)

Python specific notes:
The object exposes a writable attribute 'saturation'. This is the setter.

setBrightness

Signature: void setBrightness (double value)

Description: Method void QCameraImageProcessing::setBrightness(double value)

Python specific notes:
The object exposes a writable attribute 'brightness'. This is the setter.

setColorFilter

Signature: void setColorFilter (const QCameraImageProcessing_ColorFilter filter)

Description: Method void QCameraImageProcessing::setColorFilter(QCameraImageProcessing::ColorFilter filter)

Python specific notes:
The object exposes a writable attribute 'colorFilter'. This is the setter.

setContrast

Signature: void setContrast (double value)

Description: Method void QCameraImageProcessing::setContrast(double value)

Python specific notes:
The object exposes a writable attribute 'contrast'. This is the setter.

setDenoisingLevel

Signature: void setDenoisingLevel (double value)

Description: Method void QCameraImageProcessing::setDenoisingLevel(double value)

Python specific notes:
The object exposes a writable attribute 'denoisingLevel'. This is the setter.

setManualWhiteBalance

Signature: void setManualWhiteBalance (double colorTemperature)

Description: Method void QCameraImageProcessing::setManualWhiteBalance(double colorTemperature)

Python specific notes:
The object exposes a writable attribute 'manualWhiteBalance'. This is the setter.

setSaturation

Signature: void setSaturation (double value)

Description: Method void QCameraImageProcessing::setSaturation(double value)

Python specific notes:
The object exposes a writable attribute 'saturation'. This is the setter.

setSharpeningLevel

Signature: void setSharpeningLevel (double value)

Description: Method void QCameraImageProcessing::setSharpeningLevel(double value)

Python specific notes:
The object exposes a writable attribute 'sharpeningLevel'. This is the setter.

setWhiteBalanceMode

Signature: void setWhiteBalanceMode (const QCameraImageProcessing_WhiteBalanceMode mode)

Description: Method void QCameraImageProcessing::setWhiteBalanceMode(QCameraImageProcessing::WhiteBalanceMode mode)

Python specific notes:
The object exposes a writable attribute 'whiteBalanceMode'. This is the setter.

sharpeningLevel

Signature: [const] double sharpeningLevel

Description: Method double QCameraImageProcessing::sharpeningLevel()

Python specific notes:
The object exposes a readable attribute 'sharpeningLevel'. This is the getter.

sharpeningLevel=

Signature: void sharpeningLevel= (double value)

Description: Method void QCameraImageProcessing::setSharpeningLevel(double value)

Python specific notes:
The object exposes a writable attribute 'sharpeningLevel'. This is the setter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QCameraImageProcessing::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QCameraImageProcessing::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

whiteBalanceMode

Signature: [const] QCameraImageProcessing_WhiteBalanceMode whiteBalanceMode

Description: Method QCameraImageProcessing::WhiteBalanceMode QCameraImageProcessing::whiteBalanceMode()

Python specific notes:
The object exposes a readable attribute 'whiteBalanceMode'. This is the getter.

whiteBalanceMode=

Signature: void whiteBalanceMode= (const QCameraImageProcessing_WhiteBalanceMode mode)

Description: Method void QCameraImageProcessing::setWhiteBalanceMode(QCameraImageProcessing::WhiteBalanceMode mode)

Python specific notes:
The object exposes a writable attribute 'whiteBalanceMode'. This is the setter.