API reference - Class QImage

!=

Signature: [const] bool != (const QImage arg1)

Description: Method bool QImage::operator!=(const QImage &)

==

Signature: [const] bool == (const QImage arg1)

Description: Method bool QImage::operator==(const QImage &)

Format_ARGB32

Signature: [static,const] QImage_Format Format_ARGB32

Description: Enum constant QImage::Format_ARGB32

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

Format_ARGB32_Premultiplied

Signature: [static,const] QImage_Format Format_ARGB32_Premultiplied

Description: Enum constant QImage::Format_ARGB32_Premultiplied

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

Format_ARGB4444_Premultiplied

Signature: [static,const] QImage_Format Format_ARGB4444_Premultiplied

Description: Enum constant QImage::Format_ARGB4444_Premultiplied

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

Format_ARGB6666_Premultiplied

Signature: [static,const] QImage_Format Format_ARGB6666_Premultiplied

Description: Enum constant QImage::Format_ARGB6666_Premultiplied

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

Format_ARGB8555_Premultiplied

Signature: [static,const] QImage_Format Format_ARGB8555_Premultiplied

Description: Enum constant QImage::Format_ARGB8555_Premultiplied

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

Format_ARGB8565_Premultiplied

Signature: [static,const] QImage_Format Format_ARGB8565_Premultiplied

Description: Enum constant QImage::Format_ARGB8565_Premultiplied

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

Format_Indexed8

Signature: [static,const] QImage_Format Format_Indexed8

Description: Enum constant QImage::Format_Indexed8

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

Format_Invalid

Signature: [static,const] QImage_Format Format_Invalid

Description: Enum constant QImage::Format_Invalid

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

Format_Mono

Signature: [static,const] QImage_Format Format_Mono

Description: Enum constant QImage::Format_Mono

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

Format_MonoLSB

Signature: [static,const] QImage_Format Format_MonoLSB

Description: Enum constant QImage::Format_MonoLSB

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

Format_RGB16

Signature: [static,const] QImage_Format Format_RGB16

Description: Enum constant QImage::Format_RGB16

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

Format_RGB32

Signature: [static,const] QImage_Format Format_RGB32

Description: Enum constant QImage::Format_RGB32

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

Format_RGB444

Signature: [static,const] QImage_Format Format_RGB444

Description: Enum constant QImage::Format_RGB444

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

Format_RGB555

Signature: [static,const] QImage_Format Format_RGB555

Description: Enum constant QImage::Format_RGB555

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

Format_RGB666

Signature: [static,const] QImage_Format Format_RGB666

Description: Enum constant QImage::Format_RGB666

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

Format_RGB888

Signature: [static,const] QImage_Format Format_RGB888

Description: Enum constant QImage::Format_RGB888

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

InvertRgb

Signature: [static,const] QImage_InvertMode InvertRgb

Description: Enum constant QImage::InvertRgb

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

InvertRgba

Signature: [static,const] QImage_InvertMode InvertRgba

Description: Enum constant QImage::InvertRgba

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

NImageFormats

Signature: [static,const] QImage_Format NImageFormats

Description: Enum constant QImage::NImageFormats

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

_assign

Signature: void _assign (const QImage other)

Description: Assigns another object to self

_const_cast

Signature: [const] QImage 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.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_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.

_dup

Signature: [const] new QImage ptr _dup

Description: Creates a copy of self

_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.

allGray

Signature: [const] bool allGray

Description: Method bool QImage::allGray()

alphaChannel

Signature: [const] QImage alphaChannel

Description: Method QImage QImage::alphaChannel()

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

alphaChannel=

Signature: void alphaChannel= (const QImage alphaChannel)

Description: Method void QImage::setAlphaChannel(const QImage &alphaChannel)

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

assign

Signature: QImage assign (const QImage arg1)

Description: Method QImage &QImage::operator=(const QImage &)

bits

Signature: [const] string bits

Description: Method const unsigned char *QImage::bits()

byteCount

Signature: [const] int byteCount

Description: Method int QImage::byteCount()

bytesPerLine

Signature: [const] int bytesPerLine

Description: Method int QImage::bytesPerLine()

cacheKey

Signature: [const] long long cacheKey

Description: Method qint64 QImage::cacheKey()

color

Signature: [const] unsigned int color (int i)

Description: Method unsigned int QImage::color(int i)

colorCount

Signature: [const] int colorCount

