blob: 2799d6e2dc38f695183b4c442823adfdd2f01de3 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstGLMemoryEGL: GStreamer Bad Plugins 1.0 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Library Reference Manual">
<link rel="up" href="gl.html" title="OpenGL Helper Library">
<link rel="prev" href="gst-plugins-bad-libs-GstGLMemory.html" title="GstGLMemory">
<link rel="next" href="gst-plugins-bad-libs-gstglmemorypbo.html" title="GstGLMemoryPBO">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#gst-plugins-bad-libs-gstglmemoryegl.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="gl.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-libs-GstGLMemory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-bad-libs-gstglmemorypbo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-libs-gstglmemoryegl"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-libs-gstglmemoryegl.top_of_page"></a>GstGLMemoryEGL</span></h2>
<p>GstGLMemoryEGL — memory subclass for EGLImage's</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-gstglmemoryegl.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#gst-gl-memory-egl-init-once" title="gst_gl_memory_egl_init_once ()">gst_gl_memory_egl_init_once</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">EGLDisplay</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#gst-gl-memory-egl-get-display" title="gst_gl_memory_egl_get_display ()">gst_gl_memory_egl_get_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">EGLImageKHR</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#gst-gl-memory-egl-get-image" title="gst_gl_memory_egl_get_image ()">gst_gl_memory_egl_get_image</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GstVideoGLTextureOrientation</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#gst-gl-memory-egl-get-orientation" title="gst_gl_memory_egl_get_orientation ()">gst_gl_memory_egl_get_orientation</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#gst-is-gl-memory-egl" title="gst_is_gl_memory_egl ()">gst_is_gl_memory_egl</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-gstglmemoryegl.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGLAllocator" title="GstGLMemoryEGLAllocator">GstGLMemoryEGLAllocator</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGLAllocatorClass" title="GstGLMemoryEGLAllocatorClass">GstGLMemoryEGLAllocatorClass</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GST-GL-MEMORY-EGL-ALLOCATOR-NAME:CAPS" title="GST_GL_MEMORY_EGL_ALLOCATOR_NAME">GST_GL_MEMORY_EGL_ALLOCATOR_NAME</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGL" title="GstGLMemoryEGL">GstGLMemoryEGL</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-gstglmemoryegl.description"></a><h2>Description</h2>
<p><a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGL" title="GstGLMemoryEGL"><span class="type">GstGLMemoryEGL</span></a> is created or wrapped through <a class="link" href="gst-plugins-bad-libs-gstglbasememory.html#gst-gl-base-memory-alloc" title="gst_gl_base_memory_alloc ()"><code class="function">gst_gl_base_memory_alloc()</code></a>
with <a class="link" href="gst-plugins-bad-libs-GstGLMemory.html#GstGLVideoAllocationParams" title="struct GstGLVideoAllocationParams"><span class="type">GstGLVideoAllocationParams</span></a>.</p>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-gstglmemoryegl.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-gl-memory-egl-init-once"></a><h3>gst_gl_memory_egl_init_once ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_gl_memory_egl_init_once (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Initializes the GL Memory allocator. It is safe to call this function
multiple times. This must be called before any other GstGLMemoryEGL operation.</p>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-memory-egl-get-display"></a><h3>gst_gl_memory_egl_get_display ()</h3>
<pre class="programlisting"><span class="returnvalue">EGLDisplay</span>
gst_gl_memory_egl_get_display (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGL" title="GstGLMemoryEGL"><span class="type">GstGLMemoryEGL</span></a> *mem</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-memory-egl-get-display.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mem</p></td>
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGL" title="GstGLMemoryEGL"><span class="type">GstGLMemoryEGL</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-memory-egl-get-display.returns"></a><h4>Returns</h4>
<p> The EGLDisplay <em class="parameter"><code>mem</code></em>
is associated with</p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-memory-egl-get-image"></a><h3>gst_gl_memory_egl_get_image ()</h3>
<pre class="programlisting"><span class="returnvalue">EGLImageKHR</span>
gst_gl_memory_egl_get_image (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGL" title="GstGLMemoryEGL"><span class="type">GstGLMemoryEGL</span></a> *mem</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-memory-egl-get-image.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mem</p></td>
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGL" title="GstGLMemoryEGL"><span class="type">GstGLMemoryEGL</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-memory-egl-get-image.returns"></a><h4>Returns</h4>
<p> The EGLImage held by <em class="parameter"><code>mem</code></em>
</p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-memory-egl-get-orientation"></a><h3>gst_gl_memory_egl_get_orientation ()</h3>
<pre class="programlisting"><span class="returnvalue">GstVideoGLTextureOrientation</span>
gst_gl_memory_egl_get_orientation (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGL" title="GstGLMemoryEGL"><span class="type">GstGLMemoryEGL</span></a> *mem</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-memory-egl-get-orientation.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mem</p></td>
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGL" title="GstGLMemoryEGL"><span class="type">GstGLMemoryEGL</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-memory-egl-get-orientation.returns"></a><h4>Returns</h4>
<p> The orientation of <em class="parameter"><code>mem</code></em>
</p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-is-gl-memory-egl"></a><h3>gst_is_gl_memory_egl ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gst_is_gl_memory_egl (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a> *mem</code></em>);</pre>
<div class="refsect3">
<a name="gst-is-gl-memory-egl.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mem</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a> to test</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-is-gl-memory-egl.returns"></a><h4>Returns</h4>
<p> whether <em class="parameter"><code>mem</code></em>
is a <a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGL" title="GstGLMemoryEGL"><span class="type">GstGLMemoryEGL</span></a></p>
</div>
<p class="since">Since: 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-gstglmemoryegl.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstGLMemoryEGLAllocator"></a><h3>GstGLMemoryEGLAllocator</h3>
<pre class="programlisting">typedef struct {
} GstGLMemoryEGLAllocator;
</pre>
<p>Opaque <a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGLAllocator" title="GstGLMemoryEGLAllocator"><span class="type">GstGLMemoryEGLAllocator</span></a> struct</p>
</div>
<hr>
<div class="refsect2">
<a name="GstGLMemoryEGLAllocatorClass"></a><h3>GstGLMemoryEGLAllocatorClass</h3>
<pre class="programlisting">typedef struct {
} GstGLMemoryEGLAllocatorClass;
</pre>
<p>The <a class="link" href="gst-plugins-bad-libs-gstglmemoryegl.html#GstGLMemoryEGLAllocatorClass" title="GstGLMemoryEGLAllocatorClass"><span class="type">GstGLMemoryEGLAllocatorClass</span></a> only contains private data</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-GL-MEMORY-EGL-ALLOCATOR-NAME:CAPS"></a><h3>GST_GL_MEMORY_EGL_ALLOCATOR_NAME</h3>
<pre class="programlisting">#define GST_GL_MEMORY_EGL_ALLOCATOR_NAME "GLMemoryEGL"
</pre>
<p>The name of the GL Memory EGL allocator</p>
</div>
<hr>
<div class="refsect2">
<a name="GstGLMemoryEGL"></a><h3>GstGLMemoryEGL</h3>
<pre class="programlisting">typedef struct {
} GstGLMemoryEGL;
</pre>
<p>Private instance</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-gstglmemoryegl.see-also"></a><h2>See Also</h2>
<p><a class="link" href="gst-plugins-bad-libs-GstGLMemory.html#GstGLMemory" title="GstGLMemory"><span class="type">GstGLMemory</span></a>, <span class="type">GstGLAllocator</span>, <a class="link" href="GstGLBufferPool.html" title="GstGLBufferPool"><span class="type">GstGLBufferPool</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>