QOpenGLFramebufferObject

The QOpenGLFramebufferObject class encapsulates an OpenGL framebuffer object. More…

New in version 5.0.

Synopsis

Functions

• def addColorAttachment (size[, internalFormat=0])

• def addColorAttachment (width, height[, internalFormat=0])

• def attachment ()

• def bind ()

• def format ()

• def handle ()

• def height ()

• def isBound ()

• def isValid ()

• def release ()

• def setAttachment (attachment)

• def size ()

• def sizes ()

• def takeTexture ()

• def takeTexture (colorAttachmentIndex)

• def texture ()

• def textures ()

• def toImage ([flipped=true])

• def toImage (flipped, colorAttachmentIndex)

• def width ()

Static functions

• def bindDefault ()

• def blitFramebuffer (target, source[, buffers=GL_COLOR_BUFFER_BIT[, filter=GL_NEAREST]])

• def blitFramebuffer (target, targetRect, source, sourceRect, buffers, filter, readColorAttachmentIndex, drawColorAttachmentIndex)

• def blitFramebuffer (target, targetRect, source, sourceRect, buffers, filter, readColorAttachmentIndex, drawColorAttachmentIndex, restorePolicy)

• def blitFramebuffer (target, targetRect, source, sourceRect[, buffers=GL_COLOR_BUFFER_BIT[, filter=GL_NEAREST]])

• def hasOpenGLFramebufferBlit ()

• def hasOpenGLFramebufferObjects ()

Detailed Description

The QOpenGLFramebufferObject class encapsulates an OpenGL framebuffer object, defined by the GL_EXT_framebuffer_object extension. It provides a rendering surface that can be painted on with a QPainter with the help of QOpenGLPaintDevice , or rendered to using native OpenGL calls. This surface can be bound and used as a regular texture in your own OpenGL drawing code. By default, the QOpenGLFramebufferObject class generates a 2D OpenGL texture (using the GL_TEXTURE_2D target), which is used as the internal rendering target.

It is important to have a current OpenGL context when creating a QOpenGLFramebufferObject , otherwise initialization will fail.

Create the QOpenGLFrameBufferObject instance with the CombinedDepthStencil attachment if you want QPainter to render correctly. Note that you need to create a QOpenGLFramebufferObject with more than one sample per pixel for primitives to be antialiased when drawing using a QPainter . To create a multisample framebuffer object you should use one of the constructors that take a QOpenGLFramebufferObjectFormat parameter, and set the samples() property to a non-zero value.

For multisample framebuffer objects a color render buffer is created, otherwise a texture with the specified texture target is created. The color render buffer or texture will have the specified internal format, and will be bound to the GL_COLOR_ATTACHMENT0 attachment in the framebuffer object.

Multiple render targets are also supported, in case the OpenGL implementation supports this. Here there will be multiple textures (or, in case of multisampling, renderbuffers) present and each of them will get attached to GL_COLOR_ATTACHMENT0, 1, 2, …

If you want to use a framebuffer object with multisampling enabled as a texture, you first need to copy from it to a regular framebuffer object using QOpenGLContext::blitFramebuffer().

It is possible to draw into a QOpenGLFramebufferObject using QPainter and QOpenGLPaintDevice in a separate thread.

class PySide6.QtOpenGL.QOpenGLFramebufferObject(size, attachment[, target=GL_TEXTURE_2D[, internalFormat=0]])

PySide6.QtOpenGL.QOpenGLFramebufferObject(size, format)

PySide6.QtOpenGL.QOpenGLFramebufferObject(size[, target=GL_TEXTURE_2D])

PySide6.QtOpenGL.QOpenGLFramebufferObject(width, height, attachment[, target=GL_TEXTURE_2D[, internalFormat=0]])

PySide6.QtOpenGL.QOpenGLFramebufferObject(width, height, format)

PySide6.QtOpenGL.QOpenGLFramebufferObject(width, height[, target=GL_TEXTURE_2D])

Parameters

• width – int

• target – int

• internalFormat – int

• size – PySide6.QtCore.QSize

