|  | Home · All Classes · Modules

# QGLFramebufferObjectFormat Class Reference
[QtOpenGL module]

The QGLFramebufferObjectFormat class specifies the format of an OpenGL framebuffer object. More...

### Methods

- __init__ (self)
- __init__ (self, QGLFramebufferObjectFormat)
- QGLFramebufferObject.Attachment attachment (self)
- int internalTextureFormat (self)
- int samples (self)
- setAttachment (self, QGLFramebufferObject.Attachment)
- setInternalTextureFormat (self, int)
- setSamples (self, int)
- setTextureTarget (self, int)
- int textureTarget (self)

### Special Methods

- bool __eq__ (self, QGLFramebufferObjectFormat)
- bool __ne__ (self, QGLFramebufferObjectFormat)

## Detailed Description

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

A framebuffer object has several characteristics:

- Number of samples per pixels.
- Depth and/or stencil attachments.
- Texture target.
- Internal texture format.

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

See also QGLFramebufferObject.

## Method Documentation

### QGLFramebufferObjectFormat.__init__ (self)

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

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

See also samples(), attachment(), target(), and internalTextureFormat().

### QGLFramebufferObjectFormat.__init__ (self, QGLFramebufferObjectFormat)

Constructs a copy of other.

### QGLFramebufferObject.Attachment QGLFramebufferObjectFormat.attachment (self)

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

See also setAttachment().

### int QGLFramebufferObjectFormat.internalTextureFormat (self)

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.

See also setInternalTextureFormat().

### int QGLFramebufferObjectFormat.samples (self)

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().

### QGLFramebufferObjectFormat.setAttachment (self, QGLFramebufferObject.Attachment)

Sets the attachment configuration of a framebuffer object to attachment.

See also attachment().

### QGLFramebufferObjectFormat.setInternalTextureFormat (self, int)

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

See also internalTextureFormat().

### QGLFramebufferObjectFormat.setSamples (self, 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 can not 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().

### QGLFramebufferObjectFormat.setTextureTarget (self, int)

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

See also textureTarget() and samples().

### int QGLFramebufferObjectFormat.textureTarget (self)

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

See also setTextureTarget() and samples().

### bool QGLFramebufferObjectFormat.__eq__ (self, QGLFramebufferObjectFormat)

### bool QGLFramebufferObjectFormat.__ne__ (self, QGLFramebufferObjectFormat)