Description: Method int QImage::colorCount()

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

colorCount=

Signature: void colorCount= (int arg1)

Description: Method void QImage::setColorCount(int)

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

colorTable

Signature: [const] unsigned int[] colorTable

Description: Method QVector<QRgb> QImage::colorTable()

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

colorTable=

Signature: void colorTable= ([] colors)

Description: Method void QImage::setColorTable(const QVector<QRgb> colors)

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

convertToFormat

(1) Signature: [const] QImage convertToFormat (const QImage_Format f, Qt_QFlags_ImageConversionFlag flags = Qt::AutoColor)

Description: Method QImage QImage::convertToFormat(QImage::Format f, QFlags<Qt::ImageConversionFlag> flags)

(2) Signature: [const] QImage convertToFormat (const QImage_Format f, unsigned int[] colorTable, Qt_QFlags_ImageConversionFlag flags = Qt::AutoColor)

Description: Method QImage QImage::convertToFormat(QImage::Format f, const QVector<QRgb> &colorTable, QFlags<Qt::ImageConversionFlag> flags)

copy

(1) Signature: [const] QImage copy (const QRect rect = QRect())

Description: Method QImage QImage::copy(const QRect &rect)

(2) Signature: [const] QImage copy (int x, int y, int w, int h)

Description: Method QImage QImage::copy(int x, int y, int w, int h)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

createAlphaMask

Signature: [const] QImage createAlphaMask (Qt_QFlags_ImageConversionFlag flags = Qt::AutoColor)

Description: Method QImage QImage::createAlphaMask(QFlags<Qt::ImageConversionFlag> flags)

createHeuristicMask

Signature: [const] QImage createHeuristicMask (bool clipTight = true)

Description: Method QImage QImage::createHeuristicMask(bool clipTight)

createMaskFromColor

Signature: [const] QImage createMaskFromColor (unsigned int color, const Qt_MaskMode mode = Qt::MaskInColor)

Description: Method QImage QImage::createMaskFromColor(unsigned int color, Qt::MaskMode mode)

depth

Signature: [const] int depth

Description: Method int QImage::depth()

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

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.

detach

Signature: void detach

Description: Method void QImage::detach()

dotsPerMeterX

Signature: [const] int dotsPerMeterX

Description: Method int QImage::dotsPerMeterX()

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

dotsPerMeterX=

Signature: void dotsPerMeterX= (int arg1)

Description: Method void QImage::setDotsPerMeterX(int)

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

dotsPerMeterY

Signature: [const] int dotsPerMeterY

Description: Method int QImage::dotsPerMeterY()

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

dotsPerMeterY=

Signature: void dotsPerMeterY= (int arg1)

Description: Method void QImage::setDotsPerMeterY(int)

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

dup

Signature: [const] new QImage ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

fill

Signature: void fill (unsigned int pixel)

Description: Method void QImage::fill(unsigned int pixel)

format

Signature: [const] QImage_Format format

Description: Method QImage::Format QImage::format()

fromData

(1) Signature: [static] QImage fromData (string data, int size, string format = 0)

Description: Static method QImage QImage::fromData(const unsigned char *data, int size, const char *format)

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

(2) Signature: [static] QImage fromData (bytes data, string format = 0)

Description: Static method QImage QImage::fromData(const QByteArray &data, const char *format)

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

hasAlphaChannel

Signature: [const] bool hasAlphaChannel

Description: Method bool QImage::hasAlphaChannel()

height

Signature: [const] int height

Description: Method int QImage::height()

invertPixels

Signature: void invertPixels (const QImage_InvertMode arg1 = QImage::InvertRgb)

Description: Method void QImage::invertPixels(QImage::InvertMode)

isDetached?

Signature: [const] bool isDetached?

Description: Method bool QImage::isDetached()

isGrayscale?

Signature: [const] bool isGrayscale?

Description: Method bool QImage::isGrayscale()

isNull?

Signature: [const] bool isNull?

Description: Method bool QImage::isNull()

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

load

(1) Signature: bool load (QIODevice ptr device, string format)

Description: Method bool QImage::load(QIODevice *device, const char *format)

(2) Signature: bool load (string fileName, string format = 0)

Description: Method bool QImage::load(const QString &fileName, const char *format)

loadFromData

(1) Signature: bool loadFromData (string buf, int len, string format = 0)

Description: Method bool QImage::loadFromData(const unsigned char *buf, int len, const char *format)