• attachment – Attachment

• format – PySide6.QtOpenGL.QOpenGLFramebufferObjectFormat

• height – int

Constructs an OpenGL framebuffer object and binds a texture to the buffer of the given size.

The attachment parameter describes the depth/stencil buffer configuration, target the texture target and internalFormat the internal texture format. The default texture target is GL_TEXTURE_2D, while the default internal format is GL_RGBA8 for desktop OpenGL and GL_RGBA for OpenGL/ES.

See also

size() texture() attachment()

Constructs an OpenGL framebuffer object of the given size based on the supplied format.

Constructs an OpenGL framebuffer object and binds a texture to the buffer of the given width and height.

The attachment parameter describes the depth/stencil buffer configuration, target the texture target and internalFormat the internal texture format. The default texture target is GL_TEXTURE_2D, while the default internal format is GL_RGBA8 for desktop OpenGL and GL_RGBA for OpenGL/ES.

See also

size() texture() attachment()

Constructs an OpenGL framebuffer object of the given width and height based on the supplied format.

PySide6.QtOpenGL.QOpenGLFramebufferObject.Attachment

This enum type is used to configure the depth and stencil buffers attached to the framebuffer object when it is created.

Constant	Description
QOpenGLFramebufferObject.NoAttachment	No attachment is added to the framebuffer object. Note that the OpenGL depth and stencil tests won’t work when rendering to a framebuffer object without any depth or stencil buffers. This is the default value.
QOpenGLFramebufferObject.CombinedDepthStencil	If the GL_EXT_packed_depth_stencil extension is present, a combined depth and stencil buffer is attached. If the extension is not present, only a depth buffer is attached.
QOpenGLFramebufferObject.Depth	A depth buffer is attached to the framebuffer object.

See also

attachment()

PySide6.QtOpenGL.QOpenGLFramebufferObject.FramebufferRestorePolicy

This enum type is used to configure the behavior related to restoring framebuffer bindings when calling blitFramebuffer() .

Constant	Description
QOpenGLFramebufferObject.DontRestoreFramebufferBinding	Do not restore the previous framebuffer binding. The caller is responsible for tracking and setting the framebuffer binding as needed.
QOpenGLFramebufferObject.RestoreFramebufferBindingToDefault	After the blit operation, bind the default framebuffer.
QOpenGLFramebufferObject.RestoreFrameBufferBinding	Restore the previously bound framebuffer. This is potentially expensive because of the need to query the currently bound framebuffer.

See also

blitFramebuffer()

New in version 5.7.

PySide6.QtOpenGL.QOpenGLFramebufferObject.addColorAttachment(size[, internalFormat=0])

Parameters

• size – PySide6.QtCore.QSize

• internalFormat – int

Creates and attaches an additional texture or renderbuffer of size width and height.

There is always an attachment at GL_COLOR_ATTACHMENT0. Call this function to set up additional attachments at GL_COLOR_ATTACHMENT1, GL_COLOR_ATTACHMENT2, …

When internalFormat is not 0, it specifies the internal format of the texture or renderbuffer. Otherwise a default of GL_RGBA or GL_RGBA8 is used.

Note

This is only functional when multiple render targets are supported by the OpenGL implementation. When that is not the case, the function will not add any additional color attachments. Call hasOpenGLFeature() with MultipleRenderTargets at runtime to check if MRT is supported.

Note

The internal format of the color attachments may differ but there may be limitations on the supported combinations, depending on the drivers.

Note

The size of the color attachments may differ but rendering is limited to the area that fits all the attachments, according to the OpenGL specification. Some drivers may not be fully conformant in this respect, however.

PySide6.QtOpenGL.QOpenGLFramebufferObject.addColorAttachment(width, height[, internalFormat=0])

Parameters

• width – int

• height – int

• internalFormat – int

This is an overloaded function.

Creates and attaches an additional texture or renderbuffer of size width and height.

When internalFormat is not 0, it specifies the internal format of the texture or renderbuffer. Otherwise a default of GL_RGBA or GL_RGBA8 is used.

