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>GstPhysMemoryAllocator: GStreamer Base Plugins 1.0 Library Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual"> 8<link rel="up" href="gstreamer-allocators.html" title="Allocators Library"> 9<link rel="prev" href="gst-plugins-base-libs-fdmemory.html" title="GstFdAllocator"> 10<link rel="next" href="gstreamer-app.html" title="App Library"> 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="#GstPhysMemoryAllocator.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#GstPhysMemoryAllocator.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span> 20 <a href="#GstPhysMemoryAllocator.prerequisites" class="shortcut">Prerequisites</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="gstreamer-allocators.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-base-libs-fdmemory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gstreamer-app.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="GstPhysMemoryAllocator"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="GstPhysMemoryAllocator.top_of_page"></a>GstPhysMemoryAllocator</span></h2> 32<p>GstPhysMemoryAllocator — Interface for allocators that pass around physical memory addresses</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="GstPhysMemoryAllocator.functions"></a><h2>Functions</h2> 38<div class="informaltable"><table class="informaltable" width="100%" border="0"> 39<colgroup> 40<col width="150px" class="functions_return"> 41<col class="functions_name"> 42</colgroup> 43<tbody> 44<tr> 45<td class="function_type"> 46<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 47</td> 48<td class="function_name"> 49<a class="link" href="GstPhysMemoryAllocator.html#gst-is-phys-memory" title="gst_is_phys_memory ()">gst_is_phys_memory</a> <span class="c_punctuation">()</span> 50</td> 51</tr> 52<tr> 53<td class="function_type"> 54<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guintptr"><span class="returnvalue">guintptr</span></a> 55</td> 56<td class="function_name"> 57<a class="link" href="GstPhysMemoryAllocator.html#gst-phys-memory-get-phys-addr" title="gst_phys_memory_get_phys_addr ()">gst_phys_memory_get_phys_addr</a> <span class="c_punctuation">()</span> 58</td> 59</tr> 60</tbody> 61</table></div> 62</div> 63<div class="refsect1"> 64<a name="GstPhysMemoryAllocator.other"></a><h2>Types and Values</h2> 65<div class="informaltable"><table class="informaltable" width="100%" border="0"> 66<colgroup> 67<col width="150px" class="name"> 68<col class="description"> 69</colgroup> 70<tbody> 71<tr> 72<td class="datatype_keyword"> </td> 73<td class="function_name"><a class="link" href="GstPhysMemoryAllocator.html#GstPhysMemoryAllocator-struct" title="GstPhysMemoryAllocator">GstPhysMemoryAllocator</a></td> 74</tr> 75<tr> 76<td class="datatype_keyword">struct</td> 77<td class="function_name"><a class="link" href="GstPhysMemoryAllocator.html#GstPhysMemoryAllocatorInterface" title="struct GstPhysMemoryAllocatorInterface">GstPhysMemoryAllocatorInterface</a></td> 78</tr> 79</tbody> 80</table></div> 81</div> 82<div class="refsect1"> 83<a name="GstPhysMemoryAllocator.object-hierarchy"></a><h2>Object Hierarchy</h2> 84<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a> 85 <span class="lineart">╰──</span> GstPhysMemoryAllocator 86</pre> 87</div> 88<div class="refsect1"> 89<a name="GstPhysMemoryAllocator.prerequisites"></a><h2>Prerequisites</h2> 90<p> 91GstPhysMemoryAllocator requires 92 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstAllocator.html#GstAllocator-struct">GstAllocator</a>.</p> 93</div> 94<div class="refsect1"> 95<a name="GstPhysMemoryAllocator.includes"></a><h2>Includes</h2> 96<pre class="synopsis">#include <gst/allocators/allocators.h> 97</pre> 98</div> 99<div class="refsect1"> 100<a name="GstPhysMemoryAllocator.description"></a><h2>Description</h2> 101</div> 102<div class="refsect1"> 103<a name="GstPhysMemoryAllocator.functions_details"></a><h2>Functions</h2> 104<div class="refsect2"> 105<a name="gst-is-phys-memory"></a><h3>gst_is_phys_memory ()</h3> 106<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 107gst_is_phys_memory (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a> *mem</code></em>);</pre> 108<div class="refsect3"> 109<a name="gst-is-phys-memory.parameters"></a><h4>Parameters</h4> 110<div class="informaltable"><table class="informaltable" width="100%" border="0"> 111<colgroup> 112<col width="150px" class="parameters_name"> 113<col class="parameters_description"> 114<col width="200px" class="parameters_annotations"> 115</colgroup> 116<tbody><tr> 117<td class="parameter_name"><p>mem</p></td> 118<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a></p></td> 119<td class="parameter_annotations"> </td> 120</tr></tbody> 121</table></div> 122</div> 123<div class="refsect3"> 124<a name="gst-is-phys-memory.returns"></a><h4>Returns</h4> 125<p> whether the memory at <em class="parameter"><code>mem</code></em> 126is backed by physical memory</p> 127</div> 128<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 129</div> 130<hr> 131<div class="refsect2"> 132<a name="gst-phys-memory-get-phys-addr"></a><h3>gst_phys_memory_get_phys_addr ()</h3> 133<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guintptr"><span class="returnvalue">guintptr</span></a> 134gst_phys_memory_get_phys_addr (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a> *mem</code></em>);</pre> 135<div class="refsect3"> 136<a name="gst-phys-memory-get-phys-addr.parameters"></a><h4>Parameters</h4> 137<div class="informaltable"><table class="informaltable" width="100%" border="0"> 138<colgroup> 139<col width="150px" class="parameters_name"> 140<col class="parameters_description"> 141<col width="200px" class="parameters_annotations"> 142</colgroup> 143<tbody><tr> 144<td class="parameter_name"><p>mem</p></td> 145<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a></p></td> 146<td class="parameter_annotations"> </td> 147</tr></tbody> 148</table></div> 149</div> 150<div class="refsect3"> 151<a name="gst-phys-memory-get-phys-addr.returns"></a><h4>Returns</h4> 152<p> Physical memory address that is backing <em class="parameter"><code>mem</code></em> 153, or 0 if none</p> 154</div> 155<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 156</div> 157</div> 158<div class="refsect1"> 159<a name="GstPhysMemoryAllocator.other_details"></a><h2>Types and Values</h2> 160<div class="refsect2"> 161<a name="GstPhysMemoryAllocator-struct"></a><h3>GstPhysMemoryAllocator</h3> 162<pre class="programlisting">typedef struct _GstPhysMemoryAllocator GstPhysMemoryAllocator;</pre> 163</div> 164<hr> 165<div class="refsect2"> 166<a name="GstPhysMemoryAllocatorInterface"></a><h3>struct GstPhysMemoryAllocatorInterface</h3> 167<pre class="programlisting">struct GstPhysMemoryAllocatorInterface { 168 guintptr (*get_phys_addr) (GstPhysMemoryAllocator * allocator, GstMemory * mem); 169}; 170</pre> 171<p>Marker interface for allocators with physical address backed memory</p> 172<div class="refsect3"> 173<a name="GstPhysMemoryAllocatorInterface.members"></a><h4>Members</h4> 174<div class="informaltable"><table class="informaltable" width="100%" border="0"> 175<colgroup> 176<col width="300px" class="struct_members_name"> 177<col class="struct_members_description"> 178<col width="200px" class="struct_members_annotations"> 179</colgroup> 180<tbody><tr> 181<td class="struct_member_name"><p><em class="structfield"><code><a name="GstPhysMemoryAllocatorInterface.get-phys-addr"></a>get_phys_addr</code></em> ()</p></td> 182<td class="struct_member_description"><p>Implementations shall return the physicall memory address 183that is backing the provided memory, or 0 if none.</p></td> 184<td class="struct_member_annotations"> </td> 185</tr></tbody> 186</table></div> 187</div> 188<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 189</div> 190</div> 191<div class="refsect1"> 192<a name="GstPhysMemoryAllocator.see-also"></a><h2>See Also</h2> 193<p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a></p> 194</div> 195</div> 196<div class="footer"> 197<hr>Generated by GTK-Doc V1.28</div> 198</body> 199</html>
