API reference - Class QPixelFormat

!=

Signature: bool != (QPixelFormat fmt2)

Description: Operator bool ::operator!=(QPixelFormat fmt1, QPixelFormat fmt2)

This is the mapping of the global operator to the instance method.

==

Signature: bool == (QPixelFormat fmt2)

Description: Operator bool ::operator==(QPixelFormat fmt1, QPixelFormat fmt2)

This is the mapping of the global operator to the instance method.

Alpha

Signature: [static,const] QPixelFormat_ColorModel Alpha

Description: Enum constant QPixelFormat::Alpha

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

AtBeginning

Signature: [static,const] QPixelFormat_AlphaPosition AtBeginning

Description: Enum constant QPixelFormat::AtBeginning

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

AtEnd

Signature: [static,const] QPixelFormat_AlphaPosition AtEnd

Description: Enum constant QPixelFormat::AtEnd

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

BGR

Signature: [static,const] QPixelFormat_ColorModel BGR

Description: Enum constant QPixelFormat::BGR

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

BigEndian

Signature: [static,const] QPixelFormat_ByteOrder BigEndian

Description: Enum constant QPixelFormat::BigEndian

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

CMYK

Signature: [static,const] QPixelFormat_ColorModel CMYK

Description: Enum constant QPixelFormat::CMYK

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

CurrentSystemEndian

Signature: [static,const] QPixelFormat_ByteOrder CurrentSystemEndian

Description: Enum constant QPixelFormat::CurrentSystemEndian

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

FloatingPoint

Signature: [static,const] QPixelFormat_TypeInterpretation FloatingPoint

Description: Enum constant QPixelFormat::FloatingPoint

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

Grayscale

Signature: [static,const] QPixelFormat_ColorModel Grayscale

Description: Enum constant QPixelFormat::Grayscale

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

HSL

Signature: [static,const] QPixelFormat_ColorModel HSL

Description: Enum constant QPixelFormat::HSL

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

HSV

Signature: [static,const] QPixelFormat_ColorModel HSV

Description: Enum constant QPixelFormat::HSV

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

IMC1

Signature: [static,const] QPixelFormat_YUVLayout IMC1

Description: Enum constant QPixelFormat::IMC1

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

IMC2

Signature: [static,const] QPixelFormat_YUVLayout IMC2

Description: Enum constant QPixelFormat::IMC2

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

IMC3

Signature: [static,const] QPixelFormat_YUVLayout IMC3

Description: Enum constant QPixelFormat::IMC3

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

IMC4

Signature: [static,const] QPixelFormat_YUVLayout IMC4

Description: Enum constant QPixelFormat::IMC4

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

IgnoresAlpha

Signature: [static,const] QPixelFormat_AlphaUsage IgnoresAlpha

Description: Enum constant QPixelFormat::IgnoresAlpha

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

Indexed

Signature: [static,const] QPixelFormat_ColorModel Indexed

Description: Enum constant QPixelFormat::Indexed

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

LittleEndian

Signature: [static,const] QPixelFormat_ByteOrder LittleEndian

Description: Enum constant QPixelFormat::LittleEndian

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

NV12

Signature: [static,const] QPixelFormat_YUVLayout NV12

Description: Enum constant QPixelFormat::NV12

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

NV21

Signature: [static,const] QPixelFormat_YUVLayout NV21

Description: Enum constant QPixelFormat::NV21

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

NotPremultiplied

Signature: [static,const] QPixelFormat_AlphaPremultiplied NotPremultiplied

Description: Enum constant QPixelFormat::NotPremultiplied

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

Premultiplied

Signature: [static,const] QPixelFormat_AlphaPremultiplied Premultiplied

Description: Enum constant QPixelFormat::Premultiplied

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

RGB

Signature: [static,const] QPixelFormat_ColorModel RGB

Description: Enum constant QPixelFormat::RGB

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

UYVY

Signature: [static,const] QPixelFormat_YUVLayout UYVY

Description: Enum constant QPixelFormat::UYVY

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

UnsignedByte

Signature: [static,const] QPixelFormat_TypeInterpretation UnsignedByte

Description: Enum constant QPixelFormat::UnsignedByte

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

UnsignedInteger

Signature: [static,const] QPixelFormat_TypeInterpretation UnsignedInteger

Description: Enum constant QPixelFormat::UnsignedInteger

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

UnsignedShort

Signature: [static,const] QPixelFormat_TypeInterpretation UnsignedShort

Description: Enum constant QPixelFormat::UnsignedShort

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

UsesAlpha

Signature: [static,const] QPixelFormat_AlphaUsage UsesAlpha

Description: Enum constant QPixelFormat::UsesAlpha

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

Y16

Signature: [static,const] QPixelFormat_YUVLayout Y16

Description: Enum constant QPixelFormat::Y16

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

Y8

Signature: [static,const] QPixelFormat_YUVLayout Y8

Description: Enum constant QPixelFormat::Y8

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

YUV

Signature: [static,const] QPixelFormat_ColorModel YUV

Description: Enum constant QPixelFormat::YUV

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

YUV411

Signature: [static,const] QPixelFormat_YUVLayout YUV411

Description: Enum constant QPixelFormat::YUV411

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

YUV420P

Signature: [static,const] QPixelFormat_YUVLayout YUV420P

Description: Enum constant QPixelFormat::YUV420P

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

YUV420SP

