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
new QVideoFrame_PixelFormat ptr | new | (int i) | Creates an enum from an integer value |
new QVideoFrame_PixelFormat ptr | new | (string s) | Creates an enum from a string value |
[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_cast | Returns a non-const reference to self. | |
void | _create | Ensures the C++ object is created | ||
void | _destroy | Explicitly 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 | _manage | Marks the object as managed by the script side. | ||
void | _unmanage | Marks the object as no longer owned by the script side. | ||
void | assign | (const QVideoFrame_PixelFormat other) | Assigns another object to self | |
[const] | new QVideoFrame_PixelFormat ptr | dup | Creates a copy of self | |
[const] | int | hash | Gets the hash value from the enum | |
[const] | string | inspect | Converts an enum to a visual string | |
[const] | int | to_i | Gets the integer value from the enum | |
[const] | string | to_s | Gets 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 |
[static,const] | QVideoFrame_PixelFormat | Format_ARGB32 | Enum constant QVideoFrame::Format_ARGB32 | |
[static,const] | QVideoFrame_PixelFormat | Format_ARGB32_Premultiplied | Enum constant QVideoFrame::Format_ARGB32_Premultiplied | |
[static,const] | QVideoFrame_PixelFormat | Format_ARGB8565_Premultiplied | Enum constant QVideoFrame::Format_ARGB8565_Premultiplied | |
[static,const] | QVideoFrame_PixelFormat | Format_AYUV444 | Enum constant QVideoFrame::Format_AYUV444 | |
[static,const] | QVideoFrame_PixelFormat | Format_AYUV444_Premultiplied | Enum constant QVideoFrame::Format_AYUV444_Premultiplied | |
[static,const] | QVideoFrame_PixelFormat | Format_AdobeDng | Enum constant QVideoFrame::Format_AdobeDng | |
[static,const] | QVideoFrame_PixelFormat | Format_BGR24 | Enum constant QVideoFrame::Format_BGR24 | |
[static,const] | QVideoFrame_PixelFormat | Format_BGR32 | Enum constant QVideoFrame::Format_BGR32 | |
[static,const] | QVideoFrame_PixelFormat | Format_BGR555 | Enum constant QVideoFrame::Format_BGR555 | |
[static,const] | QVideoFrame_PixelFormat | Format_BGR565 | Enum constant QVideoFrame::Format_BGR565 | |
[static,const] | QVideoFrame_PixelFormat | Format_BGRA32 | Enum constant QVideoFrame::Format_BGRA32 | |
[static,const] | QVideoFrame_PixelFormat | Format_BGRA32_Premultiplied | Enum constant QVideoFrame::Format_BGRA32_Premultiplied | |
[static,const] | QVideoFrame_PixelFormat | Format_BGRA5658_Premultiplied | Enum constant QVideoFrame::Format_BGRA5658_Premultiplied | |
[static,const] | QVideoFrame_PixelFormat | Format_CameraRaw | Enum constant QVideoFrame::Format_CameraRaw | |
[static,const] | QVideoFrame_PixelFormat | Format_IMC1 | Enum constant QVideoFrame::Format_IMC1 | |
[static,const] | QVideoFrame_PixelFormat | Format_IMC2 | Enum constant QVideoFrame::Format_IMC2 | |
[static,const] | QVideoFrame_PixelFormat | Format_IMC3 | Enum constant QVideoFrame::Format_IMC3 | |
[static,const] | QVideoFrame_PixelFormat | Format_IMC4 | Enum constant QVideoFrame::Format_IMC4 | |
[static,const] | QVideoFrame_PixelFormat | Format_Invalid | Enum constant QVideoFrame::Format_Invalid | |
[static,const] | QVideoFrame_PixelFormat | Format_Jpeg | Enum constant QVideoFrame::Format_Jpeg | |
[static,const] | QVideoFrame_PixelFormat | Format_NV12 | Enum constant QVideoFrame::Format_NV12 | |
[static,const] | QVideoFrame_PixelFormat | Format_NV21 | Enum constant QVideoFrame::Format_NV21 | |
[static,const] | QVideoFrame_PixelFormat | Format_RGB24 | Enum constant QVideoFrame::Format_RGB24 | |
[static,const] | QVideoFrame_PixelFormat | Format_RGB32 | Enum constant QVideoFrame::Format_RGB32 | |
[static,const] | QVideoFrame_PixelFormat | Format_RGB555 | Enum constant QVideoFrame::Format_RGB555 | |
[static,const] | QVideoFrame_PixelFormat | Format_RGB565 | Enum constant QVideoFrame::Format_RGB565 | |
[static,const] | QVideoFrame_PixelFormat | Format_UYVY | Enum constant QVideoFrame::Format_UYVY | |
[static,const] | QVideoFrame_PixelFormat | Format_User | Enum constant QVideoFrame::Format_User | |
[static,const] | QVideoFrame_PixelFormat | Format_Y16 | Enum constant QVideoFrame::Format_Y16 | |
[static,const] | QVideoFrame_PixelFormat | Format_Y8 | Enum constant QVideoFrame::Format_Y8 | |
[static,const] | QVideoFrame_PixelFormat | Format_YUV420P | Enum constant QVideoFrame::Format_YUV420P | |
[static,const] | QVideoFrame_PixelFormat | Format_YUV444 | Enum constant QVideoFrame::Format_YUV444 | |
[static,const] | QVideoFrame_PixelFormat | Format_YUYV | Enum constant QVideoFrame::Format_YUYV | |
[static,const] | QVideoFrame_PixelFormat | Format_YV12 | Enum constant QVideoFrame::Format_YV12 | |
[static,const] | QVideoFrame_PixelFormat | NPixelFormats | Enum constant QVideoFrame::NPixelFormats |
void | create | Use of this method is deprecated. Use _create instead | ||
void | destroy | Use of this method is deprecated. Use _destroy instead | ||
[const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
[const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
!= | (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: |
Format_ARGB32_Premultiplied | Signature: [static,const] QVideoFrame_PixelFormat Format_ARGB32_Premultiplied Description: Enum constant QVideoFrame::Format_ARGB32_Premultiplied Python specific notes: |
Format_ARGB8565_Premultiplied | Signature: [static,const] QVideoFrame_PixelFormat Format_ARGB8565_Premultiplied Description: Enum constant QVideoFrame::Format_ARGB8565_Premultiplied Python specific notes: |
Format_AYUV444 | Signature: [static,const] QVideoFrame_PixelFormat Format_AYUV444 Description: Enum constant QVideoFrame::Format_AYUV444 Python specific notes: |
Format_AYUV444_Premultiplied | Signature: [static,const] QVideoFrame_PixelFormat Format_AYUV444_Premultiplied Description: Enum constant QVideoFrame::Format_AYUV444_Premultiplied Python specific notes: |
Format_AdobeDng | Signature: [static,const] QVideoFrame_PixelFormat Format_AdobeDng Description: Enum constant QVideoFrame::Format_AdobeDng Python specific notes: |
Format_BGR24 | Signature: [static,const] QVideoFrame_PixelFormat Format_BGR24 Description: Enum constant QVideoFrame::Format_BGR24 Python specific notes: |
Format_BGR32 | Signature: [static,const] QVideoFrame_PixelFormat Format_BGR32 Description: Enum constant QVideoFrame::Format_BGR32 Python specific notes: |
Format_BGR555 | Signature: [static,const] QVideoFrame_PixelFormat Format_BGR555 Description: Enum constant QVideoFrame::Format_BGR555 Python specific notes: |
Format_BGR565 | Signature: [static,const] QVideoFrame_PixelFormat Format_BGR565 Description: Enum constant QVideoFrame::Format_BGR565 Python specific notes: |
Format_BGRA32 | Signature: [static,const] QVideoFrame_PixelFormat Format_BGRA32 Description: Enum constant QVideoFrame::Format_BGRA32 Python specific notes: |
Format_BGRA32_Premultiplied | Signature: [static,const] QVideoFrame_PixelFormat Format_BGRA32_Premultiplied Description: Enum constant QVideoFrame::Format_BGRA32_Premultiplied Python specific notes: |
Format_BGRA5658_Premultiplied | Signature: [static,const] QVideoFrame_PixelFormat Format_BGRA5658_Premultiplied Description: Enum constant QVideoFrame::Format_BGRA5658_Premultiplied Python specific notes: |
Format_CameraRaw | Signature: [static,const] QVideoFrame_PixelFormat Format_CameraRaw Description: Enum constant QVideoFrame::Format_CameraRaw Python specific notes: |
Format_IMC1 | Signature: [static,const] QVideoFrame_PixelFormat Format_IMC1 Description: Enum constant QVideoFrame::Format_IMC1 Python specific notes: |
Format_IMC2 | Signature: [static,const] QVideoFrame_PixelFormat Format_IMC2 Description: Enum constant QVideoFrame::Format_IMC2 Python specific notes: |
Format_IMC3 | Signature: [static,const] QVideoFrame_PixelFormat Format_IMC3 Description: Enum constant QVideoFrame::Format_IMC3 Python specific notes: |
Format_IMC4 | Signature: [static,const] QVideoFrame_PixelFormat Format_IMC4 Description: Enum constant QVideoFrame::Format_IMC4 Python specific notes: |
Format_Invalid | Signature: [static,const] QVideoFrame_PixelFormat Format_Invalid Description: Enum constant QVideoFrame::Format_Invalid Python specific notes: |
Format_Jpeg | Signature: [static,const] QVideoFrame_PixelFormat Format_Jpeg Description: Enum constant QVideoFrame::Format_Jpeg Python specific notes: |
Format_NV12 | Signature: [static,const] QVideoFrame_PixelFormat Format_NV12 Description: Enum constant QVideoFrame::Format_NV12 Python specific notes: |
Format_NV21 | Signature: [static,const] QVideoFrame_PixelFormat Format_NV21 Description: Enum constant QVideoFrame::Format_NV21 Python specific notes: |
Format_RGB24 | Signature: [static,const] QVideoFrame_PixelFormat Format_RGB24 Description: Enum constant QVideoFrame::Format_RGB24 Python specific notes: |
Format_RGB32 | Signature: [static,const] QVideoFrame_PixelFormat Format_RGB32 Description: Enum constant QVideoFrame::Format_RGB32 Python specific notes: |
Format_RGB555 | Signature: [static,const] QVideoFrame_PixelFormat Format_RGB555 Description: Enum constant QVideoFrame::Format_RGB555 Python specific notes: |
Format_RGB565 | Signature: [static,const] QVideoFrame_PixelFormat Format_RGB565 Description: Enum constant QVideoFrame::Format_RGB565 Python specific notes: |
Format_UYVY | Signature: [static,const] QVideoFrame_PixelFormat Format_UYVY Description: Enum constant QVideoFrame::Format_UYVY Python specific notes: |
Format_User | Signature: [static,const] QVideoFrame_PixelFormat Format_User Description: Enum constant QVideoFrame::Format_User Python specific notes: |
Format_Y16 | Signature: [static,const] QVideoFrame_PixelFormat Format_Y16 Description: Enum constant QVideoFrame::Format_Y16 Python specific notes: |
Format_Y8 | Signature: [static,const] QVideoFrame_PixelFormat Format_Y8 Description: Enum constant QVideoFrame::Format_Y8 Python specific notes: |
Format_YUV420P | Signature: [static,const] QVideoFrame_PixelFormat Format_YUV420P Description: Enum constant QVideoFrame::Format_YUV420P Python specific notes: |
Format_YUV444 | Signature: [static,const] QVideoFrame_PixelFormat Format_YUV444 Description: Enum constant QVideoFrame::Format_YUV444 Python specific notes: |
Format_YUYV | Signature: [static,const] QVideoFrame_PixelFormat Format_YUYV Description: Enum constant QVideoFrame::Format_YUYV Python specific notes: |
Format_YV12 | Signature: [static,const] QVideoFrame_PixelFormat Format_YV12 Description: Enum constant QVideoFrame::Format_YV12 Python specific notes: |
NPixelFormats | Signature: [static,const] QVideoFrame_PixelFormat NPixelFormats Description: Enum constant QVideoFrame::NPixelFormats Python specific notes: |
_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: |
hash | Signature: [const] int hash Description: Gets the hash value from the enum Python specific notes: |
inspect | Signature: [const] string inspect Description: Converts an enum to a visual string Python specific notes: |
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: |
(2) Signature: [static] new QVideoFrame_PixelFormat ptr new (string s) Description: Creates an enum from a string value Python specific notes: | |
to_i | Signature: [const] int to_i Description: Gets the integer value from the enum Python specific notes: |
to_s | Signature: [const] string to_s Description: Gets the symbolic string from an enum Python specific notes: |
| | (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 |