PySide6.QtOpenGL.QOpenGLVertexArrayObject

class QOpenGLVertexArrayObject

The QOpenGLVertexArrayObject class wraps an OpenGL Vertex Array Object. More_…

Inheritance diagram of PySide6.QtOpenGL.QOpenGLVertexArrayObject

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

Detailed Description

A Vertex Array Object (VAO) is an OpenGL container object that encapsulates the state needed to specify per-vertex attribute data to the OpenGL pipeline. To put it another way, a VAO remembers the states of buffer objects (see QOpenGLBuffer ) and their associated state (e.g. vertex attribute divisors). This allows a very easy and efficient method of switching between OpenGL buffer states for rendering different “objects” in a scene. The QOpenGLVertexArrayObject class is a thin wrapper around an OpenGL VAO.

For the desktop, VAOs are supported as a core feature in OpenGL 3.0 or newer and by the GL_ARB_vertex_array_object for older versions. On OpenGL ES 2, VAOs are provided by the optional GL_OES_vertex_array_object extension. You can check the version of OpenGL with QOpenGLContext::surfaceFormat() and check for the presence of extensions with QOpenGLContext::hasExtension().

As with the other Qt OpenGL classes, QOpenGLVertexArrayObject has a create() function to create the underlying OpenGL object. This is to allow the developer to ensure that there is a valid current OpenGL context at the time.

Once you have successfully created a VAO the typical usage pattern is:

  • In scene initialization function, for each visual object:

    • Bind the VAO

    • Set vertex data state for this visual object (vertices, normals, texture coordinates etc.)

    • Unbind ( release() ) the VAO

  • In render function, for each visual object:

    • Bind the VAO (and shader program if needed)

    • Call a glDraw*() function

    • Unbind ( release() ) the VAO

The act of binding the VAO in the render function has the effect of restoring all of the vertex data state setup in the initialization phase. In this way we can set a great deal of state when setting up a VAO and efficiently switch between state sets of objects to be rendered. Using VAOs also allows the OpenGL driver to amortise the validation checks of the vertex data.

Note

Vertex Array Objects, like all other OpenGL container objects, are specific to the context for which they were created and cannot be shared amongst a context group.

See also

Binder QOpenGLBuffer

__init__([parent=None])
Parameters:

parent – QObject

Creates a QOpenGLVertexArrayObject with the given parent. You must call create() with a valid OpenGL context before using.

bind()

Binds this vertex array object to the OpenGL binding point. From this point on and until release() is called or another vertex array object is bound, any modifications made to vertex data state are stored inside this vertex array object.

If another vertex array object is then bound you can later restore the set of state associated with this object by calling bind() on this object once again. This allows efficient changes between vertex data states in rendering functions.

create()
Return type:

bool

Creates the underlying OpenGL vertex array object. There must be a valid OpenGL context that supports vertex array objects current for this function to succeed.

Returns true if the OpenGL vertex array object was successfully created.

When the return value is false, vertex array object support is not available. This is not an error: on systems with OpenGL 2.x or OpenGL ES 2.0 vertex array objects may not be supported. The application is free to continue execution in this case, but it then has to be prepared to operate in a VAO-less manner too. This means that instead of merely calling bind() , the value of isCreated() must be checked and the vertex arrays has to be initialized in the traditional way when there is no vertex array object present.

See also

isCreated()

destroy()

Destroys the underlying OpenGL vertex array object. There must be a valid OpenGL context that supports vertex array objects current for this function to succeed.

isCreated()
Return type:

bool

Returns true is the underlying OpenGL vertex array object has been created. If this returns true and the associated OpenGL context is current, then you are able to bind() this object.

objectId()
Return type:

int

Returns the id of the underlying OpenGL vertex array object.

release()

Unbinds this vertex array object by binding the default vertex array object (id = 0).

class Binder

The Binder class is a convenience class to help with the binding and releasing of OpenGL Vertex Array Objects. More_…

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

Detailed Description

Binder is a simple convenience class that can be used to assist with the binding and releasing of QOpenGLVertexArrayObject instances. This class is to QOpenGLVertexArrayObject as QMutexLocker is to QMutex.

This class implements the RAII principle which helps to ensure behavior in complex code or in the presence of exceptions.

The constructor of this class accepts a QOpenGLVertexArrayObject (VAO) as an argument and attempts to bind the VAO, calling create() if necessary. The destructor of this class calls release() which unbinds the VAO.

If needed the VAO can be temporarily unbound with the release() function and bound once more with rebind() .

__init__(v)
Parameters:

v – QOpenGLVertexArrayObject

Creates a Binder object and binds v by calling bind() . If necessary it first calls create() .

__enter__()
Return type:

Binder

__exit__(arg__1, arg__2, arg__3)
Parameters:

  • arg__1 – object

  • arg__2 – object

  • arg__3 – object

rebind()

Can be used to rebind the associated vertex array object.

See also

release()

release()

Can be used to temporarily release the associated vertex array object.

See also

rebind()