From d5ab3e919a4f163f4010f7112a9cf1bdcd80f805 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Camilla=20L=C3=B6wy?= Date: Tue, 22 Jan 2019 20:54:16 +0100 Subject: [PATCH] Cleanup Replace client area with content area. --- docs/input.dox | 12 ++-- docs/intro.dox | 16 ++--- docs/news.dox | 6 +- docs/spaces.svg | 157 ++++++++++++++++++++++--------------------- docs/window.dox | 32 ++++----- include/GLFW/glfw3.h | 100 +++++++++++++-------------- src/cocoa_window.m | 16 ++--- src/input.c | 6 +- src/internal.h | 2 +- src/win32_window.c | 24 +++---- src/window.c | 4 +- src/x11_window.c | 2 +- 12 files changed, 191 insertions(+), 186 deletions(-) diff --git a/docs/input.dox b/docs/input.dox index 73c7ef70..159fb454 100644 --- a/docs/input.dox +++ b/docs/input.dox @@ -248,7 +248,7 @@ glfwSetCursorPosCallback(window, cursor_position_callback); @endcode The callback functions receives the cursor position, measured in screen -coordinates but relative to the top-left corner of the window client area. On +coordinates but relative to the top-left corner of the window content area. On platforms that provide it, the full sub-pixel cursor position is passed on. @code @@ -377,7 +377,7 @@ glfwSetCursor(window, cursor); @endcode Once set, the cursor image will be used as long as the system cursor is over the -client area of the window and the [cursor mode](@ref cursor_mode) is set +content area of the window and the [cursor mode](@ref cursor_mode) is set to `GLFW_CURSOR_NORMAL`. A single cursor may be set for any number of windows. @@ -394,7 +394,7 @@ default cursor. This does not affect the cursor mode. @subsection cursor_enter Cursor enter/leave events -If you wish to be notified when the cursor enters or leaves the client area of +If you wish to be notified when the cursor enters or leaves the content area of a window, set a cursor enter/leave callback. @code @@ -408,16 +408,16 @@ void cursor_enter_callback(GLFWwindow* window, int entered) { if (entered) { - // The cursor entered the client area of the window + // The cursor entered the content area of the window } else { - // The cursor left the client area of the window + // The cursor left the content area of the window } } @endcode -You can query whether the cursor is currently inside the client area of the +You can query whether the cursor is currently inside the content area of the window with the [GLFW_HOVERED](@ref GLFW_HOVERED_attrib) window attribute. @code diff --git a/docs/intro.dox b/docs/intro.dox index 58ab8fd5..36bc73e6 100644 --- a/docs/intro.dox +++ b/docs/intro.dox @@ -208,24 +208,24 @@ future that same call may generate a different error or become valid. @section coordinate_systems Coordinate systems GLFW has two primary coordinate systems: the _virtual screen_ and the window -_client area_ or _content area_. Both use the same unit: _virtual screen +_content area_ or _content area_. Both use the same unit: _virtual screen coordinates_, or just _screen coordinates_, which don't necessarily correspond to pixels. -Both the virtual screen and the client area coordinate systems have the X-axis +Both the virtual screen and the content area coordinate systems have the X-axis pointing to the right and the Y-axis pointing down. Window and monitor positions are specified as the position of the upper-left corners of their content areas relative to the virtual screen, while cursor -positions are specified relative to a window's client area. +positions are specified relative to a window's content area. -Because the origin of the window's client area coordinate system is also the -point from which the window position is specified, you can translate client area -coordinates to the virtual screen by adding the window position. The window -frame, when present, extends out from the client area but does not affect the -window position. +Because the origin of the window's content area coordinate system is also the +point from which the window position is specified, you can translate content +area coordinates to the virtual screen by adding the window position. The +window frame, when present, extends out from the content area but does not +affect the window position. Almost all positions and sizes in GLFW are measured in screen coordinates relative to one of the two origins above. This includes cursor positions, diff --git a/docs/news.dox b/docs/news.dox index 0cdec005..43f384ea 100644 --- a/docs/news.dox +++ b/docs/news.dox @@ -128,7 +128,7 @@ window hint. It is enabled by default. @subsection news_33_hover Mouse cursor hover window attribute -GLFW now supports polling whether the cursor is hovering over the window client +GLFW now supports polling whether the cursor is hovering over the window content area with the [GLFW_HOVERED](@ref GLFW_HOVERED_attrib) window attribute. This attribute corresponds to the [cursor enter/leave](@ref cursor_enter) event. @@ -308,7 +308,7 @@ glfwWaitEvents to return. @subsection news_31_framesize Window frame size query GLFW now supports querying the size, on each side, of the frame around the -client area of a window, with @ref glfwGetWindowFrameSize. +content area of a window, with @ref glfwGetWindowFrameSize. @see [Window size](@ref window_size) @@ -506,7 +506,7 @@ glfwSetWindowFocusCallback. @subsection news_30_enterleave Cursor enter/leave callback Each window now has a callback for when the mouse cursor enters or leaves its -client area, which is set with @ref glfwSetCursorEnterCallback. +content area, which is set with @ref glfwSetCursorEnterCallback. @subsection news_30_wndtitle Initial window title diff --git a/docs/spaces.svg b/docs/spaces.svg index 562fa8be..5b326460 100644 --- a/docs/spaces.svg +++ b/docs/spaces.svg @@ -13,7 +13,7 @@ height="327.98221" id="svg2" version="1.1" - inkscape:version="0.48.4 r9939" + inkscape:version="0.92.4 (5da689c313, 2019-01-14)" sodipodi:docname="spaces.svg"> @@ -38,11 +38,11 @@ borderopacity="1.0" inkscape:pageopacity="0.0" inkscape:pageshadow="2" - inkscape:zoom="2.5611424" - inkscape:cx="344.24359" - inkscape:cy="163.9911" + inkscape:zoom="1.8110012" + inkscape:cx="320.68941" + inkscape:cy="159.80509" inkscape:document-units="px" - inkscape:current-layer="svg2" + inkscape:current-layer="layer1" showgrid="false" inkscape:window-width="1920" inkscape:window-height="1021" @@ -475,18 +475,18 @@ inkscape:export-ydpi="109.89113" /> + y="340.20465" + style="font-size:12px;line-height:1.25;font-family:sans-serif">  @@ -647,74 +647,6 @@ style="font-size:10px" id="path3239" /> - - - - - - - - - - - - - - - - - - @@ -868,5 +800,78 @@ style="font-size:5px" id="path3161" /> + + + + + + + + + + + + + + + + + + + diff --git a/docs/window.dox b/docs/window.dox index f3012784..5f94f358 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -599,7 +599,7 @@ void window_close_callback(GLFWwindow* window) The size of a window can be changed with @ref glfwSetWindowSize. For windowed mode windows, this sets the size, in -[screen coordinates](@ref coordinate_systems) of the _client area_ or _content +[screen coordinates](@ref coordinate_systems) of the _content area_ or _content area_ of the window. The window system may impose limits on window size. @code @@ -619,7 +619,7 @@ glfwSetWindowSizeCallback(window, window_size_callback); @endcode The callback function receives the new size, in screen coordinates, of the -client area of the window when the window is resized. +content area of the window when the window is resized. @code void window_size_callback(GLFWwindow* window, int width, int height) @@ -640,9 +640,9 @@ calls. The window size is in screen coordinates, not pixels. Use the [framebuffer size](@ref window_fbsize), which is in pixels, for pixel-based calls. -The above functions work with the size of the client area, but decorated windows -typically have title bars and window frames around this rectangle. You can -retrieve the extents of these with @ref glfwGetWindowFrameSize. +The above functions work with the size of the content area, but decorated +windows typically have title bars and window frames around this rectangle. You +can retrieve the extents of these with @ref glfwGetWindowFrameSize. @code int left, top, right, bottom; @@ -650,7 +650,7 @@ glfwGetWindowFrameSize(window, &left, &top, &right, &bottom); @endcode The returned values are the distances, in screen coordinates, from the edges of -the client area to the corresponding edges of the full window. As they are +the content area to the corresponding edges of the full window. As they are distances and not coordinates, they are always zero or positive. @@ -737,10 +737,10 @@ GLFW_SCALE_TO_MONITOR window hint. @subsection window_sizelimits Window size limits -The minimum and maximum size of the client area of a windowed mode window can be -enforced with @ref glfwSetWindowSizeLimits. The user may resize the window to -any size and aspect ratio within the specified limits, unless the aspect ratio -is also set. +The minimum and maximum size of the content area of a windowed mode window can +be enforced with @ref glfwSetWindowSizeLimits. The user may resize the window +to any size and aspect ratio within the specified limits, unless the aspect +ratio is also set. @code glfwSetWindowSizeLimits(window, 200, 200, 400, 400); @@ -755,7 +755,7 @@ glfwSetWindowSizeLimits(window, 640, 480, GLFW_DONT_CARE, GLFW_DONT_CARE); To disable size limits for a window, set them all to `GLFW_DONT_CARE`. -The aspect ratio of the client area of a windowed mode window can be enforced +The aspect ratio of the content area of a windowed mode window can be enforced with @ref glfwSetWindowAspectRatio. The user may resize the window freely unless size limits are also set, but the size will be constrained to maintain the aspect ratio. @@ -785,7 +785,7 @@ are undefined if they conflict. The position of a windowed-mode window can be changed with @ref glfwSetWindowPos. This moves the window so that the upper-left corner of its -client area has the specified [screen coordinates](@ref coordinate_systems). +content area has the specified [screen coordinates](@ref coordinate_systems). The window system may put limitations on window placement. @code @@ -800,7 +800,7 @@ glfwSetWindowPosCallback(window, window_pos_callback); @endcode The callback function receives the new position, in screen coordinates, of the -upper-left corner of the client area when the window is moved. +upper-left corner of the content area when the window is moved. @code void window_pos_callback(GLFWwindow* window, int xpos, int ypos) @@ -809,7 +809,7 @@ void window_pos_callback(GLFWwindow* window, int xpos, int ypos) @endcode There is also @ref glfwGetWindowPos for directly retrieving the current position -of the client area of the window. +of the content area of the window. @code int xpos, ypos; @@ -1249,8 +1249,8 @@ __GLFW_MAXIMIZED__ indicates whether the specified window is maximized. See @anchor GLFW_HOVERED_attrib __GLFW_HOVERED__ indicates whether the cursor is currently directly over the -client area of the window, with no other windows between. See @ref cursor_enter -for details. +content area of the window, with no other windows between. See @ref +cursor_enter for details. @anchor GLFW_VISIBLE_attrib __GLFW_VISIBLE__ indicates whether the specified window is visible. See @ref diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 8606edc1..35a781c9 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -1170,9 +1170,9 @@ typedef void (* GLFWerrorfun)(int,const char*); * * @param[in] window The window that was moved. * @param[in] xpos The new x-coordinate, in screen coordinates, of the - * upper-left corner of the client area of the window. + * upper-left corner of the content area of the window. * @param[in] ypos The new y-coordinate, in screen coordinates, of the - * upper-left corner of the client area of the window. + * upper-left corner of the content area of the window. * * @sa @ref window_pos * @sa @ref glfwSetWindowPosCallback @@ -1349,9 +1349,9 @@ typedef void (* GLFWmousebuttonfun)(GLFWwindow*,int,int,int); * * @param[in] window The window that received the event. * @param[in] xpos The new cursor x-coordinate, relative to the left edge of - * the client area. + * the content area. * @param[in] ypos The new cursor y-coordinate, relative to the top edge of the - * client area. + * content area. * * @sa @ref cursor_pos * @sa @ref glfwSetCursorPosCallback @@ -1367,7 +1367,7 @@ typedef void (* GLFWcursorposfun)(GLFWwindow*,double,double); * This is the function signature for cursor enter/leave callback functions. * * @param[in] window The window that received the event. - * @param[in] entered `GLFW_TRUE` if the cursor entered the window's client + * @param[in] entered `GLFW_TRUE` if the cursor entered the window's content * area, or `GLFW_FALSE` if it left it. * * @sa @ref cursor_enter @@ -2644,19 +2644,19 @@ GLFWAPI void glfwSetWindowTitle(GLFWwindow* window, const char* title); */ GLFWAPI void glfwSetWindowIcon(GLFWwindow* window, int count, const GLFWimage* images); -/*! @brief Retrieves the position of the client area of the specified window. +/*! @brief Retrieves the position of the content area of the specified window. * * This function retrieves the position, in screen coordinates, of the - * upper-left corner of the client area of the specified window. + * upper-left corner of the content area of the specified window. * * Any or all of the position arguments may be `NULL`. If an error occurs, all * non-`NULL` position arguments will be set to zero. * * @param[in] window The window to query. * @param[out] xpos Where to store the x-coordinate of the upper-left corner of - * the client area, or `NULL`. + * the content area, or `NULL`. * @param[out] ypos Where to store the y-coordinate of the upper-left corner of - * the client area, or `NULL`. + * the content area, or `NULL`. * * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * GLFW_PLATFORM_ERROR. @@ -2676,10 +2676,10 @@ GLFWAPI void glfwSetWindowIcon(GLFWwindow* window, int count, const GLFWimage* i */ GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos); -/*! @brief Sets the position of the client area of the specified window. +/*! @brief Sets the position of the content area of the specified window. * * This function sets the position, in screen coordinates, of the upper-left - * corner of the client area of the specified windowed mode window. If the + * corner of the content area of the specified windowed mode window. If the * window is a full screen window, this function does nothing. * * __Do not use this function__ to move an already visible window unless you @@ -2689,8 +2689,8 @@ GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos); * cannot and should not override these limits. * * @param[in] window The window to query. - * @param[in] xpos The x-coordinate of the upper-left corner of the client area. - * @param[in] ypos The y-coordinate of the upper-left corner of the client area. + * @param[in] xpos The x-coordinate of the upper-left corner of the content area. + * @param[in] ypos The y-coordinate of the upper-left corner of the content area. * * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * GLFW_PLATFORM_ERROR. @@ -2711,9 +2711,9 @@ GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos); */ GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos); -/*! @brief Retrieves the size of the client area of the specified window. +/*! @brief Retrieves the size of the content area of the specified window. * - * This function retrieves the size, in screen coordinates, of the client area + * This function retrieves the size, in screen coordinates, of the content area * of the specified window. If you wish to retrieve the size of the * framebuffer of the window in pixels, see @ref glfwGetFramebufferSize. * @@ -2722,9 +2722,9 @@ GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos); * * @param[in] window The window whose size to retrieve. * @param[out] width Where to store the width, in screen coordinates, of the - * client area, or `NULL`. + * content area, or `NULL`. * @param[out] height Where to store the height, in screen coordinates, of the - * client area, or `NULL`. + * content area, or `NULL`. * * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * GLFW_PLATFORM_ERROR. @@ -2743,7 +2743,7 @@ GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height); /*! @brief Sets the size limits of the specified window. * - * This function sets the size limits of the client area of the specified + * This function sets the size limits of the content area of the specified * window. If the window is full screen, the size limits only take effect * once it is made windowed. If the window is not resizable, this function * does nothing. @@ -2755,14 +2755,14 @@ GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height); * dimensions and all must be greater than or equal to zero. * * @param[in] window The window to set limits for. - * @param[in] minwidth The minimum width, in screen coordinates, of the client + * @param[in] minwidth The minimum width, in screen coordinates, of the content * area, or `GLFW_DONT_CARE`. * @param[in] minheight The minimum height, in screen coordinates, of the - * client area, or `GLFW_DONT_CARE`. - * @param[in] maxwidth The maximum width, in screen coordinates, of the client + * content area, or `GLFW_DONT_CARE`. + * @param[in] maxwidth The maximum width, in screen coordinates, of the content * area, or `GLFW_DONT_CARE`. * @param[in] maxheight The maximum height, in screen coordinates, of the - * client area, or `GLFW_DONT_CARE`. + * content area, or `GLFW_DONT_CARE`. * * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR. @@ -2786,7 +2786,7 @@ GLFWAPI void glfwSetWindowSizeLimits(GLFWwindow* window, int minwidth, int minhe /*! @brief Sets the aspect ratio of the specified window. * - * This function sets the required aspect ratio of the client area of the + * This function sets the required aspect ratio of the content area of the * specified window. If the window is full screen, the aspect ratio only takes * effect once it is made windowed. If the window is not resizable, this * function does nothing. @@ -2827,9 +2827,9 @@ GLFWAPI void glfwSetWindowSizeLimits(GLFWwindow* window, int minwidth, int minhe */ GLFWAPI void glfwSetWindowAspectRatio(GLFWwindow* window, int numer, int denom); -/*! @brief Sets the size of the client area of the specified window. +/*! @brief Sets the size of the content area of the specified window. * - * This function sets the size, in screen coordinates, of the client area of + * This function sets the size, in screen coordinates, of the content area of * the specified window. * * For full screen windows, this function updates the resolution of its desired @@ -2845,9 +2845,9 @@ GLFWAPI void glfwSetWindowAspectRatio(GLFWwindow* window, int numer, int denom); * * @param[in] window The window to resize. * @param[in] width The desired width, in screen coordinates, of the window - * client area. + * content area. * @param[in] height The desired height, in screen coordinates, of the window - * client area. + * content area. * * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * GLFW_PLATFORM_ERROR. @@ -3251,7 +3251,7 @@ GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window); * The window position is ignored when setting a monitor. * * When the monitor is `NULL`, the position, width and height are used to - * place the window client area. The refresh rate is ignored when no monitor + * place the window content area. The refresh rate is ignored when no monitor * is specified. * * If you only wish to update the resolution of a full screen window or the @@ -3264,12 +3264,12 @@ GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window); * @param[in] window The window whose monitor, size or video mode to set. * @param[in] monitor The desired monitor, or `NULL` to set windowed mode. * @param[in] xpos The desired x-coordinate of the upper-left corner of the - * client area. + * content area. * @param[in] ypos The desired y-coordinate of the upper-left corner of the - * client area. - * @param[in] width The desired with, in screen coordinates, of the client area - * or video mode. - * @param[in] height The desired height, in screen coordinates, of the client + * content area. + * @param[in] width The desired with, in screen coordinates, of the content + * area or video mode. + * @param[in] height The desired height, in screen coordinates, of the content * area or video mode. * @param[in] refreshRate The desired refresh rate, in Hz, of the video mode, * or `GLFW_DONT_CARE`. @@ -3419,8 +3419,8 @@ GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window); * * This function sets the position callback of the specified window, which is * called when the window is moved. The callback is provided with the - * position, in screen coordinates, of the upper-left corner of the client area - * of the window. + * position, in screen coordinates, of the upper-left corner of the content + * area of the window. * * @param[in] window The window whose callback to set. * @param[in] cbfun The new callback, or `NULL` to remove the currently set @@ -3447,7 +3447,7 @@ GLFWAPI GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow* window, GLFWwindow * * This function sets the size callback of the specified window, which is * called when the window is resized. The callback is provided with the size, - * in screen coordinates, of the client area of the window. + * in screen coordinates, of the content area of the window. * * @param[in] window The window whose callback to set. * @param[in] cbfun The new callback, or `NULL` to remove the currently set @@ -3504,7 +3504,7 @@ GLFWAPI GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwi /*! @brief Sets the refresh callback for the specified window. * * This function sets the refresh callback of the specified window, which is - * called when the client area of the window needs to be redrawn, for example + * called when the content area of the window needs to be redrawn, for example * if the window has been exposed after having been covered by another window. * * On compositing window systems such as Aero, Compiz, Aqua or Wayland, where @@ -3838,8 +3838,8 @@ GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode); * If the mode is `GLFW_CURSOR`, the value must be one of the following cursor * modes: * - `GLFW_CURSOR_NORMAL` makes the cursor visible and behaving normally. - * - `GLFW_CURSOR_HIDDEN` makes the cursor invisible when it is over the client - * area of the window but does not restrict the cursor from leaving. + * - `GLFW_CURSOR_HIDDEN` makes the cursor invisible when it is over the + * content area of the window but does not restrict the cursor from leaving. * - `GLFW_CURSOR_DISABLED` hides and grabs the cursor, providing virtual * and unlimited cursor movement. This is useful for implementing for * example 3D camera controls. @@ -4042,11 +4042,11 @@ GLFWAPI int glfwGetKey(GLFWwindow* window, int key); */ GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button); -/*! @brief Retrieves the position of the cursor relative to the client area of +/*! @brief Retrieves the position of the cursor relative to the content area of * the window. * * This function returns the position of the cursor, in screen coordinates, - * relative to the upper-left corner of the client area of the specified + * relative to the upper-left corner of the content area of the specified * window. * * If the cursor is disabled (with `GLFW_CURSOR_DISABLED`) then the cursor @@ -4062,9 +4062,9 @@ GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button); * * @param[in] window The desired window. * @param[out] xpos Where to store the cursor x-coordinate, relative to the - * left edge of the client area, or `NULL`. + * left edge of the content area, or `NULL`. * @param[out] ypos Where to store the cursor y-coordinate, relative to the to - * top edge of the client area, or `NULL`. + * top edge of the content area, or `NULL`. * * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * GLFW_PLATFORM_ERROR. @@ -4080,11 +4080,11 @@ GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button); */ GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos); -/*! @brief Sets the position of the cursor, relative to the client area of the +/*! @brief Sets the position of the cursor, relative to the content area of the * window. * * This function sets the position, in screen coordinates, of the cursor - * relative to the upper-left corner of the client area of the specified + * relative to the upper-left corner of the content area of the specified * window. The window must have input focus. If the window does not have * input focus when this function is called, it fails silently. * @@ -4099,9 +4099,9 @@ GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos); * * @param[in] window The desired window. * @param[in] xpos The desired x-coordinate, relative to the left edge of the - * client area. + * content area. * @param[in] ypos The desired y-coordinate, relative to the top edge of the - * client area. + * content area. * * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * GLFW_PLATFORM_ERROR. @@ -4211,7 +4211,7 @@ GLFWAPI void glfwDestroyCursor(GLFWcursor* cursor); /*! @brief Sets the cursor for the window. * * This function sets the cursor image to be used when the cursor is over the - * client area of the specified window. The set cursor will only be visible + * content area of the specified window. The set cursor will only be visible * when the [cursor mode](@ref cursor_mode) of the window is * `GLFW_CURSOR_NORMAL`. * @@ -4384,7 +4384,7 @@ GLFWAPI GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow* window, GLFWmo * This function sets the cursor position callback of the specified window, * which is called when the cursor is moved. The callback is provided with the * position, in screen coordinates, relative to the upper-left corner of the - * client area of the window. + * content area of the window. * * @param[in] window The window whose callback to set. * @param[in] cbfun The new callback, or `NULL` to remove the currently set @@ -4407,7 +4407,7 @@ GLFWAPI GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow* window, GLFWcursor /*! @brief Sets the cursor enter/exit callback. * * This function sets the cursor boundary crossing callback of the specified - * window, which is called when the cursor enters or leaves the client area of + * window, which is called when the cursor enters or leaves the content area of * the window. * * @param[in] window The window whose callback to set. diff --git a/src/cocoa_window.m b/src/cocoa_window.m index 6382968c..28c7ef59 100644 --- a/src/cocoa_window.m +++ b/src/cocoa_window.m @@ -67,9 +67,9 @@ static NSUInteger getStyleMask(_GLFWwindow* window) return styleMask; } -// Returns whether the cursor is in the client area of the specified window +// Returns whether the cursor is in the content area of the specified window // -static GLFWbool cursorInClientArea(_GLFWwindow* window) +static GLFWbool cursorInContentArea(_GLFWwindow* window) { const NSPoint pos = [window->ns.object mouseLocationOutsideOfEventStream]; return [window->ns.view mouse:pos inRect:[window->ns.view frame]]; @@ -124,7 +124,7 @@ static void updateCursorMode(_GLFWwindow* window) _glfwPlatformGetCursorPos(window, &_glfw.ns.restoreCursorPosX, &_glfw.ns.restoreCursorPosY); - _glfwCenterCursor(window); + _glfwCenterCursorInContentArea(window); CGAssociateMouseAndMouseCursorPosition(false); } else if (_glfw.ns.disabledCursorWindow == window) @@ -136,7 +136,7 @@ static void updateCursorMode(_GLFWwindow* window) _glfw.ns.restoreCursorPosY); } - if (cursorInClientArea(window)) + if (cursorInContentArea(window)) updateCursorImage(window); } @@ -271,7 +271,7 @@ static const NSRange kEmptyRange = { NSNotFound, 0 }; [window->context.nsgl.object update]; if (_glfw.ns.disabledCursorWindow == window) - _glfwCenterCursor(window); + _glfwCenterCursorInContentArea(window); const int maximized = [window->ns.object isZoomed]; if (window->ns.maximized != maximized) @@ -306,7 +306,7 @@ static const NSRange kEmptyRange = { NSNotFound, 0 }; [window->context.nsgl.object update]; if (_glfw.ns.disabledCursorWindow == window) - _glfwCenterCursor(window); + _glfwCenterCursorInContentArea(window); int x, y; _glfwPlatformGetWindowPos(window, &x, &y); @@ -332,7 +332,7 @@ static const NSRange kEmptyRange = { NSNotFound, 0 }; - (void)windowDidBecomeKey:(NSNotification *)notification { if (_glfw.ns.disabledCursorWindow == window) - _glfwCenterCursor(window); + _glfwCenterCursorInContentArea(window); _glfwInputWindowFocus(window, GLFW_TRUE); updateCursorMode(window); @@ -1513,7 +1513,7 @@ void _glfwPlatformDestroyCursor(_GLFWcursor* cursor) void _glfwPlatformSetCursor(_GLFWwindow* window, _GLFWcursor* cursor) { - if (cursorInClientArea(window)) + if (cursorInContentArea(window)) updateCursorImage(window); } diff --git a/src/input.c b/src/input.c index c3da79dd..33ed0604 100644 --- a/src/input.c +++ b/src/input.c @@ -333,7 +333,7 @@ void _glfwInputMouseClick(_GLFWwindow* window, int button, int action, int mods) } // Notifies shared code of a cursor motion event -// The position is specified in client-area relative screen coordinates +// The position is specified in content area relative screen coordinates // void _glfwInputCursorPos(_GLFWwindow* window, double xpos, double ypos) { @@ -453,9 +453,9 @@ void _glfwFreeJoystick(_GLFWjoystick* js) memset(js, 0, sizeof(_GLFWjoystick)); } -// Center the cursor in the middle of the window +// Center the cursor in the content area of the specified window // -void _glfwCenterCursor(_GLFWwindow* window) +void _glfwCenterCursorInContentArea(_GLFWwindow* window) { int width, height; diff --git a/src/internal.h b/src/internal.h index aa837685..e8df80a0 100644 --- a/src/internal.h +++ b/src/internal.h @@ -760,7 +760,7 @@ _GLFWjoystick* _glfwAllocJoystick(const char* name, int buttonCount, int hatCount); void _glfwFreeJoystick(_GLFWjoystick* js); -void _glfwCenterCursor(_GLFWwindow* window); +void _glfwCenterCursorInContentArea(_GLFWwindow* window); GLFWbool _glfwInitVulkan(int mode); void _glfwTerminateVulkan(void); diff --git a/src/win32_window.c b/src/win32_window.c index 0953292e..afcdc9ee 100644 --- a/src/win32_window.c +++ b/src/win32_window.c @@ -186,14 +186,14 @@ static HICON createIcon(const GLFWimage* image, return handle; } -// Translate client window size to full window size according to styles and DPI +// Translate content area size to full window size according to styles and DPI // static void getFullWindowSize(DWORD style, DWORD exStyle, - int clientWidth, int clientHeight, + int contentWidth, int contentHeight, int* fullWidth, int* fullHeight, UINT dpi) { - RECT rect = { 0, 0, clientWidth, clientHeight }; + RECT rect = { 0, 0, contentWidth, contentHeight }; if (_glfwIsWindows10AnniversaryUpdateOrGreaterWin32()) AdjustWindowRectExForDpi(&rect, style, FALSE, exStyle, dpi); @@ -204,7 +204,7 @@ static void getFullWindowSize(DWORD style, DWORD exStyle, *fullHeight = rect.bottom - rect.top; } -// Enforce the client rect aspect ratio based on which edge is being dragged +// Enforce the content area aspect ratio based on which edge is being dragged // static void applyAspectRatio(_GLFWwindow* window, int edge, RECT* area) { @@ -278,7 +278,7 @@ static void disableCursor(_GLFWwindow* window) &_glfw.win32.restoreCursorPosX, &_glfw.win32.restoreCursorPosY); updateCursorImage(window); - _glfwCenterCursor(window); + _glfwCenterCursorInContentArea(window); updateClipRect(window); if (!RegisterRawInputDevices(&rid, 1, sizeof(rid))) @@ -308,9 +308,9 @@ static void enableCursor(_GLFWwindow* window) } } -// Returns whether the cursor is in the client area of the specified window +// Returns whether the cursor is in the content area of the specified window // -static GLFWbool cursorInClientArea(_GLFWwindow* window) +static GLFWbool cursorInContentArea(_GLFWwindow* window) { RECT area; POINT pos; @@ -1074,7 +1074,7 @@ static LRESULT CALLBACK windowProc(HWND hWnd, UINT uMsg, if (window->win32.scaleToMonitor) break; - // Adjust the window size to keep the client area size constant + // Adjust the window size to keep the content area size constant if (_glfwIsWindows10CreatorsUpdateOrGreaterWin32()) { RECT source = {0}, target = {0}; @@ -1244,7 +1244,7 @@ static int createNativeWindow(_GLFWwindow* window, window->win32.scaleToMonitor = wndconfig->scaleToMonitor; // Adjust window size to account for DPI scaling of the window frame and - // optionally DPI scaling of the client area + // optionally DPI scaling of the content area // This cannot be done until we know what monitor it was placed on if (!window->monitor) { @@ -1779,7 +1779,7 @@ int _glfwPlatformWindowMaximized(_GLFWwindow* window) int _glfwPlatformWindowHovered(_GLFWwindow* window) { - return cursorInClientArea(window); + return cursorInContentArea(window); } int _glfwPlatformFramebufferTransparent(_GLFWwindow* window) @@ -1972,7 +1972,7 @@ void _glfwPlatformSetCursorMode(_GLFWwindow* window, int mode) } else if (_glfw.win32.disabledCursorWindow == window) enableCursor(window); - else if (cursorInClientArea(window)) + else if (cursorInContentArea(window)) updateCursorImage(window); } @@ -2035,7 +2035,7 @@ void _glfwPlatformDestroyCursor(_GLFWcursor* cursor) void _glfwPlatformSetCursor(_GLFWwindow* window, _GLFWcursor* cursor) { - if (cursorInClientArea(window)) + if (cursorInContentArea(window)) updateCursorImage(window); } diff --git a/src/window.c b/src/window.c index 6367f2ba..24e60054 100644 --- a/src/window.c +++ b/src/window.c @@ -67,7 +67,7 @@ void _glfwInputWindowFocus(_GLFWwindow* window, GLFWbool focused) } // Notifies shared code that a window has moved -// The position is specified in client-area relative screen coordinates +// The position is specified in content area relative screen coordinates // void _glfwInputWindowPos(_GLFWwindow* window, int x, int y) { @@ -229,7 +229,7 @@ GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, if (window->monitor) { if (wndconfig.centerCursor) - _glfwCenterCursor(window); + _glfwCenterCursorInContentArea(window); } else { diff --git a/src/x11_window.c b/src/x11_window.c index 252d9140..4a23a1e3 100644 --- a/src/x11_window.c +++ b/src/x11_window.c @@ -544,7 +544,7 @@ static void disableCursor(_GLFWwindow* window) &_glfw.x11.restoreCursorPosX, &_glfw.x11.restoreCursorPosY); updateCursorImage(window); - _glfwCenterCursor(window); + _glfwCenterCursorInContentArea(window); XGrabPointer(_glfw.x11.display, window->x11.handle, True, ButtonPressMask | ButtonReleaseMask | PointerMotionMask, GrabModeAsync, GrabModeAsync,