Signature: [static,const] QPixelFormat_YUVLayout YUV420SP

Description: Enum constant QPixelFormat::YUV420SP

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

YUV422

Signature: [static,const] QPixelFormat_YUVLayout YUV422

Description: Enum constant QPixelFormat::YUV422

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

YUV444

Signature: [static,const] QPixelFormat_YUVLayout YUV444

Description: Enum constant QPixelFormat::YUV444

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

YUYV

Signature: [static,const] QPixelFormat_YUVLayout YUYV

Description: Enum constant QPixelFormat::YUYV

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

YV12

Signature: [static,const] QPixelFormat_YUVLayout YV12

Description: Enum constant QPixelFormat::YV12

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

_const_cast

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

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

alphaPosition

Signature: [const] QPixelFormat_AlphaPosition alphaPosition

Description: Method QPixelFormat::AlphaPosition QPixelFormat::alphaPosition()

alphaSize

Signature: [const] unsigned char alphaSize

Description: Method unsigned char QPixelFormat::alphaSize()

alphaUsage

Signature: [const] QPixelFormat_AlphaUsage alphaUsage

Description: Method QPixelFormat::AlphaUsage QPixelFormat::alphaUsage()

assign

Signature: void assign (const QPixelFormat other)

Description: Assigns another object to self

bitsPerPixel

Signature: [const] unsigned char bitsPerPixel

Description: Method unsigned char QPixelFormat::bitsPerPixel()

blackSize

Signature: [const] unsigned char blackSize

Description: Method unsigned char QPixelFormat::blackSize()

blueSize

Signature: [const] unsigned char blueSize

Description: Method unsigned char QPixelFormat::blueSize()

brightnessSize

Signature: [const] unsigned char brightnessSize

Description: Method unsigned char QPixelFormat::brightnessSize()

byteOrder

Signature: [const] QPixelFormat_ByteOrder byteOrder

Description: Method QPixelFormat::ByteOrder QPixelFormat::byteOrder()

channelCount

Signature: [const] unsigned char channelCount

Description: Method unsigned char QPixelFormat::channelCount()

colorModel

Signature: [const] QPixelFormat_ColorModel colorModel

Description: Method QPixelFormat::ColorModel QPixelFormat::colorModel()

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.

cyanSize

Signature: [const] unsigned char cyanSize

Description: Method unsigned char QPixelFormat::cyanSize()

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.

dup

Signature: [const] new QPixelFormat ptr dup

Description: Creates a copy of self

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

greenSize

Signature: [const] unsigned char greenSize

Description: Method unsigned char QPixelFormat::greenSize()

hueSize

Signature: [const] unsigned char hueSize

Description: Method unsigned char QPixelFormat::hueSize()

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.

lightnessSize

Signature: [const] unsigned char lightnessSize

Description: Method unsigned char QPixelFormat::lightnessSize()

magentaSize

Signature: [const] unsigned char magentaSize

Description: Method unsigned char QPixelFormat::magentaSize()

new

(1) Signature: [static] new QPixelFormat new

Description: Constructor QPixelFormat::QPixelFormat()

This method creates an object of class QPixelFormat.

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

(2) Signature: [static] new QPixelFormat new (const QPixelFormat_ColorModel colorModel, unsigned char firstSize, unsigned char secondSize, unsigned char thirdSize, unsigned char fourthSize, unsigned char fifthSize, unsigned char alphaSize, const QPixelFormat_AlphaUsage alphaUsage, const QPixelFormat_AlphaPosition alphaPosition, const QPixelFormat_AlphaPremultiplied premultiplied, const QPixelFormat_TypeInterpretation typeInterpretation, const QPixelFormat_ByteOrder byteOrder = QPixelFormat::CurrentSystemEndian, unsigned char subEnum = 0)

Description: Constructor QPixelFormat::QPixelFormat(QPixelFormat::ColorModel colorModel, unsigned char firstSize, unsigned char secondSize, unsigned char thirdSize, unsigned char fourthSize, unsigned char fifthSize, unsigned char alphaSize, QPixelFormat::AlphaUsage alphaUsage, QPixelFormat::AlphaPosition alphaPosition, QPixelFormat::AlphaPremultiplied premultiplied, QPixelFormat::TypeInterpretation typeInterpretation, QPixelFormat::ByteOrder byteOrder, unsigned char subEnum)

This method creates an object of class QPixelFormat.

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

premultiplied

Signature: [const] QPixelFormat_AlphaPremultiplied premultiplied

Description: Method QPixelFormat::AlphaPremultiplied QPixelFormat::premultiplied()

redSize

Signature: [const] unsigned char redSize

Description: Method unsigned char QPixelFormat::redSize()

saturationSize

Signature: [const] unsigned char saturationSize

Description: Method unsigned char QPixelFormat::saturationSize()

subEnum

Signature: [const] unsigned char subEnum

Description: Method unsigned char QPixelFormat::subEnum()

typeInterpretation

Signature: [const] QPixelFormat_TypeInterpretation typeInterpretation

Description: Method QPixelFormat::TypeInterpretation QPixelFormat::typeInterpretation()

yellowSize

Signature: [const] unsigned char yellowSize

Description: Method unsigned char QPixelFormat::yellowSize()

yuvLayout

Signature: [const] QPixelFormat_YUVLayout yuvLayout

Description: Method QPixelFormat::YUVLayout QPixelFormat::yuvLayout()