PySide6.QtOpenGL.QOpenGLFramebufferObject.attachment()

Return type

Attachment

Returns the status of the depth and stencil buffers attached to this framebuffer object.

See also

setAttachment()

PySide6.QtOpenGL.QOpenGLFramebufferObject.bind()

Return type

bool

Switches rendering from the default, windowing system provided framebuffer to this framebuffer object. Returns true upon success, false otherwise.

Note

If takeTexture() was called, a new texture is created and associated with the framebuffer object. This is potentially expensive and changes the context state (the currently bound texture).

See also

release()

static PySide6.QtOpenGL.QOpenGLFramebufferObject.bindDefault()

Return type

bool

Switches rendering back to the default, windowing system provided framebuffer. Returns true upon success, false otherwise.

See also

bind() release()

static PySide6.QtOpenGL.QOpenGLFramebufferObject.blitFramebuffer(target, source[, buffers=GL_COLOR_BUFFER_BIT[, filter=GL_NEAREST]])

Parameters

• target – PySide6.QtOpenGL.QOpenGLFramebufferObject

• source – PySide6.QtOpenGL.QOpenGLFramebufferObject

• buffers – int

• filter – int

This is an overloaded function.

Convenience overload to blit between two framebuffer objects.

static PySide6.QtOpenGL.QOpenGLFramebufferObject.blitFramebuffer(target, targetRect, source, sourceRect[, buffers=GL_COLOR_BUFFER_BIT[, filter=GL_NEAREST]])

Parameters

• target – PySide6.QtOpenGL.QOpenGLFramebufferObject

• targetRect – PySide6.QtCore.QRect

• source – PySide6.QtOpenGL.QOpenGLFramebufferObject

• sourceRect – PySide6.QtCore.QRect

• buffers – int

• filter – int

This is an overloaded function.

* Convenience overload to blit between two framebuffer objects.

static PySide6.QtOpenGL.QOpenGLFramebufferObject.blitFramebuffer(target, targetRect, source, sourceRect, buffers, filter, readColorAttachmentIndex, drawColorAttachmentIndex)

Parameters

• target – PySide6.QtOpenGL.QOpenGLFramebufferObject

• targetRect – PySide6.QtCore.QRect

• source – PySide6.QtOpenGL.QOpenGLFramebufferObject

• sourceRect – PySide6.QtCore.QRect

• buffers – int

• filter – int

• readColorAttachmentIndex – int

• drawColorAttachmentIndex – int

This is an overloaded function.

Convenience overload to blit between two framebuffer objects and to restore the previous framebuffer binding. Equivalent to calling blitFramebuffer (target, targetRect, source, sourceRect, buffers, filter, readColorAttachmentIndex, drawColorAttachmentIndex, RestoreFrameBufferBinding ).

static PySide6.QtOpenGL.QOpenGLFramebufferObject.blitFramebuffer(target, targetRect, source, sourceRect, buffers, filter, readColorAttachmentIndex, drawColorAttachmentIndex, restorePolicy)

Parameters

• target – PySide6.QtOpenGL.QOpenGLFramebufferObject

• targetRect – PySide6.QtCore.QRect

• source – PySide6.QtOpenGL.QOpenGLFramebufferObject

• sourceRect – PySide6.QtCore.QRect

• buffers – int

• filter – int

• readColorAttachmentIndex – int

• drawColorAttachmentIndex – int

• restorePolicy – FramebufferRestorePolicy

Blits from the sourceRect rectangle in the source framebuffer object to the targetRect rectangle in the target framebuffer object.

If source or target is 0, the default framebuffer will be used instead of a framebuffer object as source or target respectively.

This function will have no effect unless hasOpenGLFramebufferBlit() returns true.

The buffers parameter should be a mask consisting of any combination of GL_COLOR_BUFFER_BIT, GL_DEPTH_BUFFER_BIT, and GL_STENCIL_BUFFER_BIT. Any buffer type that is not present both in the source and target buffers is ignored.

