PythonQt.QtGui.QSurfaceFormat
QSurfaceFormat
PythonQtInstanceWrapper object
Native bases: PythonQtInstanceWrapper
Supplemental documentation: Qt 5 reference:
Detailed Description
The format includes the size of the color buffers, red, green, and blue; the size of the alpha buffer; the size of the depth and stencil buffers; and number of samples per pixel for multisampling. In addition, the format contains surface configuration parameters such as OpenGL profile and version for rendering, whether or not to enable stereo buffers, and swap behaviour.
Note: When troubleshooting context or window format issues, it can be helpful to
enable the logging category qt.qpa.gl. Depending on the platform, this may print
useful debug information when it comes to OpenGL initialization and the native visual or
framebuffer configurations which QSurfaceFormat gets mapped to.
Source: https://doc.qt.io/archives/qt-5.15/qsurfaceformat.html
Complete member index
Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.
| Member | Kind | Signature | Summary |
|---|---|---|---|
CompatibilityProfile |
attribute | Any |
|
CoreProfile |
attribute | Any |
|
DebugContext |
attribute | Any |
|
DefaultRenderableType |
attribute | Any |
|
DefaultSwapBehavior |
attribute | Any |
|
DeprecatedFunctions |
attribute | Any |
|
DoubleBuffer |
attribute | Any |
|
FormatOption |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. |
FormatOptions |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. |
NoProfile |
attribute | Any |
|
OpenGL |
attribute | Any |
(shared captured text) |
OpenGLContextProfile |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. |
OpenGLES |
attribute | Any |
|
OpenVG |
attribute | Any |
(shared captured text) |
RenderableType |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. |
ResetNotification |
attribute | Any |
|
SingleBuffer |
attribute | Any |
|
StereoBuffers |
attribute | Any |
|
SwapBehavior |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. |
TripleBuffer |
attribute | Any |
|
__init__ |
function | (self, *args: Any, **kwargs: Any) -> None |
Native constructor; consult class documentation for supported overloads. (shared captured text) |
alphaBufferSize |
function | (self) -> int |
X.alphaBufferSize() -> int |
blueBufferSize |
function | (self) -> int |
X.blueBufferSize() -> int |
className |
function | (self, *args: Any, **kwargs: Any) -> Any |
Return the classname of the object (shared captured text) |
defaultFormat |
function | (self) -> Any |
X.defaultFormat() -> PythonQt.QtGui.QSurfaceFormat |
delete |
function | (self, *args: Any, **kwargs: Any) -> Any |
Deletes the C++ object (at your own risk, my friend!) (shared captured text) |
depthBufferSize |
function | (self) -> int |
X.depthBufferSize() -> int |
greenBufferSize |
function | (self) -> int |
X.greenBufferSize() -> int |
hasAlpha |
function | (self) -> bool |
X.hasAlpha() -> bool |
help |
function | (self, *args: Any, **kwargs: Any) -> Any |
Shows the help of available methods for this class (shared captured text) |
inherits |
function | (self, *args: Any, **kwargs: Any) -> Any |
Returns if the class inherits or is of given type name (shared captured text) |
majorVersion |
function | (self) -> int |
X.majorVersion() -> int |
minorVersion |
function | (self) -> int |
X.minorVersion() -> int |
operator_assign |
function | (self, other: Any) -> Any |
X.operator_assign(other) -> PythonQt.QtGui.QSurfaceFormat |
options |
function | (self) -> Any |
Returns the currently set format options. |
profile |
function | (self) -> Any |
Get the configured OpenGL context profile. |
redBufferSize |
function | (self) -> int |
X.redBufferSize() -> int |
renderableType |
function | (self) -> Any |
Gets the renderable type. |
samples |
function | (self) -> int |
X.samples() -> int |
setAlphaBufferSize |
function | (self, size: int) -> None |
Set the desired size in bits of the alpha channel of the color buffer. |
setBlueBufferSize |
function | (self, size: int) -> None |
Set the desired size in bits of the blue channel of the color buffer. |
setDefaultFormat |
function | (self, format: Any) -> None |
Sets the global default surface format. |
setDepthBufferSize |
function | (self, size: int) -> None |
Set the minimum depth buffer size to size. |
setGreenBufferSize |
function | (self, size: int) -> None |
Set the desired size in bits of the green channel of the color buffer. |
setMajorVersion |
function | (self, majorVersion: int) -> None |
Sets the desired major OpenGL version. |
setMinorVersion |
function | (self, minorVersion: int) -> None |
Sets the desired minor OpenGL version. |
setOption |
function | (self, option: Any, on: Any) -> None |
X.setOption(option, on) |
setOptions |
function | (self, options: Any) -> None |
Sets the format options to options. |
setProfile |
function | (self, profile: Any) -> None |
Sets the desired OpenGL context profile. |
setRedBufferSize |
function | (self, size: int) -> None |
Set the desired size in bits of the red channel of the color buffer. |
setRenderableType |
function | (self, type: Any) -> None |
Sets the desired renderable type. |
setSamples |
function | (self, numSamples: int) -> None |
Set the preferred number of samples per pixel when multisampling is enabled to numSamples. |
setStencilBufferSize |
function | (self, size: int) -> None |
Set the preferred stencil buffer size to size bits. |
setStereo |
function | (self, enable: bool) -> None |
If enable is true enables stereo buffering; otherwise disables stereo buffering. |
setSwapBehavior |
function | (self, behavior: Any) -> None |
Set the swap behavior of the surface. |
setSwapInterval |
function | (self, interval: int) -> None |
Sets the preferred swap interval. |
setVersion |
function | (self, major: int, minor: int) -> None |
X.setVersion(major, minor) |
stencilBufferSize |
function | (self) -> int |
X.stencilBufferSize() -> int |
stereo |
function | (self) -> bool |
X.stereo() -> bool |
swapBehavior |
function | (self) -> Any |
Returns the configured swap behaviour. |
swapInterval |
function | (self) -> int |
X.swapInterval() -> int |
testOption |
function | (self, opt: Any) -> bool |
X.testOption(opt) -> bool |
version |
function | (self) -> Any |
Returns a [QPair](https://doc.qt.io/archives/qt-5.15/qpair.html)\<int, int\> representing the OpenGL version. |