Files
moslab-code/doc/source/html/goos_8h.html
2025-09-12 15:55:45 +02:00

181 lines
16 KiB
HTML

<!-- HTML header for doxygen 1.9.1-->
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.15.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>L4Re Operating System Framework: l4/re/c/video/goos.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="l4re-awesome.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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">L4Re Operating System Framework
</div>
<div id="projectbrief">Interface and Usage Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('goos_8h.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">goos.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="compiler_8h_source.html">l4/sys/compiler.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="l4_2sys_2types_8h_source.html">l4/sys/types.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="dataspace_8h_source.html">l4/re/c/dataspace.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="colors_8h_source.html">l4/re/c/video/colors.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="view_8h_source.html">l4/re/c/video/view.h</a>&gt;</code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Include dependency graph for goos.h:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="goos_8h__incl.svg" width="856" height="476"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><div class="textblock"><div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="goos_8h__dep__incl.svg" width="160" height="124"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
<p><a href="goos_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:l4re_5Fvideo_5Fgoos_5Finfo_5Ft" id="r_l4re_5Fvideo_5Fgoos_5Finfo_5Ft"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structl4re__video__goos__info__t.html">l4re_video_goos_info_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Goos information structure. <a href="structl4re__video__goos__info__t.html#details">More...</a><br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga8a799999dce09cc83c5c05aabd77ab26" id="r_ga8a799999dce09cc83c5c05aabd77ab26"><td class="memItemLeft" align="right" valign="top">
typedef <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>l4re_video_goos_t</b></td></tr>
<tr class="memdesc:ga8a799999dce09cc83c5c05aabd77ab26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Goos object type. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-enum-members" class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga0df3b9a30dd6be3c6b6d624879809c36" id="r_ga0df3b9a30dd6be3c6b6d624879809c36"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__video.html#ga0df3b9a30dd6be3c6b6d624879809c36">l4re_video_goos_info_flags_t</a> { <a class="el" href="group__api__l4re__c__video.html#gga0df3b9a30dd6be3c6b6d624879809c36abeeb2e624b50a8a2a05d5398887069cb">F_l4re_video_goos_auto_refresh</a> = 0x01
, <a class="el" href="group__api__l4re__c__video.html#gga0df3b9a30dd6be3c6b6d624879809c36a871e9e4d60a75b7964f5ebbe5c75d721">F_l4re_video_goos_pointer</a> = 0x02
, <a class="el" href="group__api__l4re__c__video.html#gga0df3b9a30dd6be3c6b6d624879809c36aa34f226a490521bf53681727317d5dbf">F_l4re_video_goos_dynamic_views</a> = 0x04
, <a class="el" href="group__api__l4re__c__video.html#gga0df3b9a30dd6be3c6b6d624879809c36ab114d4df21c14cf5b42bff4225823648">F_l4re_video_goos_dynamic_buffers</a> = 0x08
}</td></tr>
<tr class="memdesc:ga0df3b9a30dd6be3c6b6d624879809c36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags of information on the goos. <a href="group__api__l4re__c__video.html#ga0df3b9a30dd6be3c6b6d624879809c36">More...</a><br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga91b1f803c0142a0c22660c0118afe74b" id="r_ga91b1f803c0142a0c22660c0118afe74b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__video.html#ga91b1f803c0142a0c22660c0118afe74b">l4re_video_goos_info</a> (<a class="el" href="group__api__l4re__c__video.html#ga8a799999dce09cc83c5c05aabd77ab26">l4re_video_goos_t</a> goos, <a class="el" href="structl4re__video__goos__info__t.html">l4re_video_goos_info_t</a> *ginfo) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga91b1f803c0142a0c22660c0118afe74b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get information on a goos. <br /></td></tr>
<tr class="memitem:ga80daa4f828757bc0a50cfb364bde1d25" id="r_ga80daa4f828757bc0a50cfb364bde1d25"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__video.html#ga80daa4f828757bc0a50cfb364bde1d25">l4re_video_goos_refresh</a> (<a class="el" href="group__api__l4re__c__video.html#ga8a799999dce09cc83c5c05aabd77ab26">l4re_video_goos_t</a> goos, int x, int y, int w, int h) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga80daa4f828757bc0a50cfb364bde1d25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush a rectangle of pixels of the goos screen. <br /></td></tr>
<tr class="memitem:gaf2fc95ab37fc7f17f431f66ced433563" id="r_gaf2fc95ab37fc7f17f431f66ced433563"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__video.html#gaf2fc95ab37fc7f17f431f66ced433563">l4re_video_goos_create_buffer</a> (<a class="el" href="group__api__l4re__c__video.html#ga8a799999dce09cc83c5c05aabd77ab26">l4re_video_goos_t</a> goos, unsigned long size, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> buffer) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gaf2fc95ab37fc7f17f431f66ced433563"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new buffer (memory buffer) for pixel data. <br /></td></tr>
<tr class="memitem:ga31fbbdcd4c30a36c6d47b33984e87dea" id="r_ga31fbbdcd4c30a36c6d47b33984e87dea"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__video.html#ga31fbbdcd4c30a36c6d47b33984e87dea">l4re_video_goos_delete_buffer</a> (<a class="el" href="group__api__l4re__c__video.html#ga8a799999dce09cc83c5c05aabd77ab26">l4re_video_goos_t</a> goos, unsigned idx) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga31fbbdcd4c30a36c6d47b33984e87dea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a pixel buffer. <br /></td></tr>
<tr class="memitem:ga958f66cce94ec77848a1083fd7890947" id="r_ga958f66cce94ec77848a1083fd7890947"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__video.html#ga958f66cce94ec77848a1083fd7890947">l4re_video_goos_get_static_buffer</a> (<a class="el" href="group__api__l4re__c__video.html#ga8a799999dce09cc83c5c05aabd77ab26">l4re_video_goos_t</a> goos, unsigned idx, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> buffer) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga958f66cce94ec77848a1083fd7890947"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the data-space capability of the static pixel buffer. <br /></td></tr>
<tr class="memitem:gab1d2b2390bea358007e19fb9a6571f52" id="r_gab1d2b2390bea358007e19fb9a6571f52"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__video.html#gab1d2b2390bea358007e19fb9a6571f52">l4re_video_goos_create_view</a> (<a class="el" href="group__api__l4re__c__video.html#ga8a799999dce09cc83c5c05aabd77ab26">l4re_video_goos_t</a> goos, <a class="el" href="structl4re__video__view__t.html">l4re_video_view_t</a> *view) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gab1d2b2390bea358007e19fb9a6571f52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new view (. <br /></td></tr>
<tr class="memitem:gacc404442cda24ddf6d58ebbc2bed6ba5" id="r_gacc404442cda24ddf6d58ebbc2bed6ba5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__video.html#gacc404442cda24ddf6d58ebbc2bed6ba5">l4re_video_goos_delete_view</a> (<a class="el" href="group__api__l4re__c__video.html#ga8a799999dce09cc83c5c05aabd77ab26">l4re_video_goos_t</a> goos, <a class="el" href="structl4re__video__view__t.html">l4re_video_view_t</a> *view) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gacc404442cda24ddf6d58ebbc2bed6ba5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a view. <br /></td></tr>
<tr class="memitem:gaa75df193837d586ec332cf8f88f910c7" id="r_gaa75df193837d586ec332cf8f88f910c7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__video.html#gaa75df193837d586ec332cf8f88f910c7">l4re_video_goos_get_view</a> (<a class="el" href="group__api__l4re__c__video.html#ga8a799999dce09cc83c5c05aabd77ab26">l4re_video_goos_t</a> goos, unsigned idx, <a class="el" href="structl4re__video__view__t.html">l4re_video_view_t</a> *view) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gaa75df193837d586ec332cf8f88f910c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a view for the given index. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section note"><dt>Note</dt><dd>The C interface of L4Re::Video does <em>NOT</em> reflect the full C++ interface on purpose. Use the C++ where possible. </dd></dl>
<p class="definition">Definition in file <a class="el" href="goos_8h_source.html">goos.h</a>.</p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>l4</b></li><li class="navelem"><b>re</b></li><li class="navelem"><b>c</b></li><li class="navelem"><b>video</b></li><li class="navelem"><a href="goos_8h.html">goos.h</a></li>
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
</ul>
</div>
</body>
</html>