mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-17 03:35:21 +00:00
Code Issues 1 Projects Releases Wiki Activity

d3d11overlay: Enhance documentation and fix typo

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4455>
This commit is contained in:
Seungha Yang 2023-04-20 02:18:21 +09:00 committed by GStreamer Marge Bot
parent c7c380abb1
commit 3811894d9c
1 changed files with 14 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
subprojects/gst-plugins-bad/sys/d3d11/gstd3d11overlay.cpp
View file

@ -22,8 +22,13 @@
* SECTION:element-d3d11overlay
* @title: d3d11overlay
*
* Provides Direct3D11 render target view to an application so that
* the application overlay/blend application image on the render target view
* Provides Direct3D11 render target view handles to an application so that
* the application can overlay/blend an image on the render target
*
* ## Example launch line
* ```
* gst-launch-1.0 d3d11testsrc ! queue ! d3d11overlay ! queue ! d3d11videosink
* ```
*
* Since: 1.24
*
@ -83,12 +88,15 @@ gst_d3d11_overlay_class_init (GstD3D11OverlayClass * klass)
* GstD3D11Overlay::draw:
* @overlay: Overlay element emitting the signal
* @device: GstD3D11Device object
* @rtv: ID3D11RenderTargetView handle
* @render_target: ID3D11RenderTargetView handle
* @timestamp: Timestamp (see #GstClockTime) of the current buffer
* @duration: Duration (see #GstClockTime) of the current buffer
*
* This signal is emitted when the overlay should be drawn with
* gst_d3d11_device_lock taken.
* This signal is emitted when an overlay can be drawn. This signal is
* emitted with gst_d3d11_device_lock taken.
*
* Client should return %TRUE if an overlay has been rendered.
* Otherwise the element might discard the updated scene.
*
* Returns: %TRUE if rendering operation happend
*
@ -141,7 +149,7 @@ gst_d3d11_overlay_class_init (GstD3D11OverlayClass * klass)
}
static void
gst_d3d11_overlay_init (GstD3D11Overlay * download)
gst_d3d11_overlay_init (GstD3D11Overlay * self)
{
}