mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-22 13:04:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work

Browse Source 
Describe #1341.
This commit is contained in:
Emmanuel Gil Peyrot 2019-02-15 19:02:32 +01:00
parent 45bd991ea9
commit bcd8f9aff2
2 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/compat.dox
View File

@ -126,13 +126,18 @@ wayland-protocols 1.6, and mandatory at build time. If the running compositor
does not support this protocol, the screensaver may start even for full screen does not support this protocol, the screensaver may start even for full screen
windows. windows.
GLFW uses the [viewporter GLFW uses the [xdg-decoration
protocol](https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/xdg-decoration/xdg-decoration-unstable-v1.xml)
to request decorations to be drawn around its windows. This protocol is part
of wayland-protocols 1.15, and mandatory at build time. If the running
compositor does not support this protocol, a very simple frame will be drawn by
GLFW itself, using the [viewporter
protocol](https://cgit.freedesktop.org/wayland/wayland-protocols/tree/stable/viewporter/viewporter.xml) protocol](https://cgit.freedesktop.org/wayland/wayland-protocols/tree/stable/viewporter/viewporter.xml)
alongside alongside
[subsurfaces](https://cgit.freedesktop.org/wayland/wayland/tree/protocol/wayland.xml#n2598) [subsurfaces](https://cgit.freedesktop.org/wayland/wayland/tree/protocol/wayland.xml#n2598).
to draw decorations around windows. This protocol is part of wayland-protocols This protocol is part of wayland-protocols 1.4, and mandatory at build time.
1.4, and mandatory at build time. If the running compositor does not support If the running compositor does not support this protocol either, no decorations
this protocol, no decorations will be drawn around windows. will be drawn around windows.
@section compat_glx GLX extensions @section compat_glx GLX extensions

12
include/GLFW/glfw3.h
View File

@ -2478,11 +2478,13 @@ GLFWAPI void glfwWindowHintString(int hint, const char* value);
* GLFW_X11_CLASS_NAME and @ref GLFW_X11_INSTANCE_NAME window hints to override * GLFW_X11_CLASS_NAME and @ref GLFW_X11_INSTANCE_NAME window hints to override
* this. * this.
* *
* @remark @wayland The window frame is currently very simple, only allowing * @remark @wayland Compositors should implement the xdg-decoration protocol
* window resize or move. A compositor can still emit close, maximize or * for GLFW to decorate the window properly. If this protocol isn't
* fullscreen events, using for example a keybind mechanism. Additionally, * supported, or if the compositor prefers client-side decorations, a very
* the wp_viewporter protocol is required for this feature, otherwise the * simple fallback frame will be drawn using the wp_viewporter protocol. A
* window will not be decorated. * compositor can still emit close, maximize or fullscreen events, using for
* instance a keybind mechanism. If neither of these protocols is supported,
* the window won't be decorated.
* *
* @remark @wayland A full screen window will not attempt to change the mode, * @remark @wayland A full screen window will not attempt to change the mode,
* no matter what the requested size or refresh rate. * no matter what the requested size or refresh rate.