wxWidgets/version-script.in

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

64 lines
1.9 KiB
Plaintext
Raw Normal View History

#
# Notes:
#
# Remove all of the tags below except for the last one when creating new
# development branch.
#
# Once a symbol has been included in a stable release of wxWidgets its version
# cannot be changed.
#
# With each new release a section should be added containing any new symbols,
# for example:
#
# # public symbols added in release @WX_VERSION_TAG@.2 (please keep in alphabetical order):
# @WX_VERSION_TAG@.2 {
# extern "C++"
# "wxChoice::GetCurrentSelection()";
# };
# };
#
# If a symbols should have been added in this way, but is forgotten then it
# cannot be added in the next release. This is because it has already been
# released with the generic branch version due to the final wildcard below,
# and once released its version cannot be changed.
# When adding a new section here, don't forget to modify the version in
# build/bakefiles/version.bkl to indicate that new APIs have been added and
# rebake!
# public symbols added in 3.2.3 (please keep in alphabetical order):
@WX_VERSION_TAG@.3 {
extern "C++" {
Handle map/unmap events on Wayland's wxGLCanvasEGL Fixes hiding a wxGLCanvas on Wayland, either directly (`->Show(false)`) or indirectly (e.g. when it is contained in a wxNotebook). On Wayland, unlike on X11, to show the canvas on the screen, we need to create a Wayland subsurface. This subsurface is detached from the GTK widget associated to the canvas, thus it is not automatically mapped or unmapped when the associated GTK widget is. Rather, we need to manually keep it in sync with the widget's state. Knowing what has to be done to map and unmap the canvas, while dealing with edge cases properly, is not easy to someone not used to Wayland. When the canvas is mapped, we have this graph of resources: EGL Surface (m_surface) | | v wl_egl window (m_wlEGLWindow) | | v Canvas wl_surface GDK's toplevel window wl_surface (m_wlSurface) (gdk_wayland_window_get_wl_surface(w)) \ which is shown to the user \ ^ \ / \ / v / Subsurface (m_wlSubsurface) to overlay the canvas onto the toplevel window A simple way would be to destroy everything (m_surface, m_wlEGLWindow, m_wlSurface, m_wlSubsurface) on unmap, and re-create it again on map. Inefficiencies aside, this mostly works. However, it can mess with the current OpenGL context. For example, suppose we have a (fragile) program that places a canvas inside one of wxNotebook's tabs, and makes the OpenGL context current only once at startup (e.g. on wxEVT_SHOW). Switching between tabs will destroy and re-create the EGL Surface, so the canvas will not be properly rendered when going back to its tab. So we need to be smarter, and find some way to hide the subsurface instead. The obvious way would be to unmap the canvas wl_surface (m_wlSurface), as according to the Wayland spec., "a sub-surface is hidden [...] if a NULL wl_buffer is applied [to the canvas surface]." (https://wayland.freedesktop.org/docs/html/apa.html#protocol-spec-wl_subsurface) However, as far as I can tell, this can't be done. There's no API to hide an wl_egl window, and directly applying a NULL wl_buffer to the canvas surface initially hides it, but seems to breaks the associated window so that it crashes when one attempts to show it again. So what remains, is destroying the overlay subsurface (m_wlSubsurface). When doing it, to the spec, "the wl_surface is unmapped immediately.". And not only does this work, but it also deals with the annoying fact that on current GTK3 versions, when the GDK's toplevel window is unmapped, its wl_surface is not just unmapped, but entirely destroyed. (Side note: This may not have been intended, and has been changed for GTK4, see: https://gitlab.gnome.org/GNOME/gtk/-/commit/5d3cec5441ca) So we'd have to re-create the subsurface because of this anyway. So, this works nicely, and as far as I can tell (documentation is a bit scarce), there's no problem to leaving m_wlSurface (and its associated m_wlEGLWindow and m_surface) unmapped in this way. See #22580, #23835. (cherry picked from commit 952de605f622cc7a3c30257365046ecd1a307808)
2023-08-24 23:07:54 -04:00
"wxGLCanvasEGL::CreateWaylandSubsurface";
"wxGLCanvasEGL::DestroyWaylandSubsurface";
"wxTranslations::AddAvailableCatalog";
"wxTranslations::GetBestAvailableTranslation";
"wxUILocale::GetMonthName";
"wxUILocale::GetWeekDayName";
};
};
# public symbols added in 3.2.2 (please keep in alphabetical order):
@WX_VERSION_TAG@.2 {
extern "C++" {
"wxUILocale::GetSystemLocaleId";
"wxWithImages::GetImageLogicalSize";
"wxWithImages::GetImageBitmapFor";
};
};
# public symbols added in 3.2.1
@WX_VERSION_TAG@.1 {
extern "C++" {
"wxApp::GTKAllowDiagnosticsControl()";
"wxFileDialog::AddShortcut(const wxString&, int)";
};
};
# symbols available since the beginning of this branch are only given
# generic branch tag (don't remove this!):
@WX_VERSION_TAG@ {
*;
};