The sourceRect and targetRect rectangles may have different sizes; in this case buffers should not contain GL_DEPTH_BUFFER_BIT or GL_STENCIL_BUFFER_BIT. The filter parameter should be set to GL_LINEAR or GL_NEAREST, and specifies whether linear or nearest interpolation should be used when scaling is performed.

If source equals target a copy is performed within the same buffer. Results are undefined if the source and target rectangles overlap and have different sizes. The sizes must also be the same if any of the framebuffer objects are multisample framebuffers.

Note

The scissor test will restrict the blit area if enabled.

When multiple render targets are in use, readColorAttachmentIndex and drawColorAttachmentIndex specify the index of the color attachments in the source and destination framebuffers.

The restorePolicy determines if the framebuffer that was bound prior to calling this function should be restored, or if the default framebuffer should be bound before returning, of if the caller is responsible for tracking and setting the bound framebuffer. Restoring the previous framebuffer can be relatively expensive due to the call to glGetIntegerv which on some OpenGL drivers may imply a pipeline stall.

See also

hasOpenGLFramebufferBlit()

PySide6.QtOpenGL.QOpenGLFramebufferObject.format()

Return type

PySide6.QtOpenGL.QOpenGLFramebufferObjectFormat

Returns the format of this framebuffer object.

PySide6.QtOpenGL.QOpenGLFramebufferObject.handle()

Return type

int

Returns the OpenGL framebuffer object handle for this framebuffer object (returned by the glGenFrameBuffersEXT() function). This handle can be used to attach new images or buffers to the framebuffer. The user is responsible for cleaning up and destroying these objects.

static PySide6.QtOpenGL.QOpenGLFramebufferObject.hasOpenGLFramebufferBlit()

Return type

bool

Returns true if the OpenGL GL_EXT_framebuffer_blit extension is present on this system; otherwise returns false.

See also

blitFramebuffer()

static PySide6.QtOpenGL.QOpenGLFramebufferObject.hasOpenGLFramebufferObjects()

Return type

bool

Returns true if the OpenGL GL_EXT_framebuffer_object extension is present on this system; otherwise returns false.

PySide6.QtOpenGL.QOpenGLFramebufferObject.height()

Return type

int

Returns the height of the framebuffer object attachments.

PySide6.QtOpenGL.QOpenGLFramebufferObject.isBound()

Return type

bool

Returns true if the framebuffer object is currently bound to the current context, otherwise false is returned.

PySide6.QtOpenGL.QOpenGLFramebufferObject.isValid()

Return type

bool

Returns true if the framebuffer object is valid.

The framebuffer can become invalid if the initialization process fails, the user attaches an invalid buffer to the framebuffer object, or a non-power of two width/height is specified as the texture size if the texture target is GL_TEXTURE_2D. The non-power of two limitation does not apply if the OpenGL version is 2.0 or higher, or if the GL_ARB_texture_non_power_of_two extension is present.

The framebuffer can also become invalid if the QOpenGLContext that the framebuffer was created within is destroyed and there are no other shared contexts that can take over ownership of the framebuffer.

PySide6.QtOpenGL.QOpenGLFramebufferObject.release()

Return type

bool

Switches rendering back to the default, windowing system provided framebuffer. Returns true upon success, false otherwise.

See also

bind()

PySide6.QtOpenGL.QOpenGLFramebufferObject.setAttachment(attachment)

Parameters

attachment – Attachment

Sets the attachments of the framebuffer object to attachment.

This can be used to free or reattach the depth and stencil buffer attachments as needed.

Note

This function alters the current framebuffer binding.

See also

attachment()

PySide6.QtOpenGL.QOpenGLFramebufferObject.size()

Return type

PySide6.QtCore.QSize

Returns the size of the color and depth/stencil attachments attached to this framebuffer object.

PySide6.QtOpenGL.QOpenGLFramebufferObject.sizes()

Return type

Returns the sizes of all color attachments attached to this framebuffer object.

PySide6.QtOpenGL.QOpenGLFramebufferObject.takeTexture()

Return type

int

