xref: /third_party/glfw/include/GLFW/glfw3.h

74 /*! @defgroup monitor Monitor reference
77  *  This is the reference documentation for monitor related functions and types.
1382 /*! @brief Opaque monitor object.
1384  *  Opaque monitor object.
1390  *  @ingroup monitor
1972 /*! @brief The function pointer type for monitor configuration callbacks.
1974  *  This is the function pointer type for monitor configuration callbacks.
1975  *  A monitor callback function has the following signature:
1977  *  void function_name(GLFWmonitor* monitor, int event)
1980  *  @param[in] monitor The monitor that was connected or disconnected.
1989  *  @ingroup monitor
1991 typedef void (* GLFWmonitorfun)(GLFWmonitor* monitor, int event);
2025  *  @ingroup monitor
2051  *  This describes the gamma ramp for a monitor.
2059  *  @ingroup monitor
2554  *  monitors.  The primary monitor is always first in the returned array.  If no
2559  *  @return An array of monitor handles, or `NULL` if no monitors were found or
2566  *  monitor configuration changes or the library is terminated.
2576  *  @ingroup monitor
2580 /*! @brief Returns the primary monitor.
2582  *  This function returns the primary monitor.  This is usually the monitor
2585  *  @return The primary monitor, or `NULL` if no monitors were found or if an
2592  *  @remark The primary monitor is always first in the array returned by @ref
2600  *  @ingroup monitor
2604 /*! @brief Returns the position of the monitor's viewport on the virtual screen.
2607  *  corner of the specified monitor.
2612  *  @param[in] monitor The monitor to query.
2613  *  @param[out] xpos Where to store the monitor x-coordinate, or `NULL`.
2614  *  @param[out] ypos Where to store the monitor y-coordinate, or `NULL`.
2625  *  @ingroup monitor
2627 GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
2629 /*! @brief Retrieves the work area of the monitor.
2632  *  corner of the work area of the specified monitor along with the work area
2634  *  monitor not occluded by the window system task bar where present. If no
2635  *  task bar exists then the work area is the monitor resolution in screen
2641  *  @param[in] monitor The monitor to query.
2642  *  @param[out] xpos Where to store the monitor x-coordinate, or `NULL`.
2643  *  @param[out] ypos Where to store the monitor y-coordinate, or `NULL`.
2644  *  @param[out] width Where to store the monitor width, or `NULL`.
2645  *  @param[out] height Where to store the monitor height, or `NULL`.
2656  *  @ingroup monitor
2658 GLFWAPI void glfwGetMonitorWorkarea(GLFWmonitor* monitor, int* xpos, int* ypos, int* width, int* height);
2660 /*! @brief Returns the physical size of the monitor.
2663  *  specified monitor.
2665  *  Some platforms do not provide accurate monitor size information, either
2666  *  because the monitor [EDID][] data is incorrect or because the driver does
2674  *  @param[in] monitor The monitor to query.
2676  *  monitor's display area, or `NULL`.
2678  *  monitor's display area, or `NULL`.
2683  *  the current resolution and system DPI instead of querying the monitor EDID data.
2691  *  @ingroup monitor
2693 GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* widthMM, int* heightMM);
2695 /*! @brief Retrieves the content scale for the specified monitor.
2697  *  This function retrieves the content scale for the specified monitor.  The
2705  *  The content scale may depend on both the monitor resolution and pixel
2709  *  @param[in] monitor The monitor to query.
2726  *  @ingroup monitor
2728 GLFWAPI void glfwGetMonitorContentScale(GLFWmonitor* monitor, float* xscale, float* yscale);
2730 /*! @brief Returns the name of the specified monitor.
2733  *  specified monitor.  The name typically reflects the make and model of the
2734  *  monitor and is not guaranteed to be unique among the connected monitors.
2736  *  @param[in] monitor The monitor to query.
2737  *  @return The UTF-8 encoded name of the monitor, or `NULL` if an
2743  *  should not free it yourself.  It is valid until the specified monitor is
2752  *  @ingroup monitor
2754 GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor);
2756 /*! @brief Sets the user pointer of the specified monitor.
2758  *  This function sets the user-defined pointer of the specified monitor.  The
2759  *  current value is retained until the monitor is disconnected.  The initial
2762  *  This function may be called from the monitor callback, even for a monitor
2765  *  @param[in] monitor The monitor whose pointer to set.
2778  *  @ingroup monitor
2780 GLFWAPI void glfwSetMonitorUserPointer(GLFWmonitor* monitor, void* pointer);
2782 /*! @brief Returns the user pointer of the specified monitor.
2785  *  specified monitor.  The initial value is `NULL`.
2787  *  This function may be called from the monitor callback, even for a monitor
2790  *  @param[in] monitor The monitor whose pointer to return.
2802  *  @ingroup monitor
2804 GLFWAPI void* glfwGetMonitorUserPointer(GLFWmonitor* monitor);
2806 /*! @brief Sets the monitor configuration callback.
2808  *  This function sets the monitor configuration callback, or removes the
2809  *  currently set callback.  This is called when a monitor is connected to or
2819  *  void function_name(GLFWmonitor* monitor, int event)
2832  *  @ingroup monitor
2836 /*! @brief Returns the available video modes for the specified monitor.
2839  *  monitor.  The returned array is sorted in ascending order, first by color
2844  *  @param[in] monitor The monitor to query.
2854  *  should not free it yourself.  It is valid until the specified monitor is
2855  *  disconnected, this function is called again for that monitor or the library
2864  *  @glfw3 Changed to return an array of modes for a specific monitor.
2866  *  @ingroup monitor
2868 GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count);
2870 /*! @brief Returns the current mode of the specified monitor.
2872  *  This function returns the current video mode of the specified monitor.  If
2873  *  you have created a full screen window for that monitor, the return value
2876  *  @param[in] monitor The monitor to query.
2877  *  @return The current mode of the monitor, or `NULL` if an
2884  *  should not free it yourself.  It is valid until the specified monitor is
2894  *  @ingroup monitor
2896 GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
2898 /*! @brief Generates a gamma ramp and sets it for the specified monitor.
2912  *  @param[in] monitor The monitor whose gamma ramp to set.
2927  *  @ingroup monitor
2929 GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
2931 /*! @brief Returns the current gamma ramp for the specified monitor.
2933  *  This function returns the current gamma ramp of the specified monitor.
2935  *  @param[in] monitor The monitor to query.
2948  *  specified monitor is disconnected, this function is called again for that
2949  *  monitor or the library is terminated.
2957  *  @ingroup monitor
2959 GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
2961 /*! @brief Sets the current gamma ramp for the specified monitor.
2963  *  This function sets the current gamma ramp for the specified monitor.  The
2964  *  original gamma ramp for that monitor is saved by GLFW the first time this
2975  *  @param[in] monitor The monitor whose gamma ramp to set.
2982  *  current ramp for that monitor.
2998  *  @ingroup monitor
3000 GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp);
3112  *  To create a full screen window, you need to specify the monitor the window
3113  *  will cover.  If no monitor is specified, the window will be windowed mode.
3114  *  Unless you have a way for the user to choose a specific monitor, it is
3115  *  recommended that you pick the primary monitor.  For more information on how
3121  *  mode is set for the specified monitor.  For more information about full
3150  *  @param[in] monitor The monitor to use for full screen mode, or `NULL` for
3236 GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, GLFWmonitor* monitor, GLFWwindow* share);
3714  *  content scale will depend on which monitor the system considers the window
3802  *  video mode of the monitor.  The window's desired video mode is set again
3834  *  video mode is set again for its monitor when the window is restored.
3999 /*! @brief Returns the monitor that the window uses for full screen mode.
4001  *  This function returns the handle of the monitor that the specified window is
4005  *  @return The monitor, or `NULL` if the window is in windowed mode or an
4021 /*! @brief Sets the mode, monitor, video mode and placement of a window.
4023  *  This function sets the monitor that the window uses for full screen mode or,
4024  *  if the monitor is `NULL`, makes it windowed mode.
4026  *  When setting a monitor, this function updates the width, height and refresh
4028  *  The window position is ignored when setting a monitor.
4030  *  When the monitor is `NULL`, the position, width and height are used to
4031  *  place the window content area.  The refresh rate is ignored when no monitor
4041  *  @param[in] window The window whose monitor, size or video mode to set.
4042  *  @param[in] monitor The desired monitor, or `NULL` to set windowed mode.
4075 GLFWAPI void glfwSetWindowMonitor(GLFWwindow* window, GLFWmonitor* monitor, int xpos, int ypos, int width, int height, int refreshRate);

Indexes created Thu Nov 07 10:32:03 CST 2024