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>

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorcache.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorcache.c
index 6778dc1c38ef434488c7be448161d0df9117ed65..cc815a57b14ac0bf6dc4f9347ea20467eb1fbe5b 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorcache.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorcache.c
@@ -68,7 +68,8 @@ gst_vulkan_descriptor_cache_finalize (GObject * object)
  * gst_vulkan_descriptor_cache_new:
  * @pool: a #GstVulkanDescriptorPool
  * @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
  *

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorpool.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorpool.c
index 528e32efb65d13978c82f8b492c637dae5e3677b..99be8eda241b781a44480766aa28e07720aee67b 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorpool.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorpool.c
@@ -196,6 +196,9 @@ descriptor_set_alloc (GstVulkanDescriptorPool * pool, guint n_layouts,
 /**
  * gst_vulkan_descriptor_pool_create:
  * @pool: a #GstVulkanDescriptorPool
+ * @n_layouts: number of @layouts
+ * @layouts: (array length=n_layouts): list of #GstVulkanHandle containing
+ *                                     descriptor set layouts
  * @error: a #GError
  *
  * Returns: a new #GstVulkanDescriptorSet

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorset.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorset.c
index 1718382d804c014dbea0ba0d328759208291055d..549702ebffe36e210e37b75a2130859360fbfabd 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorset.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdescriptorset.c
@@ -117,6 +117,9 @@ gst_vulkan_descriptor_set_init (GstVulkanDescriptorSet * set,
 /**
  * gst_vulkan_descriptor_set_new_wrapped:
  * @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
  *

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkinstance.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkinstance.c
index 58631fcdf45fcf5be9a7ffefbf206b33468f4012..cf6a65a1927c8284b4a99964a2fc0a887f78e316 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkinstance.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkinstance.c
@@ -1301,9 +1301,9 @@ gst_vulkan_instance_check_version (GstVulkanInstance * instance,
 /**
  * gst_vulkan_instance_get_version:
  * @instance: a #GstVulkanInstance
- * @major: major version
- * @minor: minor version
- * @patch: patch version
+ * @major: (out): major version
+ * @minor: (out): minor version
+ * @patch: (out): patch version
  *
  * Retrieve the vulkan instance configured version.  Only returns the supported
  * API version by the instance without taking into account the requested API

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkwindow.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkwindow.c
index ed5a784c9f3b99038efc2ff512914ffa169155c4..da2834a2b002412f9c205f2c10a6219683ad34ed 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkwindow.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkwindow.c
@@ -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
 gst_vulkan_window_get_surface_dimensions (GstVulkanWindow * window,
     guint * width, guint * height)