KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QVideoFrame_PixelFormat

Notation used in Ruby API documentation

Module: QtMultimedia

Description: This class represents the QVideoFrame::PixelFormat enum

This class is equivalent to the class QVideoFrame::PixelFormat

Public constructors

new QVideoFrame_PixelFormat ptrnew(int i)Creates an enum from an integer value
new QVideoFrame_PixelFormat ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const QVideoFrame_PixelFormat other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QVideoFrame_PixelFormat other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const QVideoFrame_PixelFormat other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]QVideoFrame_PixelFormat ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[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.
voidassign(const QVideoFrame_PixelFormat other)Assigns another object to self
[const]new QVideoFrame_PixelFormat ptrdupCreates a copy of self
[const]inthashGets the hash value from the enum
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]QVideoFrame_QFlags_PixelFormat|(const QVideoFrame_PixelFormat other)Creates a flag set by combining the two flags
[const]QVideoFrame_QFlags_PixelFormat|(const QVideoFrame_QFlags_PixelFormat other)Combines the flag and the flag set

Public static methods and constants

[static,const]QVideoFrame_PixelFormatFormat_ARGB32Enum constant QVideoFrame::Format_ARGB32
[static,const]QVideoFrame_PixelFormatFormat_ARGB32_PremultipliedEnum constant QVideoFrame::Format_ARGB32_Premultiplied
[static,const]QVideoFrame_PixelFormatFormat_ARGB8565_PremultipliedEnum constant QVideoFrame::Format_ARGB8565_Premultiplied
[static,const]QVideoFrame_PixelFormatFormat_AYUV444Enum constant QVideoFrame::Format_AYUV444
[static,const]QVideoFrame_PixelFormatFormat_AYUV444_PremultipliedEnum constant QVideoFrame::Format_AYUV444_Premultiplied
[static,const]QVideoFrame_PixelFormatFormat_AdobeDngEnum constant QVideoFrame::Format_AdobeDng
[static,const]QVideoFrame_PixelFormatFormat_BGR24Enum constant QVideoFrame::Format_BGR24
[static,const]QVideoFrame_PixelFormatFormat_BGR32Enum constant QVideoFrame::Format_BGR32
[static,const]QVideoFrame_PixelFormatFormat_BGR555Enum constant QVideoFrame::Format_BGR555
[static,const]QVideoFrame_PixelFormatFormat_BGR565Enum constant QVideoFrame::Format_BGR565
[static,const]QVideoFrame_PixelFormatFormat_BGRA32Enum constant QVideoFrame::Format_BGRA32
[static,const]QVideoFrame_PixelFormatFormat_BGRA32_PremultipliedEnum constant QVideoFrame::Format_BGRA32_Premultiplied
[static,const]QVideoFrame_PixelFormatFormat_BGRA5658_PremultipliedEnum constant QVideoFrame::Format_BGRA5658_Premultiplied
[static,const]QVideoFrame_PixelFormatFormat_CameraRawEnum constant QVideoFrame::Format_CameraRaw
[static,const]QVideoFrame_PixelFormatFormat_IMC1Enum constant QVideoFrame::Format_IMC1
[static,const]QVideoFrame_PixelFormatFormat_IMC2Enum constant QVideoFrame::Format_IMC2
[static,const]QVideoFrame_PixelFormatFormat_IMC3Enum constant QVideoFrame::Format_IMC3
[static,const]QVideoFrame_PixelFormatFormat_IMC4Enum constant QVideoFrame::Format_IMC4
[static,const]QVideoFrame_PixelFormatFormat_InvalidEnum constant QVideoFrame::Format_Invalid
[static,const]QVideoFrame_PixelFormatFormat_JpegEnum constant QVideoFrame::Format_Jpeg
[static,const]QVideoFrame_PixelFormatFormat_NV12Enum constant QVideoFrame::Format_NV12
[static,const]QVideoFrame_PixelFormatFormat_NV21Enum constant QVideoFrame::Format_NV21
[static,const]QVideoFrame_PixelFormatFormat_RGB24Enum constant QVideoFrame::Format_RGB24
[static,const]QVideoFrame_PixelFormatFormat_RGB32Enum constant QVideoFrame::Format_RGB32
[static,const]QVideoFrame_PixelFormatFormat_RGB555Enum constant QVideoFrame::Format_RGB555
[static,const]QVideoFrame_PixelFormatFormat_RGB565Enum constant QVideoFrame::Format_RGB565
[static,const]QVideoFrame_PixelFormatFormat_UYVYEnum constant QVideoFrame::Format_UYVY
[static,const]QVideoFrame_PixelFormatFormat_UserEnum constant QVideoFrame::Format_User
[static,const]QVideoFrame_PixelFormatFormat_Y16Enum constant QVideoFrame::Format_Y16
[static,const]QVideoFrame_PixelFormatFormat_Y8Enum constant QVideoFrame::Format_Y8
[static,const]QVideoFrame_PixelFormatFormat_YUV420PEnum constant QVideoFrame::Format_YUV420P
[static,const]QVideoFrame_PixelFormatFormat_YUV444Enum constant QVideoFrame::Format_YUV444
[static,const]QVideoFrame_PixelFormatFormat_YUYVEnum constant QVideoFrame::Format_YUYV
[static,const]QVideoFrame_PixelFormatFormat_YV12Enum constant QVideoFrame::Format_YV12
[static,const]QVideoFrame_PixelFormatNPixelFormatsEnum constant QVideoFrame::NPixelFormats

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

