1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>drm_universal_plane_init</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="Linux DRM Developer's Guide"><link rel="up" href="drm-kms-init.html#idp1123898740" title="KMS API Functions"><link rel="prev" href="API-drm-encoder-cleanup.html" title="drm_encoder_cleanup"><link rel="next" href="API-drm-plane-init.html" title="drm_plane_init"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">drm_universal_plane_init</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-drm-encoder-cleanup.html">Prev</a>&#160;</td><th width="60%" align="center">KMS API Functions</th><td width="20%" align="right">&#160;<a accesskey="n" href="API-drm-plane-init.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-drm-universal-plane-init"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>drm_universal_plane_init &#8212; 
2     Initialize a new universal plane object
3 </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <b class="fsfunc">drm_universal_plane_init </b>(</code></td><td>struct drm_device * <var class="pdparam">dev</var>, </td></tr><tr><td>&#160;</td><td>struct drm_plane * <var class="pdparam">plane</var>, </td></tr><tr><td>&#160;</td><td>unsigned long <var class="pdparam">possible_crtcs</var>, </td></tr><tr><td>&#160;</td><td>const struct drm_plane_funcs * <var class="pdparam">funcs</var>, </td></tr><tr><td>&#160;</td><td>const uint32_t * <var class="pdparam">formats</var>, </td></tr><tr><td>&#160;</td><td>uint32_t <var class="pdparam">format_count</var>, </td></tr><tr><td>&#160;</td><td>enum drm_plane_type <var class="pdparam">type</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1"><a name="idp1124104940"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>dev</code></em></span></dt><dd><p>
4     DRM device
5    </p></dd><dt><span class="term"><em class="parameter"><code>plane</code></em></span></dt><dd><p>
6     plane object to init
7    </p></dd><dt><span class="term"><em class="parameter"><code>possible_crtcs</code></em></span></dt><dd><p>
8     bitmask of possible CRTCs
9    </p></dd><dt><span class="term"><em class="parameter"><code>funcs</code></em></span></dt><dd><p>
10     callbacks for the new plane
11    </p></dd><dt><span class="term"><em class="parameter"><code>formats</code></em></span></dt><dd><p>
12     array of supported formats (<code class="constant">DRM_FORMAT_</code>*)
13    </p></dd><dt><span class="term"><em class="parameter"><code>format_count</code></em></span></dt><dd><p>
14     number of elements in <em class="parameter"><code>formats</code></em>
15    </p></dd><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p>
16     type of plane (overlay, primary, cursor)
17    </p></dd></dl></div></div><div class="refsect1"><a name="idp1124113292"></a><h2>Description</h2><p>
18   Initializes a plane object of type <em class="parameter"><code>type</code></em>.
19</p></div><div class="refsect1"><a name="idp1124114276"></a><h2>Returns</h2><p>
20   Zero on success, error code on failure.
21</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-drm-encoder-cleanup.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="drm-kms-init.html#idp1123898740">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="API-drm-plane-init.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">drm_encoder_cleanup</span>&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;<span class="phrase">drm_plane_init</span></td></tr></table></div></body></html>
22