Returns the texture id for the texture attached to this framebuffer object. The ownership of the texture is transferred to the caller.

If the framebuffer object is currently bound, an implicit release() will be done. During the next call to bind() a new texture will be created.

If a multisample framebuffer object is used, then there is no texture and the return value from this function will be invalid. Similarly, incomplete framebuffer objects will also return 0.

See also

texture() bind() release()

PySide6.QtOpenGL.QOpenGLFramebufferObject.takeTexture(colorAttachmentIndex)

Parameters

colorAttachmentIndex – int

Return type

int

This is an overloaded function.

Returns the texture id for the texture attached to the color attachment of index colorAttachmentIndex of this framebuffer object. The ownership of the texture is transferred to the caller.

When colorAttachmentIndex is 0, the behavior is identical to the parameter-less variant of this function.

If the framebuffer object is currently bound, an implicit release() will be done. During the next call to bind() a new texture will be created.

If a multisample framebuffer object is used, then there is no texture and the return value from this function will be invalid. Similarly, incomplete framebuffer objects will also return 0.

PySide6.QtOpenGL.QOpenGLFramebufferObject.texture()

Return type

int

Returns the texture id for the texture attached as the default rendering target in this framebuffer object. This texture id can be bound as a normal texture in your own OpenGL code.

If a multisample framebuffer object is used then the value returned from this function will be invalid.

When multiple textures are attached, the return value is the ID of the first one.

See also

takeTexture() textures()

PySide6.QtOpenGL.QOpenGLFramebufferObject.textures()

Return type

Returns the texture id for all attached textures.

If a multisample framebuffer object is used, then an empty vector is returned.

See also

takeTexture() texture()

PySide6.QtOpenGL.QOpenGLFramebufferObject.toImage([flipped=true])

Parameters

flipped – bool

Return type

PySide6.QtGui.QImage

Returns the contents of this framebuffer object as a QImage .

If flipped is true the image is flipped from OpenGL coordinates to raster coordinates. If used together with QOpenGLPaintDevice , flipped should be the opposite of the value of paintFlipped() .

The returned image has a format of premultiplied ARGB32 or RGB32. The latter is used only when internalTextureFormat() is set to GL_RGB. Since Qt 5.2 the function will fall back to premultiplied RGBA8888 or RGBx8888 when reading to (A)RGB32 is not supported, and this includes OpenGL ES. Since Qt 5.4 an A2BGR30 image is returned if the internal format is RGB10_A2, and since Qt 5.12 a RGBA64 image is return if the internal format is RGBA16.

If the rendering in the framebuffer was not done with premultiplied alpha in mind, create a wrapper QImage with a non-premultiplied format. This is necessary before performing operations like save() because otherwise the image data would get unpremultiplied, even though it was not premultiplied in the first place. To create such a wrapper without performing a copy of the pixel data, do the following:

QImage fboImage(fbo.toImage());
QImage image(fboImage.constBits(), fboImage.width(), fboImage.height(), QImage::Format_ARGB32);

For multisampled framebuffer objects the samples are resolved using the GL_EXT_framebuffer_blit extension. If the extension is not available, the contents of the returned image is undefined.

For singlesampled framebuffers the contents is retrieved via glReadPixels. This is a potentially expensive and inefficient operation. Therefore it is recommended that this function is used as seldom as possible.

See also

paintFlipped()

PySide6.QtOpenGL.QOpenGLFramebufferObject.toImage(flipped, colorAttachmentIndex)

Parameters

• flipped – bool

• colorAttachmentIndex – int

Return type

PySide6.QtGui.QImage

This is an overloaded function.

Returns the contents of the color attachment of index colorAttachmentIndex of this framebuffer object as a QImage . This method flips the image from OpenGL coordinates to raster coordinates when flipped is set to true.

Note

This overload is only fully functional when multiple render targets are supported by the OpenGL implementation. When that is not the case, only one color attachment will be set up.

PySide6.QtOpenGL.QOpenGLFramebufferObject.width()

Return type

int

Returns the width of the framebuffer object attachments.