(2) Signature: bool loadFromData (bytes data, string aformat = 0)

Description: Method bool QImage::loadFromData(const QByteArray &data, const char *aformat)

metric

Signature: [const] int metric (const QPaintDevice_PaintDeviceMetric metric)

Description: Virtual method int QImage::metric(QPaintDevice::PaintDeviceMetric metric)

This method can be reimplemented in a derived class.

mirrored

Signature: [const] QImage mirrored (bool horizontally = false, bool vertically = true)

Description: Method QImage QImage::mirrored(bool horizontally, bool vertically)

new

(1) Signature: [static] new QImage ptr new (string data, int width, int height, int bytesPerLine, QImage_Format format)

Description: QImage::QImage(const uchar *data, int width, int height, int bytesPerLine)

The cleanupFunction parameter is available currently.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QImage ptr new (string data, int width, int height, QImage_Format format)

Description: QImage::QImage(const uchar *data, int width, int height)

The cleanupFunction parameter is available currently.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QImage new

Description: Constructor QImage::QImage()

This method creates an object of class QImage.

Python specific notes:
This method is the default initializer of the object.

(4) Signature: [static] new QImage new (const QSize size, const QImage_Format format)

Description: Constructor QImage::QImage(const QSize &size, QImage::Format format)

This method creates an object of class QImage.

Python specific notes:
This method is the default initializer of the object.

(5) Signature: [static] new QImage new (int width, int height, const QImage_Format format)

Description: Constructor QImage::QImage(int width, int height, QImage::Format format)

This method creates an object of class QImage.

Python specific notes:
This method is the default initializer of the object.

(6) Signature: [static] new QImage new (string fileName, string format = 0)

Description: Constructor QImage::QImage(const QString &fileName, const char *format)

This method creates an object of class QImage.

Python specific notes:
This method is the default initializer of the object.

(7) Signature: [static] new QImage new (const QImage arg1)

Description: Constructor QImage::QImage(const QImage &)

This method creates an object of class QImage.

Python specific notes:
This method is the default initializer of the object.

numBytes

Signature: [const] int numBytes

Description: Method int QImage::numBytes()

numColors

Signature: [const] int numColors

Description: Method int QImage::numColors()

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

numColors=

Signature: void numColors= (int arg1)

Description: Method void QImage::setNumColors(int)

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

offset

Signature: [const] QPoint offset

Description: Method QPoint QImage::offset()

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

offset=

Signature: void offset= (const QPoint arg1)

Description: Method void QImage::setOffset(const QPoint &)

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

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

Description: Virtual method QPaintEngine *QImage::paintEngine()

This method can be reimplemented in a derived class.

pixel

(1) Signature: [const] unsigned int pixel (int x, int y)

Description: Method unsigned int QImage::pixel(int x, int y)

(2) Signature: [const] unsigned int pixel (const QPoint pt)

Description: Method unsigned int QImage::pixel(const QPoint &pt)

pixelIndex

(1) Signature: [const] int pixelIndex (int x, int y)

Description: Method int QImage::pixelIndex(int x, int y)

(2) Signature: [const] int pixelIndex (const QPoint pt)

Description: Method int QImage::pixelIndex(const QPoint &pt)

rect

Signature: [const] QRect rect

Description: Method QRect QImage::rect()

rgbSwapped

Signature: [const] QImage rgbSwapped

Description: Method QImage QImage::rgbSwapped()

save

(1) Signature: [const] bool save (string fileName, string format = 0, int quality = -1)

Description: Method bool QImage::save(const QString &fileName, const char *format, int quality)

(2) Signature: [const] bool save (QIODevice ptr device, string format = 0, int quality = -1)

Description: Method bool QImage::save(QIODevice *device, const char *format, int quality)

scaled

(1) Signature: [const] QImage scaled (int w, int h, const Qt_AspectRatioMode aspectMode = Qt::IgnoreAspectRatio, const Qt_TransformationMode mode = Qt::FastTransformation)

Description: Method QImage QImage::scaled(int w, int h, Qt::AspectRatioMode aspectMode, Qt::TransformationMode mode)

(2) Signature: [const] QImage scaled (const QSize s, const Qt_AspectRatioMode aspectMode = Qt::IgnoreAspectRatio, const Qt_TransformationMode mode = Qt::FastTransformation)

