From b7104d6645e25892d85e6e0aad6ddebbd2babdc0 Mon Sep 17 00:00:00 2001 From: Holger Hans Peter Freyther Date: Tue, 29 May 2012 15:41:04 +0200 Subject: [PATCH] Document QWindow's setSurfaceType and setFormat update behavior QWindow::setSurfaceType and QWindow::setFormat do not re-create the QPlatformWindow. Attempt to document this behavior and point to the documentation of destroy() and create(). Change-Id: Idf7eb343d4918a45b5a701effe3263145a33790a Reviewed-by: Casper van Donderen Reviewed-by: Girish Ramakrishnan --- src/gui/kernel/qwindow.cpp | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/gui/kernel/qwindow.cpp b/src/gui/kernel/qwindow.cpp index 5262b6f..c9a49bf 100644 --- a/src/gui/kernel/qwindow.cpp +++ b/src/gui/kernel/qwindow.cpp @@ -200,7 +200,12 @@ QWindow::~QWindow() Specifies whether the window is meant for raster rendering with QBackingStore, or OpenGL rendering with QOpenGLContext. - \sa QBackingStore, QOpenGLContext + The surfaceType will be used when the native surface is created + in the create() function. Calling this function after the native + surface has been created requires calling destroy() and create() + to release the old native surface and create a new one. + + \sa QBackingStore, QOpenGLContext, create(), destroy() */ void QWindow::setSurfaceType(SurfaceType surfaceType) { @@ -415,6 +420,12 @@ void QWindow::setWindowModality(Qt::WindowModality modality) The format determines properties such as color depth, alpha, depth and stencil buffer size, etc. + + The surface format will be resolved in the create() function. Calling + this function after create() has been called will not re-resolve the + surface format of the native surface. + + \sa create(), destroy() */ void QWindow::setFormat(const QSurfaceFormat &format) { -- 2.7.4