mirror of
https://gitlab.freedesktop.org/monado/monado.git
synced 2025-02-14 17:50:06 +00:00
auxiliary: Improve word choice/clarity
This commit is contained in:
parent
6e78ec1127
commit
3b54152563
src/xrt/auxiliary
|
@ -2,7 +2,7 @@
|
||||||
// SPDX-License-Identifier: BSL-1.0
|
// SPDX-License-Identifier: BSL-1.0
|
||||||
/*!
|
/*!
|
||||||
* @file
|
* @file
|
||||||
* @brief Header with just documentation.
|
* @brief Header with only documentation.
|
||||||
* @author Jakob Bornecrantz <jakob@collabora.com>
|
* @author Jakob Bornecrantz <jakob@collabora.com>
|
||||||
* @ingroup aux_ogl
|
* @ingroup aux_ogl
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -70,8 +70,7 @@ os_hid_write(struct os_hid_device *hid_dev, const uint8_t *data, size_t size)
|
||||||
/*!
|
/*!
|
||||||
* Get a numbered feature report.
|
* Get a numbered feature report.
|
||||||
*
|
*
|
||||||
* If the device doesn't have more than one feature report, just request
|
* If the device doesn't have more than one feature report, request report 0.
|
||||||
* report 0.
|
|
||||||
*
|
*
|
||||||
* @public @memberof os_hid_device
|
* @public @memberof os_hid_device
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -125,7 +125,7 @@ os_precise_sleeper_deinit(struct os_precise_sleeper *ops)
|
||||||
/*!
|
/*!
|
||||||
* @brief Sleep the given number of nanoseconds, trying harder to be precise.
|
* @brief Sleep the given number of nanoseconds, trying harder to be precise.
|
||||||
*
|
*
|
||||||
* On some platforms, there is no way to improve sleep precision easily with some OS-specific state, so we just forward
|
* On some platforms, there is no way to improve sleep precision easily with some OS-specific state, so we forward
|
||||||
* to os_nanosleep().
|
* to os_nanosleep().
|
||||||
*
|
*
|
||||||
* Note that on all platforms, the system scheduler has the final say.
|
* Note that on all platforms, the system scheduler has the final say.
|
||||||
|
@ -146,7 +146,7 @@ os_precise_sleeper_nanosleep(struct os_precise_sleeper *ops, int32_t nsec)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
// If we fall through from an implementation, or there's no implementation needed for a platform, we just
|
// If we fall through from an implementation, or there's no implementation needed for a platform, we
|
||||||
// delegate to the regular os_nanosleep.
|
// delegate to the regular os_nanosleep.
|
||||||
os_nanosleep(nsec);
|
os_nanosleep(nsec);
|
||||||
}
|
}
|
||||||
|
@ -155,7 +155,7 @@ os_precise_sleeper_nanosleep(struct os_precise_sleeper *ops, int32_t nsec)
|
||||||
/*!
|
/*!
|
||||||
* @brief Convert a timespec struct to nanoseconds.
|
* @brief Convert a timespec struct to nanoseconds.
|
||||||
*
|
*
|
||||||
* Note that this just does the value combining, no adjustment for epochs is performed.
|
* Note that this does the value combining, no adjustment for epochs is performed.
|
||||||
*
|
*
|
||||||
* @ingroup aux_os_time_extra
|
* @ingroup aux_os_time_extra
|
||||||
*/
|
*/
|
||||||
|
@ -171,7 +171,7 @@ os_timespec_to_ns(const struct timespec *spec)
|
||||||
/*!
|
/*!
|
||||||
* @brief Convert an nanosecond integer to a timespec struct.
|
* @brief Convert an nanosecond integer to a timespec struct.
|
||||||
*
|
*
|
||||||
* Note that this just does the value splitting, no adjustment for epochs is performed.
|
* Note that this does the value splitting, no adjustment for epochs is performed.
|
||||||
* @ingroup aux_os_time_extra
|
* @ingroup aux_os_time_extra
|
||||||
*/
|
*/
|
||||||
static inline void
|
static inline void
|
||||||
|
|
|
@ -605,7 +605,7 @@ get_device_ext_props(struct vk_bundle *vk,
|
||||||
res = vk->vkEnumerateDeviceExtensionProperties(physical_device, NULL, &prop_count, props);
|
res = vk->vkEnumerateDeviceExtensionProperties(physical_device, NULL, &prop_count, props);
|
||||||
vk_check_error_with_free("vkEnumerateDeviceExtensionProperties", res, false, props);
|
vk_check_error_with_free("vkEnumerateDeviceExtensionProperties", res, false, props);
|
||||||
|
|
||||||
// Check above returns on failure.
|
// The preceding check returns on failure.
|
||||||
*out_props = props;
|
*out_props = props;
|
||||||
*out_prop_count = prop_count;
|
*out_prop_count = prop_count;
|
||||||
|
|
||||||
|
|
|
@ -39,8 +39,8 @@ extern "C" {
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
* A bundle of Vulkan functions and objects, used by both @ref comp and @ref
|
* A bundle of Vulkan functions and objects, used by both @ref comp and @ref
|
||||||
* comp_client. Note that they both have different instances of the object and
|
* comp_client. Note that they both have different instances of the object, and
|
||||||
* as such VkInstance and so on.
|
* thus different VkInstance, etc.
|
||||||
*
|
*
|
||||||
* @ingroup aux_vk
|
* @ingroup aux_vk
|
||||||
*/
|
*/
|
||||||
|
@ -871,7 +871,7 @@ VkResult
|
||||||
vk_locked_submit(struct vk_bundle *vk, VkQueue queue, uint32_t count, const VkSubmitInfo *infos, VkFence fence);
|
vk_locked_submit(struct vk_bundle *vk, VkQueue queue, uint32_t count, const VkSubmitInfo *infos, VkFence fence);
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
* Set the image layout via a berrier command, takes the pool lock.
|
* Set the image layout using a barrier command, takes the pool lock.
|
||||||
*
|
*
|
||||||
* @pre Requires successful call to vk_init_mutex.
|
* @pre Requires successful call to vk_init_mutex.
|
||||||
*
|
*
|
||||||
|
|
Loading…
Reference in a new issue