Skip to content

PythonQt.QtGui.QSurfaceFormat · declarations 001

Back to PythonQt.QtGui.QSurfaceFormat

CompatibilityProfile instance-attribute

CompatibilityProfile: Any

CoreProfile instance-attribute

CoreProfile: Any

DebugContext instance-attribute

DebugContext: Any

DefaultRenderableType instance-attribute

DefaultRenderableType: Any

DefaultSwapBehavior instance-attribute

DefaultSwapBehavior: Any

DeprecatedFunctions instance-attribute

DeprecatedFunctions: Any

DoubleBuffer instance-attribute

DoubleBuffer: Any

FormatOption instance-attribute

FormatOption: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

FormatOptions instance-attribute

FormatOptions: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

NoProfile instance-attribute

NoProfile: Any

OpenGLContextProfile instance-attribute

OpenGLContextProfile: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

OpenGLES instance-attribute

OpenGLES: Any

RenderableType instance-attribute

RenderableType: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

ResetNotification instance-attribute

ResetNotification: Any

SingleBuffer instance-attribute

SingleBuffer: Any

StereoBuffers instance-attribute

StereoBuffers: Any

SwapBehavior instance-attribute

SwapBehavior: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

TripleBuffer instance-attribute

TripleBuffer: Any

alphaBufferSize

alphaBufferSize() -> int

X.alphaBufferSize() -> int

Supplemental documentation: Qt 5 reference:

int QSurfaceFormat::alphaBufferSize() const

Get the size in bits of the alpha channel of the color buffer.

See also setAlphaBufferSize().

Upstream PySide2 reference signatures (binding differences may apply):

