API reference - Class QPixelFormat_YUVLayout

Notation used in Ruby API documentation

Module: QtGui

Description: This class represents the QPixelFormat::YUVLayout enum

This class is equivalent to the class QPixelFormat::YUVLayout

Public constructors

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

Public methods

[const]bool!=(const QPixelFormat_YUVLayout other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QPixelFormat_YUVLayout 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 QPixelFormat_YUVLayout other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
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 QPixelFormat_YUVLayout other)Assigns another object to self
[const]new QPixelFormat_YUVLayout ptrdupCreates a copy of self
[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]QPixelFormat_QFlags_YUVLayout|(const QPixelFormat_YUVLayout other)Creates a flag set by combining the two flags
[const]QPixelFormat_QFlags_YUVLayout|(const QPixelFormat_QFlags_YUVLayout other)Combines the flag and the flag set

Public static methods and constants

[static,const]QPixelFormat_YUVLayoutIMC1Enum constant QPixelFormat::IMC1
[static,const]QPixelFormat_YUVLayoutIMC2Enum constant QPixelFormat::IMC2
[static,const]QPixelFormat_YUVLayoutIMC3Enum constant QPixelFormat::IMC3
[static,const]QPixelFormat_YUVLayoutIMC4Enum constant QPixelFormat::IMC4
[static,const]QPixelFormat_YUVLayoutNV12Enum constant QPixelFormat::NV12
[static,const]QPixelFormat_YUVLayoutNV21Enum constant QPixelFormat::NV21
[static,const]QPixelFormat_YUVLayoutUYVYEnum constant QPixelFormat::UYVY
[static,const]QPixelFormat_YUVLayoutY16Enum constant QPixelFormat::Y16
[static,const]QPixelFormat_YUVLayoutY8Enum constant QPixelFormat::Y8
[static,const]QPixelFormat_YUVLayoutYUV411Enum constant QPixelFormat::YUV411
[static,const]QPixelFormat_YUVLayoutYUV420PEnum constant QPixelFormat::YUV420P
[static,const]QPixelFormat_YUVLayoutYUV420SPEnum constant QPixelFormat::YUV420SP
[static,const]QPixelFormat_YUVLayoutYUV422Enum constant QPixelFormat::YUV422
[static,const]QPixelFormat_YUVLayoutYUV444Enum constant QPixelFormat::YUV444
[static,const]QPixelFormat_YUVLayoutYUYVEnum constant QPixelFormat::YUYV
[static,const]QPixelFormat_YUVLayoutYV12Enum constant QPixelFormat::YV12

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 QPixelFormat_YUVLayout 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 QPixelFormat_YUVLayout 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 QPixelFormat_YUVLayout other)

Description: Compares two enums

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

Description: Compares an enum with an integer value

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.

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.

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.

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.

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.

_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 QPixelFormat_YUVLayout 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 QPixelFormat_YUVLayout ptr dup

Description: Creates a copy of self

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

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 QPixelFormat_YUVLayout 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 QPixelFormat_YUVLayout 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

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] QPixelFormat_QFlags_YUVLayout | (const QPixelFormat_YUVLayout other)

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set