Description: Method QImage QImage::scaled(const QSize &s, Qt::AspectRatioMode aspectMode, Qt::TransformationMode mode)

scaledToHeight

Signature: [const] QImage scaledToHeight (int h, const Qt_TransformationMode mode = Qt::FastTransformation)

Description: Method QImage QImage::scaledToHeight(int h, Qt::TransformationMode mode)

scaledToWidth

Signature: [const] QImage scaledToWidth (int w, const Qt_TransformationMode mode = Qt::FastTransformation)

Description: Method QImage QImage::scaledToWidth(int w, Qt::TransformationMode mode)

scanLine

Signature: [const] string scanLine (int arg1)

Description: Method const unsigned char *QImage::scanLine(int)

serialNumber

Signature: [const] int serialNumber

Description: Method int QImage::serialNumber()

setAlphaChannel

Signature: void setAlphaChannel (const QImage alphaChannel)

Description: Method void QImage::setAlphaChannel(const QImage &alphaChannel)

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

setColor

Signature: void setColor (int i, unsigned int c)

Description: Method void QImage::setColor(int i, unsigned int c)

setColorCount

Signature: void setColorCount (int arg1)

Description: Method void QImage::setColorCount(int)

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

setColorTable

Signature: void setColorTable ([] colors)

Description: Method void QImage::setColorTable(const QVector<QRgb> colors)

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

setDotsPerMeterX

Signature: void setDotsPerMeterX (int arg1)

Description: Method void QImage::setDotsPerMeterX(int)

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

setDotsPerMeterY

Signature: void setDotsPerMeterY (int arg1)

Description: Method void QImage::setDotsPerMeterY(int)

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

setNumColors

Signature: void setNumColors (int arg1)

Description: Method void QImage::setNumColors(int)

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

setOffset

Signature: void setOffset (const QPoint arg1)

Description: Method void QImage::setOffset(const QPoint &)

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

setPixel

(1) Signature: void setPixel (int x, int y, unsigned int index_or_rgb)

Description: Method void QImage::setPixel(int x, int y, unsigned int index_or_rgb)

(2) Signature: void setPixel (const QPoint pt, unsigned int index_or_rgb)

Description: Method void QImage::setPixel(const QPoint &pt, unsigned int index_or_rgb)

setText

(1) Signature: void setText (string key, string value)

Description: Method void QImage::setText(const QString &key, const QString &value)

(2) Signature: void setText (string key, string lang, string arg3)

Description: Method void QImage::setText(const char *key, const char *lang, const QString &)

size

Signature: [const] QSize size

Description: Method QSize QImage::size()

Python specific notes:
This method is also available as 'len(object)'.

text

(1) Signature: [const] string text (string key, string lang = 0)

Description: Method QString QImage::text(const char *key, const char *lang)

(2) Signature: [const] string text (const QImageTextKeyLang arg1)

Description: Method QString QImage::text(const QImageTextKeyLang &)

textKeys

Signature: [const] string[] textKeys

Description: Method QStringList QImage::textKeys()

textLanguages

Signature: [const] string[] textLanguages

Description: Method QStringList QImage::textLanguages()

textList

Signature: [const] QImageTextKeyLang[] textList

Description: Method QList<QImageTextKeyLang> QImage::textList()

transformed

(1) Signature: [const] QImage transformed (const QMatrix matrix, const Qt_TransformationMode mode = Qt::FastTransformation)

Description: Method QImage QImage::transformed(const QMatrix &matrix, Qt::TransformationMode mode)

(2) Signature: [const] QImage transformed (const QTransform matrix, const Qt_TransformationMode mode = Qt::FastTransformation)

Description: Method QImage QImage::transformed(const QTransform &matrix, Qt::TransformationMode mode)

trueMatrix

(1) Signature: [static] QMatrix trueMatrix (const QMatrix arg1, int w, int h)

Description: Static method QMatrix QImage::trueMatrix(const QMatrix &, int w, int h)

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

(2) Signature: [static] QTransform trueMatrix (const QTransform arg1, int w, int h)

Description: Static method QTransform QImage::trueMatrix(const QTransform &, int w, int h)

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

valid

(1) Signature: [const] bool valid (int x, int y)

Description: Method bool QImage::valid(int x, int y)

(2) Signature: [const] bool valid (const QPoint pt)

Description: Method bool QImage::valid(const QPoint &pt)

width

Signature: [const] int width

Description: Method int QImage::width()