alphaBufferSize(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#alphaBufferSize

blueBufferSize

blueBufferSize() -> int

X.blueBufferSize() -> int

Supplemental documentation: Qt 5 reference:

int QSurfaceFormat::blueBufferSize() const

Get the size in bits of the blue channel of the color buffer.

See also setBlueBufferSize().

Upstream PySide2 reference signatures (binding differences may apply):

blueBufferSize(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#blueBufferSize

defaultFormat

defaultFormat() -> Any

X.defaultFormat() -> PythonQt.QtGui.QSurfaceFormat

Supplemental documentation: Qt 5 reference:

[static] QSurfaceFormat QSurfaceFormat::defaultFormat()

Returns the global default surface format.

When setDefaultFormat() is not called, this is a default-constructed QSurfaceFormat.

This function was introduced in Qt 5.4.

See also setDefaultFormat().

Upstream PySide2 reference signatures (binding differences may apply):

defaultFormat() -> PySide2.QtGui.QSurfaceFormat

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#defaultFormat

depthBufferSize

depthBufferSize() -> int

X.depthBufferSize() -> int

Supplemental documentation: Qt 5 reference:

int QSurfaceFormat::depthBufferSize() const

Returns the depth buffer size.

See also setDepthBufferSize().

Upstream PySide2 reference signatures (binding differences may apply):

depthBufferSize(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#depthBufferSize

greenBufferSize

greenBufferSize() -> int

X.greenBufferSize() -> int

Supplemental documentation: Qt 5 reference:

int QSurfaceFormat::greenBufferSize() const

Get the size in bits of the green channel of the color buffer.

See also setGreenBufferSize().

Upstream PySide2 reference signatures (binding differences may apply):

greenBufferSize(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#greenBufferSize

hasAlpha

hasAlpha() -> bool

X.hasAlpha() -> bool

Supplemental documentation: Qt 5 reference:

bool QSurfaceFormat::hasAlpha() const

Returns true if the alpha buffer size is greater than zero.

This means that the surface might be used with per pixel translucency effects.

Upstream PySide2 reference signatures (binding differences may apply):

hasAlpha(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#hasAlpha

majorVersion

majorVersion() -> int

X.majorVersion() -> int

Supplemental documentation: Qt 5 reference:

int QSurfaceFormat::majorVersion() const

Returns the major OpenGL version.

The default version is 2.0.

See also setMajorVersion().

Upstream PySide2 reference signatures (binding differences may apply):

majorVersion(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#majorVersion

minorVersion

minorVersion() -> int

X.minorVersion() -> int

Supplemental documentation: Qt 5 reference:

int QSurfaceFormat::minorVersion() const

Returns the minor OpenGL version.

See also setMinorVersion().

Upstream PySide2 reference signatures (binding differences may apply):

minorVersion(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#minorVersion

operator_assign

operator_assign(other: Any) -> Any

X.operator_assign(other) -> PythonQt.QtGui.QSurfaceFormat

options

options() -> Any

X.options()

Supplemental documentation: Qt 5 reference:

QSurfaceFormat::FormatOptions QSurfaceFormat::options() const

Returns the currently set format options.

This function was introduced in Qt 5.3.

See also setOption(), setOptions(), and testOption().

Upstream PySide2 reference signatures (binding differences may apply):

options(self) -> PySide2.QtGui.QSurfaceFormat.FormatOptions

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#options

profile

profile() -> Any

X.profile()

Supplemental documentation: Qt 5 reference:

QSurfaceFormat::OpenGLContextProfile QSurfaceFormat::profile() const

Get the configured OpenGL context profile.

This setting is ignored if the requested OpenGL version is less than 3.2.

See also setProfile().

Upstream PySide2 reference signatures (binding differences may apply):

profile(self) -> PySide2.QtGui.QSurfaceFormat.OpenGLContextProfile

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#profile

redBufferSize

redBufferSize() -> int

X.redBufferSize() -> int

Supplemental documentation: Qt 5 reference:

int QSurfaceFormat::redBufferSize() const

Get the size in bits of the red channel of the color buffer.

See also setRedBufferSize().

Upstream PySide2 reference signatures (binding differences may apply):

redBufferSize(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#redBufferSize

renderableType

renderableType() -> Any

X.renderableType()

Supplemental documentation: Qt 5 reference:

QSurfaceFormat::RenderableType QSurfaceFormat::renderableType() const

Gets the renderable type.

Chooses between desktop OpenGL, OpenGL ES, and OpenVG.

See also setRenderableType().

Upstream PySide2 reference signatures (binding differences may apply):

renderableType(self) -> PySide2.QtGui.QSurfaceFormat.RenderableType

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#renderableType

samples

samples() -> int

X.samples() -> int

Supplemental documentation: Qt 5 reference:

int QSurfaceFormat::samples() const

Returns the number of samples per pixel when multisampling is enabled, or -1 when multisampling is disabled. The default return value is -1.

See also setSamples().

Upstream PySide2 reference signatures (binding differences may apply):

samples(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#samples

setAlphaBufferSize

setAlphaBufferSize(size: int) -> None

X.setAlphaBufferSize(size)

Supplemental documentation: Qt 5 reference:

void QSurfaceFormat::setAlphaBufferSize(int size)

Set the desired size in bits of the alpha channel of the color buffer.

See also alphaBufferSize().

Upstream PySide2 reference signatures (binding differences may apply):

setAlphaBufferSize(self, size: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#setAlphaBufferSize

setBlueBufferSize

setBlueBufferSize(size: int) -> None

X.setBlueBufferSize(size)

Supplemental documentation: Qt 5 reference:

void QSurfaceFormat::setBlueBufferSize(int size)

Set the desired size in bits of the blue channel of the color buffer.

See also blueBufferSize().

Upstream PySide2 reference signatures (binding differences may apply):

setBlueBufferSize(self, size: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#setBlueBufferSize

setDefaultFormat

setDefaultFormat(format: Any) -> None

X.setDefaultFormat(format)

Supplemental documentation: Qt 5 reference:

[static] void QSurfaceFormat::setDefaultFormat(const QSurfaceFormat \&format)

Sets the global default surface format.

This format is used by default in QOpenGLContext, QWindow, QOpenGLWidget and similar classes.

It can always be overridden on a per-instance basis by using the class in question's own setFormat() function. However, it is often more convenient to set the format for all windows once at the start of the application. It also guarantees proper behavior in cases where shared contexts are required, because settings the format via this function guarantees that all contexts and surfaces, even the ones created internally by Qt, will use the same format.

Note: When setting Qt::AA_ShareOpenGLContexts, it is strongly recommended to place the call to this function before the construction of the QGuiApplication or QApplication. Otherwise format will not be applied to the global share context and therefore issues may arise with context sharing afterwards.

This function was introduced in Qt 5.4.

See also defaultFormat().

Upstream PySide2 reference signatures (binding differences may apply):

setDefaultFormat(format: PySide2.QtGui.QSurfaceFormat) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#setDefaultFormat

setDepthBufferSize

setDepthBufferSize(size: int) -> None

X.setDepthBufferSize(size)

Supplemental documentation: Qt 5 reference:

void QSurfaceFormat::setDepthBufferSize(int size)

Set the minimum depth buffer size to size.

See also depthBufferSize().

Upstream PySide2 reference signatures (binding differences may apply):

setDepthBufferSize(self, size: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#setDepthBufferSize

setGreenBufferSize

setGreenBufferSize(size: int) -> None

X.setGreenBufferSize(size)

Supplemental documentation: Qt 5 reference:

void QSurfaceFormat::setGreenBufferSize(int size)

Set the desired size in bits of the green channel of the color buffer.

See also greenBufferSize().

Upstream PySide2 reference signatures (binding differences may apply):

setGreenBufferSize(self, size: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#setGreenBufferSize

setMajorVersion

setMajorVersion(majorVersion: int) -> None

X.setMajorVersion(majorVersion)

Supplemental documentation: Qt 5 reference:

void QSurfaceFormat::setMajorVersion(int major)

Sets the desired major OpenGL version.

See also majorVersion().

Upstream PySide2 reference signatures (binding differences may apply):

setMajorVersion(self, majorVersion: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#setMajorVersion

setMinorVersion

setMinorVersion(minorVersion: int) -> None

X.setMinorVersion(minorVersion)

Supplemental documentation: Qt 5 reference:

void QSurfaceFormat::setMinorVersion(int minor)

Sets the desired minor OpenGL version.

The default version is 2.0.

See also minorVersion().

Upstream PySide2 reference signatures (binding differences may apply):

setMinorVersion(self, minorVersion: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#setMinorVersion

setOption

setOption(option: Any, on: Any) -> None

X.setOption(option, on)

Supplemental documentation: Qt 5 reference:

void QSurfaceFormat::setOption(QSurfaceFormat::FormatOption option, bool on \= true)

Sets the format option option if on is true; otherwise, clears the option.

This function was introduced in Qt 5.3.

See also setOptions(), options(), and testOption().

Upstream PySide2 reference signatures (binding differences may apply):

setOption(self, opt: PySide2.QtGui.QSurfaceFormat.FormatOptions) -> None
setOption(self, option: PySide2.QtGui.QSurfaceFormat.FormatOption, on: bool=...) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html#setOption