1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>vulkansink: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> 9<link rel="prev" href="gst-plugins-bad-plugins-voamrwbenc.html" title="voamrwbenc"> 10<link rel="next" href="gst-plugins-bad-plugins-vulkanupload.html" title="vulkanupload"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-bad-plugins-vulkansink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-vulkansink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-vulkansink.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-bad-plugins-vulkansink.properties" class="shortcut">Properties</a></span> 22</td> 23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 25<td><a accesskey="p" href="gst-plugins-bad-plugins-voamrwbenc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-bad-plugins-vulkanupload.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 27</tr></table> 28<div class="refentry"> 29<a name="gst-plugins-bad-plugins-vulkansink"></a><div class="titlepage"></div> 30<div class="refnamediv"><table width="100%"><tr> 31<td valign="top"> 32<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-vulkansink.top_of_page"></a>vulkansink</span></h2> 33<p>vulkansink</p> 34</td> 35<td class="gallery_image" valign="top" align="right"></td> 36</tr></table></div> 37<div class="refsect1"> 38<a name="gst-plugins-bad-plugins-vulkansink.properties"></a><h2>Properties</h2> 39<div class="informaltable"><table class="informaltable" border="0"> 40<colgroup> 41<col width="150px" class="properties_type"> 42<col width="300px" class="properties_name"> 43<col width="200px" class="properties_flags"> 44</colgroup> 45<tbody> 46<tr> 47<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-vulkansink.html#GstVulkanSink--force-aspect-ratio" title="The “force-aspect-ratio” property">force-aspect-ratio</a></td> 49<td class="property_flags">Read / Write</td> 50</tr> 51<tr> 52<td class="property_type"><span class="type">GstFraction</span></td> 53<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-vulkansink.html#GstVulkanSink--pixel-aspect-ratio" title="The “pixel-aspect-ratio” property">pixel-aspect-ratio</a></td> 54<td class="property_flags">Read / Write</td> 55</tr> 56</tbody> 57</table></div> 58</div> 59<a name="GstVulkanSink"></a><div class="refsect1"> 60<a name="gst-plugins-bad-plugins-vulkansink.other"></a><h2>Types and Values</h2> 61<div class="informaltable"><table class="informaltable" width="100%" border="0"> 62<colgroup> 63<col width="150px" class="name"> 64<col class="description"> 65</colgroup> 66<tbody><tr> 67<td class="datatype_keyword">struct</td> 68<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-vulkansink.html#GstVulkanSink-struct" title="struct GstVulkanSink">GstVulkanSink</a></td> 69</tr></tbody> 70</table></div> 71</div> 72<div class="refsect1"> 73<a name="gst-plugins-bad-plugins-vulkansink.object-hierarchy"></a><h2>Object Hierarchy</h2> 74<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 75 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 76 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 77 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 78 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a> 79 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoSink.html#GstVideoSink-struct">GstVideoSink</a> 80 <span class="lineart">╰──</span> GstVulkanSink 81</pre> 82</div> 83<div class="refsect1"> 84<a name="gst-plugins-bad-plugins-vulkansink.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 85<p> 86GstVulkanSink implements 87 <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoOverlay.html#GstVideoOverlay-struct">GstVideoOverlay</a>.</p> 88</div> 89<div class="refsect1"> 90<a name="gst-plugins-bad-plugins-vulkansink.description"></a><h2>Description</h2> 91<p>vulkansink renders video frames to a drawable on a local or remote 92display using Vulkan.</p> 93<div class="refsynopsisdiv"> 94<h2>Synopsis</h2> 95<div class="refsect2"> 96<a name="id-1.2.243.8.3.1"></a><h3>Element Information</h3> 97<div class="variablelist"><table border="0" class="variablelist"> 98<colgroup> 99<col align="left" valign="top"> 100<col> 101</colgroup> 102<tbody> 103<tr> 104<td><p><span class="term">plugin</span></p></td> 105<td> 106 <a class="link" href="gst-plugins-bad-plugins-plugin-vulkan.html#plugin-vulkan">vulkan</a> 107 </td> 108</tr> 109<tr> 110<td><p><span class="term">author</span></p></td> 111<td>Matthew Waters <matthew@centricular.com></td> 112</tr> 113<tr> 114<td><p><span class="term">class</span></p></td> 115<td>Sink/Video</td> 116</tr> 117</tbody> 118</table></div> 119</div> 120<hr> 121<div class="refsect2"> 122<a name="id-1.2.243.8.3.2"></a><h3>Element Pads</h3> 123<div class="variablelist"><table border="0" class="variablelist"> 124<colgroup> 125<col align="left" valign="top"> 126<col> 127</colgroup> 128<tbody> 129<tr> 130<td><p><span class="term">name</span></p></td> 131<td>sink</td> 132</tr> 133<tr> 134<td><p><span class="term">direction</span></p></td> 135<td>sink</td> 136</tr> 137<tr> 138<td><p><span class="term">presence</span></p></td> 139<td>always</td> 140</tr> 141<tr> 142<td><p><span class="term">details</span></p></td> 143<td>video/x-raw(memory:VulkanBuffer), format=(string){ RGBA, BGRA, RGB, BGR }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 144</tr> 145</tbody> 146</table></div> 147</div> 148</div> 149</div> 150<div class="refsect1"> 151<a name="gst-plugins-bad-plugins-vulkansink.functions_details"></a><h2>Functions</h2> 152<p></p> 153</div> 154<div class="refsect1"> 155<a name="gst-plugins-bad-plugins-vulkansink.other_details"></a><h2>Types and Values</h2> 156<div class="refsect2"> 157<a name="GstVulkanSink-struct"></a><h3>struct GstVulkanSink</h3> 158<pre class="programlisting">struct GstVulkanSink;</pre> 159</div> 160</div> 161<div class="refsect1"> 162<a name="gst-plugins-bad-plugins-vulkansink.property-details"></a><h2>Property Details</h2> 163<div class="refsect2"> 164<a name="GstVulkanSink--force-aspect-ratio"></a><h3>The <code class="literal">“force-aspect-ratio”</code> property</h3> 165<pre class="programlisting"> “force-aspect-ratio” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 166<p>When enabled, scaling will respect original aspect ratio.</p> 167<p>Flags: Read / Write</p> 168<p>Default value: TRUE</p> 169</div> 170<hr> 171<div class="refsect2"> 172<a name="GstVulkanSink--pixel-aspect-ratio"></a><h3>The <code class="literal">“pixel-aspect-ratio”</code> property</h3> 173<pre class="programlisting"> “pixel-aspect-ratio” <span class="type">GstFraction</span></pre> 174<p>The pixel aspect ratio of the device.</p> 175<p>Flags: Read / Write</p> 176</div> 177</div> 178</div> 179<div class="footer"> 180<hr>Generated by GTK-Doc V1.28</div> 181</body> 182</html>
