mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-22 16:26:39 +00:00
Code Issues 1 Projects Releases Wiki Activity

vkoperation: fix documentation

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/7203>
This commit is contained in:
Víctor Manuel Jáquez Leal 2024-07-19 17:05:13 +02:00
parent 2ee51bf6f6
commit 035e0698cf
2 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
girs/GstVulkan-1.0.gir
View file

@ -4594,8 +4594,8 @@ hold the same semaphores but increasing their current value.</doc>
gst_vulkan_operation_new_extra_image_barriers() and gst_vulkan_operation_new_extra_image_barriers() and
gst_vulkan_operation_update_frame() gst_vulkan_operation_update_frame()
Any non-repeated image barrier in @extra is appended to the internal barrier Any non-repeated image barrier in @extra_barriers is appended to the internal
list. barrier list.
Remember to call gst_vulkan_operation_update_frame() on those frames with Remember to call gst_vulkan_operation_update_frame() on those frames with
images in @extra_barriers.</doc> images in @extra_barriers.</doc>
@ -4683,7 +4683,7 @@ called internally if something failed.</doc>
</parameters> </parameters>
</method> </method>
<method name="begin_query" c:identifier="gst_vulkan_operation_begin_query"> <method name="begin_query" c:identifier="gst_vulkan_operation_begin_query">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">Begins a query operation in the current command buffer.</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">Begins a query operation with @id in the current command buffer.</doc>
<source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.h"/> <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.h"/>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">whether the begin command was set</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">whether the begin command was set</doc>
@ -4695,6 +4695,7 @@ called internally if something failed.</doc>
<type name="VulkanOperation" c:type="GstVulkanOperation*"/> <type name="VulkanOperation" c:type="GstVulkanOperation*"/>
</instance-parameter> </instance-parameter>
<parameter name="id" transfer-ownership="none"> <parameter name="id" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">query id</doc>
<type name="guint32" c:type="guint32"/> <type name="guint32" c:type="guint32"/>
</parameter> </parameter>
</parameters> </parameters>
@ -4762,7 +4763,8 @@ gst_vulkan_operation_reset() is called internally if something fails</doc>
</parameters> </parameters>
</method> </method>
<method name="end_query" c:identifier="gst_vulkan_operation_end_query"> <method name="end_query" c:identifier="gst_vulkan_operation_end_query">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">Ends a query operation in the current command buffer.</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">Ends a query operation with @id in the current command buffer. A query with
@id has had started with gst_vulkan_operation_begin_query()</doc>
<source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.h"/> <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.h"/>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">whether the end command was set</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">whether the end command was set</doc>
@ -4774,6 +4776,7 @@ gst_vulkan_operation_reset() is called internally if something fails</doc>
<type name="VulkanOperation" c:type="GstVulkanOperation*"/> <type name="VulkanOperation" c:type="GstVulkanOperation*"/>
</instance-parameter> </instance-parameter>
<parameter name="id" transfer-ownership="none"> <parameter name="id" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">query id</doc>
<type name="guint32" c:type="guint32"/> <type name="guint32" c:type="guint32"/>
</parameter> </parameter>
</parameters> </parameters>

11
subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c
View file

@ -784,8 +784,8 @@ gst_vulkan_operation_new_extra_image_barriers (GstVulkanOperation * self)
* gst_vulkan_operation_new_extra_image_barriers() and * gst_vulkan_operation_new_extra_image_barriers() and
* gst_vulkan_operation_update_frame() * gst_vulkan_operation_update_frame()
* *
* Any non-repeated image barrier in @extra is appended to the internal barrier * Any non-repeated image barrier in @extra_barriers is appended to the internal
* list. * barrier list.
* *
* Remember to call gst_vulkan_operation_update_frame() on those frames with * Remember to call gst_vulkan_operation_update_frame() on those frames with
* images in @extra_barriers. * images in @extra_barriers.
@ -1333,8 +1333,9 @@ gst_vulkan_operation_get_query (GstVulkanOperation * self, gpointer * result,
/** /**
* gst_vulkan_operation_begin_query: * gst_vulkan_operation_begin_query:
* @self: a #GstVulkanOperation * @self: a #GstVulkanOperation
* @id: query id
* *
* Begins a query operation in the current command buffer. * Begins a query operation with @id in the current command buffer.
* *
* Returns: whether the begin command was set * Returns: whether the begin command was set
*/ */
@ -1364,8 +1365,10 @@ gst_vulkan_operation_begin_query (GstVulkanOperation * self, guint32 id)
/** /**
* gst_vulkan_operation_end_query: * gst_vulkan_operation_end_query:
* @self: a #GstVulkanOperation * @self: a #GstVulkanOperation
* @id: query id
* *
* Ends a query operation in the current command buffer. * Ends a query operation with @id in the current command buffer. A query with
* @id has had started with gst_vulkan_operation_begin_query()
* *
* Returns: whether the end command was set * Returns: whether the end command was set
*/ */