API reference - Class QSurfaceFormat

!=

Signature: [const] bool != (const QSurfaceFormat arg2)

Description: Operator bool ::operator!=(const QSurfaceFormat &, const QSurfaceFormat &)

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

==

Signature: [const] bool == (const QSurfaceFormat arg2)

Description: Operator bool ::operator==(const QSurfaceFormat &, const QSurfaceFormat &)

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

CompatibilityProfile

Signature: [static,const] QSurfaceFormat_OpenGLContextProfile CompatibilityProfile

Description: Enum constant QSurfaceFormat::CompatibilityProfile

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

CoreProfile

Signature: [static,const] QSurfaceFormat_OpenGLContextProfile CoreProfile

Description: Enum constant QSurfaceFormat::CoreProfile

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

DebugContext

Signature: [static,const] QSurfaceFormat_FormatOption DebugContext

Description: Enum constant QSurfaceFormat::DebugContext

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

DefaultColorSpace

Signature: [static,const] QSurfaceFormat_ColorSpace DefaultColorSpace

Description: Enum constant QSurfaceFormat::DefaultColorSpace

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

DefaultRenderableType

Signature: [static,const] QSurfaceFormat_RenderableType DefaultRenderableType

Description: Enum constant QSurfaceFormat::DefaultRenderableType

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

DefaultSwapBehavior

Signature: [static,const] QSurfaceFormat_SwapBehavior DefaultSwapBehavior

Description: Enum constant QSurfaceFormat::DefaultSwapBehavior

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

DeprecatedFunctions

Signature: [static,const] QSurfaceFormat_FormatOption DeprecatedFunctions

Description: Enum constant QSurfaceFormat::DeprecatedFunctions

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

DoubleBuffer

Signature: [static,const] QSurfaceFormat_SwapBehavior DoubleBuffer

Description: Enum constant QSurfaceFormat::DoubleBuffer

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

NoProfile

Signature: [static,const] QSurfaceFormat_OpenGLContextProfile NoProfile

Description: Enum constant QSurfaceFormat::NoProfile

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

OpenGL

Signature: [static,const] QSurfaceFormat_RenderableType OpenGL

Description: Enum constant QSurfaceFormat::OpenGL

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

OpenGLES

Signature: [static,const] QSurfaceFormat_RenderableType OpenGLES

Description: Enum constant QSurfaceFormat::OpenGLES

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

OpenVG

Signature: [static,const] QSurfaceFormat_RenderableType OpenVG

Description: Enum constant QSurfaceFormat::OpenVG

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

ResetNotification

Signature: [static,const] QSurfaceFormat_FormatOption ResetNotification

Description: Enum constant QSurfaceFormat::ResetNotification

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

SingleBuffer

Signature: [static,const] QSurfaceFormat_SwapBehavior SingleBuffer

Description: Enum constant QSurfaceFormat::SingleBuffer

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

StereoBuffers

Signature: [static,const] QSurfaceFormat_FormatOption StereoBuffers

Description: Enum constant QSurfaceFormat::StereoBuffers

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

TripleBuffer

Signature: [static,const] QSurfaceFormat_SwapBehavior TripleBuffer

Description: Enum constant QSurfaceFormat::TripleBuffer

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

_assign

Signature: void _assign (const QSurfaceFormat other)

Description: Assigns another object to self

_const_cast

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

alphaBufferSize

Signature: [const] int alphaBufferSize

Description: Method int QSurfaceFormat::alphaBufferSize()

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

alphaBufferSize=

Signature: void alphaBufferSize= (int size)

Description: Method void QSurfaceFormat::setAlphaBufferSize(int size)

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

assign

Signature: QSurfaceFormat assign (const QSurfaceFormat other)

Description: Method QSurfaceFormat &QSurfaceFormat::operator=(const QSurfaceFormat &other)

blueBufferSize

Signature: [const] int blueBufferSize

Description: Method int QSurfaceFormat::blueBufferSize()

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

blueBufferSize=

Signature: void blueBufferSize= (int size)

Description: Method void QSurfaceFormat::setBlueBufferSize(int size)

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

colorSpace

Signature: [const] QSurfaceFormat_ColorSpace colorSpace

Description: Method QSurfaceFormat::ColorSpace QSurfaceFormat::colorSpace()

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

colorSpace=

Signature: void colorSpace= (const QSurfaceFormat_ColorSpace colorSpace)

Description: Method void QSurfaceFormat::setColorSpace(QSurfaceFormat::ColorSpace colorSpace)

Python specific notes:
The object exposes a writable attribute 'colorSpace'. 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.

defaultFormat

Signature: [static] QSurfaceFormat defaultFormat

