From cd82da72be25db82f9ec0dac6accf110732ab53a Mon Sep 17 00:00:00 2001 From: iddev5 Date: Thu, 23 Dec 2021 17:47:56 +0530 Subject: [PATCH] glfw: Update function docs in Monitor and vulkan to match glfw 3.3.6 --- glfw/src/Monitor.zig | 7 ++++--- glfw/src/vulkan.zig | 11 +++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/glfw/src/Monitor.zig b/glfw/src/Monitor.zig index dfd5a9c9..1be6c718 100644 --- a/glfw/src/Monitor.zig +++ b/glfw/src/Monitor.zig @@ -94,9 +94,9 @@ const PhysicalSize = struct { /// /// Possible errors include glfw.Error.NotInitialized. /// -/// win32: calculates the returned physical size from the current resolution and system DPI -/// instead of querying the monitor EDID data. /// +/// win32: On Windows 8 and earlier the physical size is calculated from +/// the current resolution and system DPI instead of querying the monitor EDID data /// @thread_safety This function must only be called from the main thread. /// /// see also: monitor_properties @@ -221,7 +221,8 @@ pub inline fn getUserPointer(self: Monitor, comptime T: type) ?*T { /// /// This function returns an array of all video modes supported by the monitor. The returned slice /// is sorted in ascending order, first by color bit depth (the sum of all channel depths) and -/// then by resolution area (the product of width and height). +/// then by resolution area (the product of width and height), then resolution width and finally +/// by refresh rate. /// /// Possible errors include glfw.Error.NotInitialized and glfw.Error.PlatformError. /// diff --git a/glfw/src/vulkan.zig b/glfw/src/vulkan.zig index 8e10fec0..f803adf7 100644 --- a/glfw/src/vulkan.zig +++ b/glfw/src/vulkan.zig @@ -13,8 +13,7 @@ const internal_debug = @import("internal_debug.zig"); /// found. /// /// The availability of a Vulkan loader and even an ICD does not by itself guarantee that surface -/// creation or even instance creation is possible. For example, on Fermi systems Nvidia will -/// install an ICD that provides no actual Vulkan support. Call glfw.getRequiredInstanceExtensions +/// creation or even instance creation is possible. Call glfw.getRequiredInstanceExtensions /// to check whether the extensions necessary for Vulkan surface creation are available and /// glfw.getPhysicalDevicePresentationSupport to check whether a queue family of a physical device /// supports image presentation. @@ -51,8 +50,8 @@ pub inline fn vulkanSupported() bool { /// extensions you wish to enable are already in the returned array, as it is an error to specify /// an extension more than once in the `VkInstanceCreateInfo` struct. /// -/// macos: This function currently supports either the `VK_MVK_macos_surface` extension from -/// MoltenVK or `VK_EXT_metal_surface` extension. +/// macos: GLFW currently supports both the `VK_MVK_macos_surface` and the newer +/// `VK_EXT_metal_surface` extensions. /// /// @pointer_lifetime The returned array is allocated and freed by GLFW. You should not free it /// yourself. It is guaranteed to be valid only until the library is terminated. @@ -136,8 +135,8 @@ pub fn getInstanceProcAddress(vk_instance: ?*opaque {}, proc_name: [*:0]const u8 /// /// Possible errors include glfw.Error.NotInitialized, glfw.Error.APIUnavailable and glfw.Error.PlatformError. /// -/// macos: This function currently always returns `true`, as the `VK_MVK_macos_surface` -/// extension does not provide a `vkGetPhysicalDevice*PresentationSupport` type function. +/// macos: This function currently always returns `true`, as the `VK_MVK_macos_surface` and +/// 'VK_EXT_metal_surface' extension does not provide a `vkGetPhysicalDevice*PresentationSupport` type function. /// /// @thread_safety This function may be called from any thread. For synchronization details of /// Vulkan objects, see the Vulkan specification.