vulkan: Add missing array length and (out) annotation to parameters

Add `array length` annotation for `layouts` such that `n_layouts` is
properly marked as its length, and add `(out)` where a function returns
in that parameter.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1615>
This commit is contained in:
Marijn Suijten 2021-01-04 00:40:24 +01:00
parent 4a8805ade7
commit 614cd87732
5 changed files with 19 additions and 4 deletions

View file

@ -68,7 +68,8 @@ gst_vulkan_descriptor_cache_finalize (GObject * object)
* gst_vulkan_descriptor_cache_new: * gst_vulkan_descriptor_cache_new:
* @pool: a #GstVulkanDescriptorPool * @pool: a #GstVulkanDescriptorPool
* @n_layouts: number of @layouts * @n_layouts: number of @layouts
* @layouts: list of #GstVulkanHandle containing descriptor set layouts * @layouts: (array length=n_layouts): list of #GstVulkanHandle containing
* descriptor set layouts
* *
* Returns: (transfer full): a new #GstVulkanDescriptorCache * Returns: (transfer full): a new #GstVulkanDescriptorCache
* *

View file

@ -196,6 +196,9 @@ descriptor_set_alloc (GstVulkanDescriptorPool * pool, guint n_layouts,
/** /**
* gst_vulkan_descriptor_pool_create: * gst_vulkan_descriptor_pool_create:
* @pool: a #GstVulkanDescriptorPool * @pool: a #GstVulkanDescriptorPool
* @n_layouts: number of @layouts
* @layouts: (array length=n_layouts): list of #GstVulkanHandle containing
* descriptor set layouts
* @error: a #GError * @error: a #GError
* *
* Returns: a new #GstVulkanDescriptorSet * Returns: a new #GstVulkanDescriptorSet

View file

@ -117,6 +117,9 @@ gst_vulkan_descriptor_set_init (GstVulkanDescriptorSet * set,
/** /**
* gst_vulkan_descriptor_set_new_wrapped: * gst_vulkan_descriptor_set_new_wrapped:
* @set: a VkDescriptorSet * @set: a VkDescriptorSet
* @n_layouts: number of @layouts
* @layouts: (array length=n_layouts): list of #GstVulkanHandle containing
* descriptor set layouts
* *
* Returns: (transfer full): a new #GstVulkanDescriptorSet * Returns: (transfer full): a new #GstVulkanDescriptorSet
* *

View file

@ -1301,9 +1301,9 @@ gst_vulkan_instance_check_version (GstVulkanInstance * instance,
/** /**
* gst_vulkan_instance_get_version: * gst_vulkan_instance_get_version:
* @instance: a #GstVulkanInstance * @instance: a #GstVulkanInstance
* @major: major version * @major: (out): major version
* @minor: minor version * @minor: (out): minor version
* @patch: patch version * @patch: (out): patch version
* *
* Retrieve the vulkan instance configured version. Only returns the supported * Retrieve the vulkan instance configured version. Only returns the supported
* API version by the instance without taking into account the requested API * API version by the instance without taking into account the requested API

View file

@ -484,6 +484,14 @@ gst_vulkan_window_set_window_handle (GstVulkanWindow * window, guintptr handle)
} }
} }
/**
* gst_vulkan_window_get_surface_dimensions:
* @window: a #GstVulkanWindow
* @width: (out): Current width of @window
* @height: (out): Current height of @window
*
* Since: 1.18
*/
void void
gst_vulkan_window_get_surface_dimensions (GstVulkanWindow * window, gst_vulkan_window_get_surface_dimensions (GstVulkanWindow * window,
guint * width, guint * height) guint * width, guint * height)