(1) Signature: [const] bool != (const QVideoFrame_PixelFormat other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const QVideoFrame_PixelFormat other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const QVideoFrame_PixelFormat other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

Format_ARGB32

Signature: [static,const] QVideoFrame_PixelFormat Format_ARGB32

Description: Enum constant QVideoFrame::Format_ARGB32

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

Format_ARGB32_Premultiplied

Signature: [static,const] QVideoFrame_PixelFormat Format_ARGB32_Premultiplied

Description: Enum constant QVideoFrame::Format_ARGB32_Premultiplied

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

Format_ARGB8565_Premultiplied

Signature: [static,const] QVideoFrame_PixelFormat Format_ARGB8565_Premultiplied

Description: Enum constant QVideoFrame::Format_ARGB8565_Premultiplied

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

Format_AYUV444

Signature: [static,const] QVideoFrame_PixelFormat Format_AYUV444

Description: Enum constant QVideoFrame::Format_AYUV444

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

Format_AYUV444_Premultiplied

Signature: [static,const] QVideoFrame_PixelFormat Format_AYUV444_Premultiplied

Description: Enum constant QVideoFrame::Format_AYUV444_Premultiplied

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

Format_AdobeDng

Signature: [static,const] QVideoFrame_PixelFormat Format_AdobeDng

Description: Enum constant QVideoFrame::Format_AdobeDng

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

Format_BGR24

Signature: [static,const] QVideoFrame_PixelFormat Format_BGR24

Description: Enum constant QVideoFrame::Format_BGR24

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

Format_BGR32

Signature: [static,const] QVideoFrame_PixelFormat Format_BGR32

Description: Enum constant QVideoFrame::Format_BGR32

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

Format_BGR555

Signature: [static,const] QVideoFrame_PixelFormat Format_BGR555

Description: Enum constant QVideoFrame::Format_BGR555

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

Format_BGR565

Signature: [static,const] QVideoFrame_PixelFormat Format_BGR565

Description: Enum constant QVideoFrame::Format_BGR565

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

Format_BGRA32

Signature: [static,const] QVideoFrame_PixelFormat Format_BGRA32

Description: Enum constant QVideoFrame::Format_BGRA32

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

Format_BGRA32_Premultiplied

Signature: [static,const] QVideoFrame_PixelFormat Format_BGRA32_Premultiplied

Description: Enum constant QVideoFrame::Format_BGRA32_Premultiplied

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

Format_BGRA5658_Premultiplied

Signature: [static,const] QVideoFrame_PixelFormat Format_BGRA5658_Premultiplied

Description: Enum constant QVideoFrame::Format_BGRA5658_Premultiplied

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

Format_CameraRaw

Signature: [static,const] QVideoFrame_PixelFormat Format_CameraRaw

Description: Enum constant QVideoFrame::Format_CameraRaw

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

Format_IMC1

Signature: [static,const] QVideoFrame_PixelFormat Format_IMC1

Description: Enum constant QVideoFrame::Format_IMC1

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

Format_IMC2

Signature: [static,const] QVideoFrame_PixelFormat Format_IMC2

Description: Enum constant QVideoFrame::Format_IMC2

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

Format_IMC3

Signature: [static,const] QVideoFrame_PixelFormat Format_IMC3

Description: Enum constant QVideoFrame::Format_IMC3

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

Format_IMC4

Signature: [static,const] QVideoFrame_PixelFormat Format_IMC4

Description: Enum constant QVideoFrame::Format_IMC4

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

Format_Invalid

Signature: [static,const] QVideoFrame_PixelFormat Format_Invalid

Description: Enum constant QVideoFrame::Format_Invalid

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

Format_Jpeg

Signature: [static,const] QVideoFrame_PixelFormat Format_Jpeg

Description: Enum constant QVideoFrame::Format_Jpeg

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

Format_NV12

Signature: [static,const] QVideoFrame_PixelFormat Format_NV12

Description: Enum constant QVideoFrame::Format_NV12

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

Format_NV21

Signature: [static,const] QVideoFrame_PixelFormat Format_NV21

Description: Enum constant QVideoFrame::Format_NV21

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

Format_RGB24

Signature: [static,const] QVideoFrame_PixelFormat Format_RGB24

Description: Enum constant QVideoFrame::Format_RGB24

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

Format_RGB32

Signature: [static,const] QVideoFrame_PixelFormat Format_RGB32

Description: Enum constant QVideoFrame::Format_RGB32

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

Format_RGB555

Signature: [static,const] QVideoFrame_PixelFormat Format_RGB555

Description: Enum constant QVideoFrame::Format_RGB555

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

Format_RGB565

Signature: [static,const] QVideoFrame_PixelFormat Format_RGB565

Description: Enum constant QVideoFrame::Format_RGB565

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

Format_UYVY

Signature: [static,const] QVideoFrame_PixelFormat Format_UYVY

Description: Enum constant QVideoFrame::Format_UYVY

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

Format_User

Signature: [static,const] QVideoFrame_PixelFormat Format_User

Description: Enum constant QVideoFrame::Format_User

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

Format_Y16

Signature: [static,const] QVideoFrame_PixelFormat Format_Y16

Description: Enum constant QVideoFrame::Format_Y16

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

Format_Y8

Signature: [static,const] QVideoFrame_PixelFormat Format_Y8

Description: Enum constant QVideoFrame::Format_Y8

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

Format_YUV420P

Signature: [static,const] QVideoFrame_PixelFormat Format_YUV420P

Description: Enum constant QVideoFrame::Format_YUV420P

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

Format_YUV444

Signature: [static,const] QVideoFrame_PixelFormat Format_YUV444

Description: Enum constant QVideoFrame::Format_YUV444

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

Format_YUYV

Signature: [static,const] QVideoFrame_PixelFormat Format_YUYV

Description: Enum constant QVideoFrame::Format_YUYV

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

Format_YV12

Signature: [static,const] QVideoFrame_PixelFormat Format_YV12

Description: Enum constant QVideoFrame::Format_YV12

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

NPixelFormats

Signature: [static,const] QVideoFrame_PixelFormat NPixelFormats

Description: Enum constant QVideoFrame::NPixelFormats

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

_const_cast

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

assign

Signature: void assign (const QVideoFrame_PixelFormat other)

Description: Assigns another object to self

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.

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 QVideoFrame_PixelFormat ptr dup

Description: Creates a copy of self

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

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

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

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

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

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.

new

(1) Signature: [static] new QVideoFrame_PixelFormat ptr new (int i)

Description: Creates an enum from an integer value

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

(2) Signature: [static] new QVideoFrame_PixelFormat ptr new (string s)

Description: Creates an enum from a string value

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

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

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

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

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

|

(1) Signature: [const] QVideoFrame_QFlags_PixelFormat | (const QVideoFrame_PixelFormat other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] QVideoFrame_QFlags_PixelFormat | (const QVideoFrame_QFlags_PixelFormat other)

Description: Combines the flag and the flag set