mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-09-29 15:22:17 +00:00
d3d11overlay: Enhance documentation and fix typo
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4455>
This commit is contained in:
parent
c7c380abb1
commit
3811894d9c
1 changed files with 14 additions and 6 deletions
|
@ -22,8 +22,13 @@
|
||||||
* SECTION:element-d3d11overlay
|
* SECTION:element-d3d11overlay
|
||||||
* @title: d3d11overlay
|
* @title: d3d11overlay
|
||||||
*
|
*
|
||||||
* Provides Direct3D11 render target view to an application so that
|
* Provides Direct3D11 render target view handles to an application so that
|
||||||
* the application overlay/blend application image on the render target view
|
* 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
|
* Since: 1.24
|
||||||
*
|
*
|
||||||
|
@ -83,12 +88,15 @@ gst_d3d11_overlay_class_init (GstD3D11OverlayClass * klass)
|
||||||
* GstD3D11Overlay::draw:
|
* GstD3D11Overlay::draw:
|
||||||
* @overlay: Overlay element emitting the signal
|
* @overlay: Overlay element emitting the signal
|
||||||
* @device: GstD3D11Device object
|
* @device: GstD3D11Device object
|
||||||
* @rtv: ID3D11RenderTargetView handle
|
* @render_target: ID3D11RenderTargetView handle
|
||||||
* @timestamp: Timestamp (see #GstClockTime) of the current buffer
|
* @timestamp: Timestamp (see #GstClockTime) of the current buffer
|
||||||
* @duration: Duration (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
|
* This signal is emitted when an overlay can be drawn. This signal is
|
||||||
* gst_d3d11_device_lock taken.
|
* 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
|
* Returns: %TRUE if rendering operation happend
|
||||||
*
|
*
|
||||||
|
@ -141,7 +149,7 @@ gst_d3d11_overlay_class_init (GstD3D11OverlayClass * klass)
|
||||||
}
|
}
|
||||||
|
|
||||||
static void
|
static void
|
||||||
gst_d3d11_overlay_init (GstD3D11Overlay * download)
|
gst_d3d11_overlay_init (GstD3D11Overlay * self)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue