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

API reference - Class QRgba64

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QRgba64

Public constructors

new QRgba64newConstructor QRgba64::QRgba64()

Public methods

void_assign(const QRgba64 other)Assigns another object to self
[const]QRgba64 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.
[const]unsigned shortalphaMethod quint16 QRgba64::alpha()
[const]unsigned charalpha8Method quint8 QRgba64::alpha8()
voidalpha=(unsigned short _alpha)Method void QRgba64::setAlpha(quint16 _alpha)
QRgba64assign(unsigned long long _rgba)Method QRgba64 QRgba64::operator=(quint64 _rgba)
[const]unsigned shortblueMethod quint16 QRgba64::blue()
[const]unsigned charblue8Method quint8 QRgba64::blue8()
voidblue=(unsigned short _blue)Method void QRgba64::setBlue(quint16 _blue)
[const]new QRgba64 ptrdupCreates a copy of self
[const]unsigned shortgreenMethod quint16 QRgba64::green()
[const]unsigned chargreen8Method quint8 QRgba64::green8()
voidgreen=(unsigned short _green)Method void QRgba64::setGreen(quint16 _green)
[const]boolisOpaque?Method bool QRgba64::isOpaque()
[const]boolisTransparent?Method bool QRgba64::isTransparent()
[const]QRgba64premultipliedMethod QRgba64 QRgba64::premultiplied()
[const]unsigned shortredMethod quint16 QRgba64::red()
[const]unsigned charred8Method quint8 QRgba64::red8()
voidred=(unsigned short _red)Method void QRgba64::setRed(quint16 _red)
voidsetAlpha(unsigned short _alpha)Method void QRgba64::setAlpha(quint16 _alpha)
voidsetBlue(unsigned short _blue)Method void QRgba64::setBlue(quint16 _blue)
voidsetGreen(unsigned short _green)Method void QRgba64::setGreen(quint16 _green)
voidsetRed(unsigned short _red)Method void QRgba64::setRed(quint16 _red)
[const]unsigned inttoArgb32Method unsigned int QRgba64::toArgb32()
[const]unsigned shorttoRgb16Method unsigned short int QRgba64::toRgb16()
[const]QRgba64unpremultipliedMethod QRgba64 QRgba64::unpremultiplied()

Public static methods and constants

QRgba64fromArgb32(unsigned int rgb)Static method QRgba64 QRgba64::fromArgb32(unsigned int rgb)
QRgba64fromRgba(unsigned char red,
unsigned char green,
unsigned char blue,
unsigned char alpha)
Static method QRgba64 QRgba64::fromRgba(quint8 red, quint8 green, quint8 blue, quint8 alpha)
QRgba64fromRgba64(unsigned long long c)Static method QRgba64 QRgba64::fromRgba64(quint64 c)
QRgba64fromRgba64(unsigned short red,
unsigned short green,
unsigned short blue,
unsigned short alpha)
Static method QRgba64 QRgba64::fromRgba64(quint16 red, quint16 green, quint16 blue, quint16 alpha)

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

_assign

Signature: void _assign (const QRgba64 other)

Description: Assigns another object to self

_const_cast

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

alpha

Signature: [const] unsigned short alpha

Description: Method quint16 QRgba64::alpha()

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

alpha8

Signature: [const] unsigned char alpha8

Description: Method quint8 QRgba64::alpha8()

alpha=

Signature: void alpha= (unsigned short _alpha)

Description: Method void QRgba64::setAlpha(quint16 _alpha)

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

assign

Signature: QRgba64 assign (unsigned long long _rgba)

Description: Method QRgba64 QRgba64::operator=(quint64 _rgba)

blue

Signature: [const] unsigned short blue

Description: Method quint16 QRgba64::blue()

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

blue8

Signature: [const] unsigned char blue8

Description: Method quint8 QRgba64::blue8()

blue=

Signature: void blue= (unsigned short _blue)

Description: Method void QRgba64::setBlue(quint16 _blue)

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

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

Description: Creates a copy of self

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

fromArgb32

Signature: [static] QRgba64 fromArgb32 (unsigned int rgb)

Description: Static method QRgba64 QRgba64::fromArgb32(unsigned int rgb)

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

fromRgba

Signature: [static] QRgba64 fromRgba (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha)

Description: Static method QRgba64 QRgba64::fromRgba(quint8 red, quint8 green, quint8 blue, quint8 alpha)

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

fromRgba64

(1) Signature: [static] QRgba64 fromRgba64 (unsigned long long c)

Description: Static method QRgba64 QRgba64::fromRgba64(quint64 c)

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

(2) Signature: [static] QRgba64 fromRgba64 (unsigned short red, unsigned short green, unsigned short blue, unsigned short alpha)

Description: Static method QRgba64 QRgba64::fromRgba64(quint16 red, quint16 green, quint16 blue, quint16 alpha)

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

green

Signature: [const] unsigned short green

Description: Method quint16 QRgba64::green()

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

green8

Signature: [const] unsigned char green8

Description: Method quint8 QRgba64::green8()

green=

Signature: void green= (unsigned short _green)

Description: Method void QRgba64::setGreen(quint16 _green)

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

isOpaque?

Signature: [const] bool isOpaque?

Description: Method bool QRgba64::isOpaque()

isTransparent?

Signature: [const] bool isTransparent?

Description: Method bool QRgba64::isTransparent()

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

Signature: [static] new QRgba64 new

Description: Constructor QRgba64::QRgba64()

This method creates an object of class QRgba64.

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

premultiplied

Signature: [const] QRgba64 premultiplied

Description: Method QRgba64 QRgba64::premultiplied()

red

Signature: [const] unsigned short red

Description: Method quint16 QRgba64::red()

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

red8

Signature: [const] unsigned char red8

Description: Method quint8 QRgba64::red8()

red=

Signature: void red= (unsigned short _red)

Description: Method void QRgba64::setRed(quint16 _red)

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

setAlpha

Signature: void setAlpha (unsigned short _alpha)

Description: Method void QRgba64::setAlpha(quint16 _alpha)

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

setBlue

Signature: void setBlue (unsigned short _blue)

Description: Method void QRgba64::setBlue(quint16 _blue)

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

setGreen

Signature: void setGreen (unsigned short _green)

Description: Method void QRgba64::setGreen(quint16 _green)

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

setRed

Signature: void setRed (unsigned short _red)

Description: Method void QRgba64::setRed(quint16 _red)

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

toArgb32

Signature: [const] unsigned int toArgb32

Description: Method unsigned int QRgba64::toArgb32()

toRgb16

Signature: [const] unsigned short toRgb16

Description: Method unsigned short int QRgba64::toRgb16()

unpremultiplied

Signature: [const] QRgba64 unpremultiplied

Description: Method QRgba64 QRgba64::unpremultiplied()