<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/display/framebuffer.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber"> v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_2b5b553157a94351151a308cd797ea35.html">display</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">framebuffer.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="structFramebuffer.html" title="Framebuffer structure.">Framebuffer</a> wrapper object, providing support for software rendered graphics.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "../nvidia/map.h"</code><br />
<code>#include "<a class="el" href="native__window_8h_source.html">native_window.h</a>"</code><br />
</div>
<p><a href="framebuffer_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structFramebuffer.html">Framebuffer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structFramebuffer.html" title="Framebuffer structure.">Framebuffer</a> structure. <a href="structFramebuffer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ada252b0d1c54c165a668d3bb1bee06c1" id="r_ada252b0d1c54c165a668d3bb1bee06c1"><td class="memItemLeft" align="right" valign="top"><a id="ada252b0d1c54c165a668d3bb1bee06c1" name="ada252b0d1c54c165a668d3bb1bee06c1"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RGBA8</b>(r, g, b, a)   (((r)&0xff)|(((g)&0xff)<<8)|(((b)&0xff)<<16)|(((a)&0xff)<<24))</td></tr>
<tr class="memdesc:ada252b0d1c54c165a668d3bb1bee06c1"><td class="mdescLeft"> </td><td class="mdescRight">Converts red/green/blue/alpha components to packed RGBA8 (i.e. PIXEL_FORMAT_RGBA_8888). <br /></td></tr>
<tr class="separator:ada252b0d1c54c165a668d3bb1bee06c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ed799d2d34a926b6eb4126eebac974f" id="r_a2ed799d2d34a926b6eb4126eebac974f"><td class="memItemLeft" align="right" valign="top"><a id="a2ed799d2d34a926b6eb4126eebac974f" name="a2ed799d2d34a926b6eb4126eebac974f"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RGBA8_MAXALPHA</b>(r, g, b)   <a class="el" href="framebuffer_8h.html#ada252b0d1c54c165a668d3bb1bee06c1">RGBA8</a>((r),(g),(b),0xff)</td></tr>
<tr class="memdesc:a2ed799d2d34a926b6eb4126eebac974f"><td class="mdescLeft"> </td><td class="mdescRight">Same as <a class="el" href="framebuffer_8h.html#ada252b0d1c54c165a668d3bb1bee06c1">RGBA8</a> except with alpha=0xff. <br /></td></tr>
<tr class="separator:a2ed799d2d34a926b6eb4126eebac974f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2526aa11f61dd5b7c0fc7b609e92165a" id="r_a2526aa11f61dd5b7c0fc7b609e92165a"><td class="memItemLeft" align="right" valign="top"><a id="a2526aa11f61dd5b7c0fc7b609e92165a" name="a2526aa11f61dd5b7c0fc7b609e92165a"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RGBX8</b>(r, g, b)   <a class="el" href="framebuffer_8h.html#ada252b0d1c54c165a668d3bb1bee06c1">RGBA8</a>((r),(g),(b),0)</td></tr>
<tr class="memdesc:a2526aa11f61dd5b7c0fc7b609e92165a"><td class="mdescLeft"> </td><td class="mdescRight">Converts red/green/blue to packed RGBX8 (i.e. PIXEL_FORMAT_RGBX_8888). <br /></td></tr>
<tr class="separator:a2526aa11f61dd5b7c0fc7b609e92165a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2ed36b98652f54ec3e1fdc8a31c8b13" id="r_ab2ed36b98652f54ec3e1fdc8a31c8b13"><td class="memItemLeft" align="right" valign="top"><a id="ab2ed36b98652f54ec3e1fdc8a31c8b13" name="ab2ed36b98652f54ec3e1fdc8a31c8b13"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RGB565</b>(r, g, b)   (((b)&0x1f)|(((g)&0x3f)<<5)|(((r)&0x1f)<<11))</td></tr>
<tr class="memdesc:ab2ed36b98652f54ec3e1fdc8a31c8b13"><td class="mdescLeft"> </td><td class="mdescRight">Converts red/green/blue components to packed RGB565 (i.e. PIXEL_FORMAT_RGB_565) <br /></td></tr>
<tr class="separator:ab2ed36b98652f54ec3e1fdc8a31c8b13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88522287090978d8a811339a0c11eada" id="r_a88522287090978d8a811339a0c11eada"><td class="memItemLeft" align="right" valign="top"><a id="a88522287090978d8a811339a0c11eada" name="a88522287090978d8a811339a0c11eada"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RGB565_FROM_RGB8</b>(r, g, b)   <a class="el" href="framebuffer_8h.html#ab2ed36b98652f54ec3e1fdc8a31c8b13">RGB565</a>((r)>>3,(g)>>2,(b)>>3)</td></tr>
<tr class="memdesc:a88522287090978d8a811339a0c11eada"><td class="mdescLeft"> </td><td class="mdescRight">Same as <a class="el" href="framebuffer_8h.html#ab2ed36b98652f54ec3e1fdc8a31c8b13">RGB565</a> but accepting 8-bit components as input instead. <br /></td></tr>
<tr class="separator:a88522287090978d8a811339a0c11eada"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1489caec0aacfac8056b3cf0dfc8104e" id="r_a1489caec0aacfac8056b3cf0dfc8104e"><td class="memItemLeft" align="right" valign="top"><a id="a1489caec0aacfac8056b3cf0dfc8104e" name="a1489caec0aacfac8056b3cf0dfc8104e"></a>
#define </td><td class="memItemRight" valign="bottom"><b>BGRA8</b>(r, g, b, a)   <a class="el" href="framebuffer_8h.html#ada252b0d1c54c165a668d3bb1bee06c1">RGBA8</a>((b),(g),(r),(a))</td></tr>
<tr class="memdesc:a1489caec0aacfac8056b3cf0dfc8104e"><td class="mdescLeft"> </td><td class="mdescRight">Converts red/green/blue/alpha components to packed BGR8 (i.e. PIXEL_FORMAT_BGRA_8888). <br /></td></tr>
<tr class="separator:a1489caec0aacfac8056b3cf0dfc8104e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a105c506747ad6014c81bac90d74bec" id="r_a3a105c506747ad6014c81bac90d74bec"><td class="memItemLeft" align="right" valign="top"><a id="a3a105c506747ad6014c81bac90d74bec" name="a3a105c506747ad6014c81bac90d74bec"></a>
#define </td><td class="memItemRight" valign="bottom"><b>BGRA8_MAXALPHA</b>(r, g, b)   <a class="el" href="framebuffer_8h.html#ada252b0d1c54c165a668d3bb1bee06c1">RGBA8</a>((b),(g),(r),0xff)</td></tr>
<tr class="memdesc:a3a105c506747ad6014c81bac90d74bec"><td class="mdescLeft"> </td><td class="mdescRight">Same as <a class="el" href="framebuffer_8h.html#a1489caec0aacfac8056b3cf0dfc8104e">BGRA8</a> except with alpha=0xff. <br /></td></tr>
<tr class="separator:a3a105c506747ad6014c81bac90d74bec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8310669d74ada6b7376bd0f54c4860e0" id="r_a8310669d74ada6b7376bd0f54c4860e0"><td class="memItemLeft" align="right" valign="top"><a id="a8310669d74ada6b7376bd0f54c4860e0" name="a8310669d74ada6b7376bd0f54c4860e0"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RGBA4</b>(r, g, b, a)   (((r)&0xf)|(((g)&0xf)<<4)|(((b)&0xf)<<8)|(((a)&0xf)<<12))</td></tr>
<tr class="memdesc:a8310669d74ada6b7376bd0f54c4860e0"><td class="mdescLeft"> </td><td class="mdescRight">Converts red/green/blue/alpha components to packed RGBA4 (i.e. PIXEL_FORMAT_RGBA_4444). <br /></td></tr>
<tr class="separator:a8310669d74ada6b7376bd0f54c4860e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06dd70549c1855b1f443d9a80d5d2422" id="r_a06dd70549c1855b1f443d9a80d5d2422"><td class="memItemLeft" align="right" valign="top"><a id="a06dd70549c1855b1f443d9a80d5d2422" name="a06dd70549c1855b1f443d9a80d5d2422"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RGBA4_MAXALPHA</b>(r, g, b)   <a class="el" href="framebuffer_8h.html#a8310669d74ada6b7376bd0f54c4860e0">RGBA4</a>((r),(g),(b),0xf)</td></tr>
<tr class="memdesc:a06dd70549c1855b1f443d9a80d5d2422"><td class="mdescLeft"> </td><td class="mdescRight">Same as <a class="el" href="framebuffer_8h.html#a8310669d74ada6b7376bd0f54c4860e0">RGBA4</a> except with alpha=0xf. <br /></td></tr>
<tr class="separator:a06dd70549c1855b1f443d9a80d5d2422"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43a178866fe21b617fc69cb22d1a141d" id="r_a43a178866fe21b617fc69cb22d1a141d"><td class="memItemLeft" align="right" valign="top"><a id="a43a178866fe21b617fc69cb22d1a141d" name="a43a178866fe21b617fc69cb22d1a141d"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RGBA4_FROM_RGBA8</b>(r, g, b, a)   <a class="el" href="framebuffer_8h.html#a8310669d74ada6b7376bd0f54c4860e0">RGBA4</a>((r)>>4,(g)>>4,(b)>>4,(a)>>4)</td></tr>
<tr class="memdesc:a43a178866fe21b617fc69cb22d1a141d"><td class="mdescLeft"> </td><td class="mdescRight">Same as <a class="el" href="framebuffer_8h.html#a8310669d74ada6b7376bd0f54c4860e0">RGBA4</a> but accepting 8-bit components as input instead. <br /></td></tr>
<tr class="separator:a43a178866fe21b617fc69cb22d1a141d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8792b9073ff927b30e64afba9d5d8aa" id="r_ad8792b9073ff927b30e64afba9d5d8aa"><td class="memItemLeft" align="right" valign="top"><a id="ad8792b9073ff927b30e64afba9d5d8aa" name="ad8792b9073ff927b30e64afba9d5d8aa"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RGBA4_FROM_RGBA8_MAXALPHA</b>(r, g, b)   <a class="el" href="framebuffer_8h.html#a06dd70549c1855b1f443d9a80d5d2422">RGBA4_MAXALPHA</a>((r)>>4,(g)>>4,(b)>>4)</td></tr>
<tr class="memdesc:ad8792b9073ff927b30e64afba9d5d8aa"><td class="mdescLeft"> </td><td class="mdescRight">Same as <a class="el" href="framebuffer_8h.html#a06dd70549c1855b1f443d9a80d5d2422">RGBA4_MAXALPHA</a> except with alpha=0xff. <br /></td></tr>
<tr class="separator:ad8792b9073ff927b30e64afba9d5d8aa"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a39d6330d4aa0a6cfecfb15f57d08209e" id="r_a39d6330d4aa0a6cfecfb15f57d08209e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="framebuffer_8h.html#a39d6330d4aa0a6cfecfb15f57d08209e">framebufferCreate</a> (<a class="el" href="structFramebuffer.html">Framebuffer</a> *fb, <a class="el" href="structNWindow.html">NWindow</a> *win, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> width, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> height, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> format, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> num_fbs)</td></tr>
<tr class="memdesc:a39d6330d4aa0a6cfecfb15f57d08209e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="structFramebuffer.html">Framebuffer</a> object. <br /></td></tr>
<tr class="separator:a39d6330d4aa0a6cfecfb15f57d08209e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0cd755df16aaa629d659da93961a859" id="r_ab0cd755df16aaa629d659da93961a859"><td class="memItemLeft" align="right" valign="top"><a id="ab0cd755df16aaa629d659da93961a859" name="ab0cd755df16aaa629d659da93961a859"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><b>framebufferMakeLinear</b> (<a class="el" href="structFramebuffer.html">Framebuffer</a> *fb)</td></tr>
<tr class="memdesc:ab0cd755df16aaa629d659da93961a859"><td class="mdescLeft"> </td><td class="mdescRight">Enables linear framebuffer mode in a <a class="el" href="structFramebuffer.html">Framebuffer</a>, allocating a shadow buffer in the process. <br /></td></tr>
<tr class="separator:ab0cd755df16aaa629d659da93961a859"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0c4da5d2f1b0a15fd25a8a48debf630" id="r_af0c4da5d2f1b0a15fd25a8a48debf630"><td class="memItemLeft" align="right" valign="top"><a id="af0c4da5d2f1b0a15fd25a8a48debf630" name="af0c4da5d2f1b0a15fd25a8a48debf630"></a>
void </td><td class="memItemRight" valign="bottom"><b>framebufferClose</b> (<a class="el" href="structFramebuffer.html">Framebuffer</a> *fb)</td></tr>
<tr class="memdesc:af0c4da5d2f1b0a15fd25a8a48debf630"><td class="mdescLeft"> </td><td class="mdescRight">Closes a <a class="el" href="structFramebuffer.html">Framebuffer</a> object, freeing all resources associated with it. <br /></td></tr>
<tr class="separator:af0c4da5d2f1b0a15fd25a8a48debf630"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8362196eab1229e7e6a72c6b790fdd4" id="r_ad8362196eab1229e7e6a72c6b790fdd4"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="framebuffer_8h.html#ad8362196eab1229e7e6a72c6b790fdd4">framebufferBegin</a> (<a class="el" href="structFramebuffer.html">Framebuffer</a> *fb, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *out_stride)</td></tr>
<tr class="memdesc:ad8362196eab1229e7e6a72c6b790fdd4"><td class="mdescLeft"> </td><td class="mdescRight">Begins rendering a frame in a <a class="el" href="structFramebuffer.html">Framebuffer</a>. <br /></td></tr>
<tr class="separator:ad8362196eab1229e7e6a72c6b790fdd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3e68013f6c5d800dd9395bb825edf59" id="r_ae3e68013f6c5d800dd9395bb825edf59"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="framebuffer_8h.html#ae3e68013f6c5d800dd9395bb825edf59">framebufferEnd</a> (<a class="el" href="structFramebuffer.html">Framebuffer</a> *fb)</td></tr>
<tr class="memdesc:ae3e68013f6c5d800dd9395bb825edf59"><td class="mdescLeft"> </td><td class="mdescRight">Finishes rendering a frame in a <a class="el" href="structFramebuffer.html">Framebuffer</a>. <br /></td></tr>
<tr class="separator:ae3e68013f6c5d800dd9395bb825edf59"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="structFramebuffer.html" title="Framebuffer structure.">Framebuffer</a> wrapper object, providing support for software rendered graphics. </p>
<dl class="section author"><dt>Author</dt><dd>fincs </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ad8362196eab1229e7e6a72c6b790fdd4" name="ad8362196eab1229e7e6a72c6b790fdd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8362196eab1229e7e6a72c6b790fdd4">◆ </a></span>framebufferBegin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * framebufferBegin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFramebuffer.html">Framebuffer</a> * </td>
<td class="paramname"><em>fb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
<td class="paramname"><em>out_stride</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Begins rendering a frame in a <a class="el" href="structFramebuffer.html">Framebuffer</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fb</td><td>Pointer to <a class="el" href="structFramebuffer.html">Framebuffer</a> structure. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out_stride</td><td>Output variable containing the distance in bytes between rows of pixels in memory. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to buffer to which new graphics data should be written to. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>When this function is called, a buffer will be dequeued from the corresponding <a class="el" href="structNWindow.html">NWindow</a>. </dd>
<dd>
This function will return pointers to different buffers, depending on the number of buffers it was initialized with. </dd>
<dd>
If <a class="el" href="framebuffer_8h.html#ab0cd755df16aaa629d659da93961a859">framebufferMakeLinear</a> was used, this function will instead return a pointer to the shadow linear buffer. In this case, the offset of a pixel is <code>y</code> * <code>out_stride</code> + <code>x</code> * <code>bytes_per_pixel</code>. </dd>
<dd>
Each call to <a class="el" href="framebuffer_8h.html#ad8362196eab1229e7e6a72c6b790fdd4">framebufferBegin</a> must be paired with a <a class="el" href="framebuffer_8h.html#ae3e68013f6c5d800dd9395bb825edf59">framebufferEnd</a> call. </dd></dl>
</div>
</div>
<a id="a39d6330d4aa0a6cfecfb15f57d08209e" name="a39d6330d4aa0a6cfecfb15f57d08209e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39d6330d4aa0a6cfecfb15f57d08209e">◆ </a></span>framebufferCreate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> framebufferCreate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFramebuffer.html">Framebuffer</a> * </td>
<td class="paramname"><em>fb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structNWindow.html">NWindow</a> * </td>
<td class="paramname"><em>win</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
<td class="paramname"><em>num_fbs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="structFramebuffer.html">Framebuffer</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">fb</td><td>Output <a class="el" href="structFramebuffer.html">Framebuffer</a> structure. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">win</td><td>Pointer to the <a class="el" href="structNWindow.html">NWindow</a> to which the <a class="el" href="structFramebuffer.html">Framebuffer</a> will be registered. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Desired width of the framebuffer (usually 1280). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Desired height of the framebuffer (usually 720). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>Desired pixel format (see PIXEL_FORMAT_* enum). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num_fbs</td><td>Number of buffers to create. Pass 1 for single-buffering, 2 for double-buffering or 3 for triple-buffering. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="structFramebuffer.html" title="Framebuffer structure.">Framebuffer</a> images are stored in Tegra block linear format with 16Bx2 sector ordering, read TRM chapter 20.1 for more details. In order to use regular linear layout, consider calling <a class="el" href="framebuffer_8h.html#ab0cd755df16aaa629d659da93961a859">framebufferMakeLinear</a> after the <a class="el" href="structFramebuffer.html">Framebuffer</a> object is created. </dd>
<dd>
Presently, only the following pixel formats are supported: PIXEL_FORMAT_RGBA_8888 PIXEL_FORMAT_RGBX_8888 PIXEL_FORMAT_RGB_565 PIXEL_FORMAT_BGRA_8888 PIXEL_FORMAT_RGBA_4444 </dd></dl>
</div>
</div>
<a id="ae3e68013f6c5d800dd9395bb825edf59" name="ae3e68013f6c5d800dd9395bb825edf59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3e68013f6c5d800dd9395bb825edf59">◆ </a></span>framebufferEnd()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void framebufferEnd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFramebuffer.html">Framebuffer</a> * </td>
<td class="paramname"><em>fb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finishes rendering a frame in a <a class="el" href="structFramebuffer.html">Framebuffer</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fb</td><td>Pointer to <a class="el" href="structFramebuffer.html">Framebuffer</a> structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>When this function is called, the written image data will be flushed and queued (presented) in the corresponding <a class="el" href="structNWindow.html">NWindow</a>. </dd>
<dd>
If <a class="el" href="framebuffer_8h.html#ab0cd755df16aaa629d659da93961a859">framebufferMakeLinear</a> was used, this function will copy the image from the shadow linear buffer to the actual framebuffer, converting it in the process to the layout expected by the compositor. </dd>
<dd>
Each call to <a class="el" href="framebuffer_8h.html#ad8362196eab1229e7e6a72c6b790fdd4">framebufferBegin</a> must be paired with a <a class="el" href="framebuffer_8h.html#ae3e68013f6c5d800dd9395bb825edf59">framebufferEnd</a> call. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>