Correct QOpenGLContext::versionFunctions() docs

The example is incorrect: no context parameter is needed.

There was also no mentioning of the fact the the context must be
current at the time of calling initializeOpenGLFunctions(). This
is corrected too.

Change-Id: If8695140096e4b4f84927579c099b0af80750703
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
This commit is contained in:
Laszlo Agocs 2014-04-08 17:32:26 +02:00 committed by The Qt Project
parent 041c4d9c0b
commit 7537a4605a

View File

@ -617,7 +617,8 @@ QOpenGLFunctions *QOpenGLContext::functions() const
Returns a pointer to an object that provides access to all functions for
the version and profile of this context. Before using any of the functions
they must be initialized by calling QAbstractOpenGLFunctions::initializeOpenGLFunctions().
they must be initialized by calling QAbstractOpenGLFunctions::initializeOpenGLFunctions()
with this context being the current context.
Usually one would use the template version of this function to automatically
have the result cast to the correct type.
@ -629,7 +630,7 @@ QOpenGLFunctions *QOpenGLContext::functions() const
qWarning() << "Could not obtain required OpenGL context version";
exit(1);
}
funcs->initializeOpenGLFunctions(context);
funcs->initializeOpenGLFunctions();
\endcode
It is possible to request a functions object for a different version and profile
@ -659,8 +660,9 @@ QOpenGLFunctions *QOpenGLContext::functions() const
/*!
Returns a pointer to an object that provides access to all functions for the
\a versionProfile of the current context. Before using any of the functions they must
be initialized by calling QAbstractOpenGLFunctions::initializeOpenGLFunctions().
\a versionProfile of this context. Before using any of the functions they must
be initialized by calling QAbstractOpenGLFunctions::initializeOpenGLFunctions()
with this context being the current context.
Usually one would use the template version of this function to automatically
have the result cast to the correct type.