Description: Static method QSurfaceFormat QSurfaceFormat::defaultFormat()

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

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

defaultFormat=

Signature: [static] void defaultFormat= (const QSurfaceFormat format)

Description: Static method void QSurfaceFormat::setDefaultFormat(const QSurfaceFormat &format)

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

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

depthBufferSize

Signature: [const] int depthBufferSize

Description: Method int QSurfaceFormat::depthBufferSize()

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

depthBufferSize=

Signature: void depthBufferSize= (int size)

Description: Method void QSurfaceFormat::setDepthBufferSize(int size)

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

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

Description: Creates a copy of self

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

greenBufferSize

Signature: [const] int greenBufferSize

Description: Method int QSurfaceFormat::greenBufferSize()

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

greenBufferSize=

Signature: void greenBufferSize= (int size)

Description: Method void QSurfaceFormat::setGreenBufferSize(int size)

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

hasAlpha

Signature: [const] bool hasAlpha

Description: Method bool QSurfaceFormat::hasAlpha()

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.

majorVersion

Signature: [const] int majorVersion

Description: Method int QSurfaceFormat::majorVersion()

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

majorVersion=

Signature: void majorVersion= (int majorVersion)

Description: Method void QSurfaceFormat::setMajorVersion(int majorVersion)

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

minorVersion

Signature: [const] int minorVersion

Description: Method int QSurfaceFormat::minorVersion()

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

minorVersion=

Signature: void minorVersion= (int minorVersion)

Description: Method void QSurfaceFormat::setMinorVersion(int minorVersion)

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

new

(1) Signature: [static] new QSurfaceFormat new

Description: Constructor QSurfaceFormat::QSurfaceFormat()

This method creates an object of class QSurfaceFormat.

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

(2) Signature: [static] new QSurfaceFormat new (QSurfaceFormat_QFlags_FormatOption options)

Description: Constructor QSurfaceFormat::QSurfaceFormat(QFlags<QSurfaceFormat::FormatOption> options)

This method creates an object of class QSurfaceFormat.

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

(3) Signature: [static] new QSurfaceFormat new (const QSurfaceFormat other)

Description: Constructor QSurfaceFormat::QSurfaceFormat(const QSurfaceFormat &other)

This method creates an object of class QSurfaceFormat.

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

options

Signature: [const] QSurfaceFormat_QFlags_FormatOption options

Description: Method QFlags<QSurfaceFormat::FormatOption> QSurfaceFormat::options()

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

options=

Signature: void options= (QSurfaceFormat_QFlags_FormatOption options)

Description: Method void QSurfaceFormat::setOptions(QFlags<QSurfaceFormat::FormatOption> options)

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

profile

Signature: [const] QSurfaceFormat_OpenGLContextProfile profile

Description: Method QSurfaceFormat::OpenGLContextProfile QSurfaceFormat::profile()

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

profile=

Signature: void profile= (const QSurfaceFormat_OpenGLContextProfile profile)

Description: Method void QSurfaceFormat::setProfile(QSurfaceFormat::OpenGLContextProfile profile)

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

redBufferSize

Signature: [const] int redBufferSize

Description: Method int QSurfaceFormat::redBufferSize()

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

redBufferSize=

Signature: void redBufferSize= (int size)

Description: Method void QSurfaceFormat::setRedBufferSize(int size)

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

renderableType

Signature: [const] QSurfaceFormat_RenderableType renderableType

Description: Method QSurfaceFormat::RenderableType QSurfaceFormat::renderableType()

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

renderableType=

Signature: void renderableType= (const QSurfaceFormat_RenderableType type)

Description: Method void QSurfaceFormat::setRenderableType(QSurfaceFormat::RenderableType type)

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

sRGBColorSpace

Signature: [static,const] QSurfaceFormat_ColorSpace sRGBColorSpace

Description: Enum constant QSurfaceFormat::sRGBColorSpace

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

samples

Signature: [const] int samples

Description: Method int QSurfaceFormat::samples()

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

samples=

Signature: void samples= (int numSamples)

Description: Method void QSurfaceFormat::setSamples(int numSamples)

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

setAlphaBufferSize

Signature: void setAlphaBufferSize (int size)

Description: Method void QSurfaceFormat::setAlphaBufferSize(int size)

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

setBlueBufferSize

Signature: void setBlueBufferSize (int size)

Description: Method void QSurfaceFormat::setBlueBufferSize(int size)

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

setColorSpace

Signature: void setColorSpace (const QSurfaceFormat_ColorSpace colorSpace)

Description: Method void QSurfaceFormat::setColorSpace(QSurfaceFormat::ColorSpace colorSpace)

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

setDefaultFormat

