QGLFramebufferObjectFormat

Note

This class was introduced in Qt 4.6

Synopsis

Functions

• def __eq__ (other)
• def __ne__ (other)
• def attachment ()
• def internalTextureFormat ()
• def mipmap ()
• def samples ()
• def setAttachment (attachment)
• def setInternalTextureFormat (internalTextureFormat)
• def setMipmap (enabled)
• def setSamples (samples)
• def setTextureTarget (target)
• def textureTarget ()

Detailed Description

The PySide.QtOpenGL.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 PySide.QtOpenGL.QGLFramebufferObject to find the exact format that was used to create the frame buffer object.

See also

PySide.QtOpenGL.QGLFramebufferObject

class PySide.QtOpenGL.QGLFramebufferObjectFormat

class PySide.QtOpenGL.QGLFramebufferObjectFormat(other)

Parameters:other – PySide.QtOpenGL.QGLFramebufferObjectFormat

Creates a PySide.QtOpenGL.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

PySide.QtOpenGL.QGLFramebufferObjectFormat.samples() PySide.QtOpenGL.QGLFramebufferObjectFormat.attachment() PySide.QtOpenGL.QGLFramebufferObjectFormat.internalTextureFormat()

Constructs a copy of other .

PySide.QtOpenGL.QGLFramebufferObjectFormat.attachment()

Return type:PySide.QtOpenGL.QGLFramebufferObject.Attachment

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

See also

PySide.QtOpenGL.QGLFramebufferObjectFormat.setAttachment()

PySide.QtOpenGL.QGLFramebufferObjectFormat.internalTextureFormat()

Return type:PySide.QtOpenGL.GLenum

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

PySide.QtOpenGL.QGLFramebufferObjectFormat.setInternalTextureFormat()

PySide.QtOpenGL.QGLFramebufferObjectFormat.mipmap()

Return type:PySide.QtCore.bool

Returns true if mipmapping is enabled.

See also

PySide.QtOpenGL.QGLFramebufferObjectFormat.setMipmap()

PySide.QtOpenGL.QGLFramebufferObjectFormat.__ne__(other)

Parameters:other – PySide.QtOpenGL.QGLFramebufferObjectFormat Return type:PySide.QtCore.bool

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

PySide.QtOpenGL.QGLFramebufferObjectFormat.__eq__(other)

Parameters:other – PySide.QtOpenGL.QGLFramebufferObjectFormat Return type:PySide.QtCore.bool

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

PySide.QtOpenGL.QGLFramebufferObjectFormat.samples()

Return type:PySide.QtCore.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

PySide.QtOpenGL.QGLFramebufferObjectFormat.setSamples()

PySide.QtOpenGL.QGLFramebufferObjectFormat.setAttachment(attachment)

Parameters:attachment – PySide.QtOpenGL.QGLFramebufferObject.Attachment

PySide.QtOpenGL.QGLFramebufferObjectFormat.setInternalTextureFormat(internalTextureFormat)

Parameters:internalTextureFormat – PySide.QtOpenGL.GLenum

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

See also

PySide.QtOpenGL.QGLFramebufferObjectFormat.internalTextureFormat()

PySide.QtOpenGL.QGLFramebufferObjectFormat.setMipmap(enabled)

Parameters:enabled – PySide.QtCore.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

PySide.QtOpenGL.QGLFramebufferObjectFormat.mipmap() QGLFramebufferObject.texture()

PySide.QtOpenGL.QGLFramebufferObjectFormat.setSamples(samples)

Parameters:samples – PySide.QtCore.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

PySide.QtOpenGL.QGLFramebufferObjectFormat.samples()

PySide.QtOpenGL.QGLFramebufferObjectFormat.setTextureTarget(target)

Parameters:target – PySide.QtOpenGL.GLenum

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

See also

PySide.QtOpenGL.QGLFramebufferObjectFormat.textureTarget() PySide.QtOpenGL.QGLFramebufferObjectFormat.samples()

PySide.QtOpenGL.QGLFramebufferObjectFormat.textureTarget()

Return type:PySide.QtOpenGL.GLenum

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

PySide.QtOpenGL.QGLFramebufferObjectFormat.setTextureTarget() PySide.QtOpenGL.QGLFramebufferObjectFormat.samples()