PySide6.QtOpenGL.QOpenGLFramebufferObjectFormat

class QOpenGLFramebufferObjectFormat

The QOpenGLFramebufferObjectFormat class specifies the format of an OpenGL framebuffer object.

Details

A framebuffer object has several characteristics:

Note that the desired attachments or number of samples per pixels might not be supported by the hardware driver. Call QOpenGLFramebufferObject::format() after creating a QOpenGLFramebufferObject to find the exact format that was used to create the frame buffer object.

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

__init__()

Creates a QOpenGLFramebufferObjectFormat object for specifying the format of an OpenGL framebuffer object.

By default the format specifies a non-multisample framebuffer object with no depth/stencil attachments, texture target GL_TEXTURE_2D, and internal format GL_RGBA8. On OpenGL/ES systems, the default internal format is GL_RGBA.

__init__(other)
Parameters:

other – QOpenGLFramebufferObjectFormat

Constructs a copy of other.

attachment()
Return type:

Attachment

Returns the configuration of the depth and stencil buffers attached to a framebuffer object. The default is NoAttachment .

See also

setAttachment()

internalTextureFormat()
Return type:

int

Returns the internal format of a framebuffer object’s texture or multisample framebuffer object’s color buffer. The default is GL_RGBA8 on desktop OpenGL systems, and GL_RGBA on OpenGL/ES systems.

mipmap()
Return type:

bool

Returns true if mipmapping is enabled.

See also

setMipmap()

__ne__(other)
Parameters:

other – QOpenGLFramebufferObjectFormat

Return type:

bool

Returns false if all the options of this framebuffer object format are the same as other; otherwise returns true.

__eq__(other)
Parameters:

other – QOpenGLFramebufferObjectFormat

Return type:

bool

Returns true if all the options of this framebuffer object format are the same as other; otherwise returns false.

samples()
Return type:

int

Returns the number of samples per pixel if a framebuffer object is a multisample framebuffer object. Otherwise, returns 0. The default value is 0.

See also

setSamples()

setAttachment(attachment)
Parameters:

attachment – Attachment

Sets the attachment configuration of a framebuffer object to attachment.

See also

attachment()

setInternalTextureFormat(internalTextureFormat)
Parameters:

internalTextureFormat – int

Sets the internal format of a framebuffer object’s texture or multisample framebuffer object’s color buffer to internalTextureFormat.

setMipmap(enabled)
Parameters:

enabled – bool

Enables mipmapping if enabled is true; otherwise disables it.

Mipmapping is disabled by default.

If mipmapping is enabled, additional memory will be allocated for the mipmap levels. The mipmap levels can be updated by binding the texture and calling glGenerateMipmap(). Mipmapping cannot be enabled for multisampled framebuffer objects.

See also

mipmap() texture()

setSamples(samples)
Parameters:

samples – int

Sets the number of samples per pixel for a multisample framebuffer object to samples. The default sample count of 0 represents a regular non-multisample framebuffer object.

If the desired amount of samples per pixel is not supported by the hardware then the maximum number of samples per pixel will be used. Note that multisample framebuffer objects cannot be bound as textures. Also, the GL_EXT_framebuffer_multisample extension is required to create a framebuffer with more than one sample per pixel.

See also

samples()

setTextureTarget(target)
Parameters:

target – int

Sets the texture target of the texture attached to a framebuffer object to target. Ignored for multisample framebuffer objects.

textureTarget()
Return type:

int

Returns the texture target of the texture attached to a framebuffer object. Ignored for multisample framebuffer objects. The default is GL_TEXTURE_2D.