Signature: [static] void setDefaultFormat (const QSurfaceFormat format)

Description: Static method void QSurfaceFormat::setDefaultFormat(const QSurfaceFormat &format)

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

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

setDepthBufferSize

Signature: void setDepthBufferSize (int size)

Description: Method void QSurfaceFormat::setDepthBufferSize(int size)

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

setGreenBufferSize

Signature: void setGreenBufferSize (int size)

Description: Method void QSurfaceFormat::setGreenBufferSize(int size)

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

setMajorVersion

Signature: void setMajorVersion (int majorVersion)

Description: Method void QSurfaceFormat::setMajorVersion(int majorVersion)

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

setMinorVersion

Signature: void setMinorVersion (int minorVersion)

Description: Method void QSurfaceFormat::setMinorVersion(int minorVersion)

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

setOption

(1) Signature: void setOption (QSurfaceFormat_QFlags_FormatOption opt)

Description: Method void QSurfaceFormat::setOption(QFlags<QSurfaceFormat::FormatOption> opt)

(2) Signature: void setOption (const QSurfaceFormat_FormatOption option, bool on = true)

Description: Method void QSurfaceFormat::setOption(QSurfaceFormat::FormatOption option, bool on)

setOptions

Signature: void setOptions (QSurfaceFormat_QFlags_FormatOption options)

Description: Method void QSurfaceFormat::setOptions(QFlags<QSurfaceFormat::FormatOption> options)

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

setProfile

Signature: void setProfile (const QSurfaceFormat_OpenGLContextProfile profile)

Description: Method void QSurfaceFormat::setProfile(QSurfaceFormat::OpenGLContextProfile profile)

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

setRedBufferSize

Signature: void setRedBufferSize (int size)

Description: Method void QSurfaceFormat::setRedBufferSize(int size)

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

setRenderableType

Signature: void setRenderableType (const QSurfaceFormat_RenderableType type)

Description: Method void QSurfaceFormat::setRenderableType(QSurfaceFormat::RenderableType type)

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

setSamples

Signature: void setSamples (int numSamples)

Description: Method void QSurfaceFormat::setSamples(int numSamples)

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

setStencilBufferSize

Signature: void setStencilBufferSize (int size)

Description: Method void QSurfaceFormat::setStencilBufferSize(int size)

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

setStereo

Signature: void setStereo (bool enable)

Description: Method void QSurfaceFormat::setStereo(bool enable)

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

setSwapBehavior

Signature: void setSwapBehavior (const QSurfaceFormat_SwapBehavior behavior)

Description: Method void QSurfaceFormat::setSwapBehavior(QSurfaceFormat::SwapBehavior behavior)

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

setSwapInterval

Signature: void setSwapInterval (int interval)

Description: Method void QSurfaceFormat::setSwapInterval(int interval)

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

setVersion

Signature: void setVersion (int major, int minor)

Description: Method void QSurfaceFormat::setVersion(int major, int minor)

stencilBufferSize

Signature: [const] int stencilBufferSize

Description: Method int QSurfaceFormat::stencilBufferSize()

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

stencilBufferSize=

Signature: void stencilBufferSize= (int size)

Description: Method void QSurfaceFormat::setStencilBufferSize(int size)

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

stereo

Signature: [const] bool stereo

Description: Method bool QSurfaceFormat::stereo()

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

stereo=

Signature: void stereo= (bool enable)

Description: Method void QSurfaceFormat::setStereo(bool enable)

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

swapBehavior

Signature: [const] QSurfaceFormat_SwapBehavior swapBehavior

Description: Method QSurfaceFormat::SwapBehavior QSurfaceFormat::swapBehavior()

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

swapBehavior=

Signature: void swapBehavior= (const QSurfaceFormat_SwapBehavior behavior)

Description: Method void QSurfaceFormat::setSwapBehavior(QSurfaceFormat::SwapBehavior behavior)

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

swapInterval

Signature: [const] int swapInterval

Description: Method int QSurfaceFormat::swapInterval()

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

swapInterval=

Signature: void swapInterval= (int interval)

Description: Method void QSurfaceFormat::setSwapInterval(int interval)

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

testOption

(1) Signature: [const] bool testOption (QSurfaceFormat_QFlags_FormatOption opt)

Description: Method bool QSurfaceFormat::testOption(QFlags<QSurfaceFormat::FormatOption> opt)

(2) Signature: [const] bool testOption (const QSurfaceFormat_FormatOption option)

Description: Method bool QSurfaceFormat::testOption(QSurfaceFormat::FormatOption option)

version

Signature: [const] QPair_int_int version

Description: Method QPair<int, int> QSurfaceFormat::version()