📄 group__nanox__region.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>Nano-X region API.</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="pages.html">Related Pages</a> </center><hr><h1>Nano-X region API.<br><small>[<a class="el" href="group__nanox.html">Nano-X public API</a>]</small></h1>Functions for handling clipping regions - these are used for clipping drawing, and for non-rectangular windows. <a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Functions</h2></td></tr><tr><td nowrap align=right valign=top>GR_REGION_ID </td><td valign=bottom><a class="el" href="group__nanox__region.html#a0">GrNewRegion</a> (void)</td></tr><tr><td> </td><td><em class="mdesc">Creates a new region structure.</em> <a href="#a0"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__nanox__region.html#a1">GrDestroyRegion</a> (GR_REGION_ID region)</td></tr><tr><td> </td><td><em class="mdesc">Destroys a region structure.</em> <a href="#a1"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__nanox__region.html#a2">GrUnionRectWithRegion</a> (GR_REGION_ID region, <a class="el" href="structGR__RECT.html">GR_RECT</a> *rect)</td></tr><tr><td> </td><td><em class="mdesc">Makes a union of the specified region and the specified rectangle.</em> <a href="#a2"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__nanox__region.html#a3">GrUnionRegion</a> (GR_REGION_ID dst_rgn, GR_REGION_ID src_rgn1, GR_REGION_ID src_rgn2)</td></tr><tr><td> </td><td><em class="mdesc">Makes a union of two regions.</em> <a href="#a3"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__nanox__region.html#a4">GrSubtractRegion</a> (GR_REGION_ID dst_rgn, GR_REGION_ID src_rgn1, GR_REGION_ID src_rgn2)</td></tr><tr><td> </td><td><em class="mdesc">Subtracts the second source region from the first source region and places the result in the specified destination region.</em> <a href="#a4"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__nanox__region.html#a5">GrXorRegion</a> (GR_REGION_ID dst_rgn, GR_REGION_ID src_rgn1, GR_REGION_ID src_rgn2)</td></tr><tr><td> </td><td><em class="mdesc">Performs a logical exclusive OR operation on the specified source regions and places the result in the destination region.</em> <a href="#a5"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__nanox__region.html#a6">GrIntersectRegion</a> (GR_REGION_ID dst_rgn, GR_REGION_ID src_rgn1, GR_REGION_ID src_rgn2)</td></tr><tr><td> </td><td><em class="mdesc">Calculates the intersection of the two specified source regions and places the result in the specified destination region.</em> <a href="#a6"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__nanox__region.html#a7">GrSetGCRegion</a> (GR_GC_ID gc, GR_REGION_ID region)</td></tr><tr><td> </td><td><em class="mdesc">Sets the clip mask of the specified graphics context to the specified region.</em> <a href="#a7"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>GR_BOOL </td><td valign=bottom><a class="el" href="group__nanox__region.html#a8">GrPointInRegion</a> (GR_REGION_ID region, GR_COORD x, GR_COORD y)</td></tr><tr><td> </td><td><em class="mdesc">Tests whether the specified point is within the specified region, and then returns either True or False depending on the result.</em> <a href="#a8"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__nanox__region.html#a9">GrRectInRegion</a> (GR_REGION_ID region, GR_COORD x, GR_COORD y, GR_COORD w, GR_COORD h)</td></tr><tr><td> </td><td><em class="mdesc">Tests whether the specified rectangle is contained within the specified region.</em> <a href="#a9"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>GR_BOOL </td><td valign=bottom><a class="el" href="group__nanox__region.html#a10">GrEmptyRegion</a> (GR_REGION_ID region)</td></tr><tr><td> </td><td><em class="mdesc">Determines whether the specified region is empty.</em> <a href="#a10"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>GR_BOOL </td><td valign=bottom><a class="el" href="group__nanox__region.html#a11">GrEqualRegion</a> (GR_REGION_ID rgn1, GR_REGION_ID rgn2)</td></tr><tr><td> </td><td><em class="mdesc">Determines whether the specified regions are identical, and returns GR_TRUE if it is, or GR_FALSE otherwise.</em> <a href="#a11"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__nanox__region.html#a12">GrOffsetRegion</a> (GR_REGION_ID region, GR_SIZE dx, GR_SIZE dy)</td></tr><tr><td> </td><td><em class="mdesc">Offsets the specified region by the specified distance.</em> <a href="#a12"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__nanox__region.html#a13">GrGetRegionBox</a> (GR_REGION_ID region, <a class="el" href="structGR__RECT.html">GR_RECT</a> *rect)</td></tr><tr><td> </td><td><em class="mdesc">Fills in the specified rectangle structure with a bounding box that would completely enclose the specified region, and also returns the type of the specified region.</em> <a href="#a13"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>GR_REGION_ID </td><td valign=bottom><a class="el" href="group__nanox__region.html#a14">GrNewPolygonRegion</a> (int mode, GR_COUNT count, GR_POINT *points)</td></tr><tr><td> </td><td><em class="mdesc">Creates a new region structure, fills it with the region described by the specified polygon, and returns the ID used to refer to it.</em> <a href="#a14"></a><em></em><br><br></td></tr><tr><td nowrap align=right valign=top>GR_REGION_ID </td><td valign=bottom><a class="el" href="group__nanox__region.html#a15">GrNewBitmapRegion</a> (GR_BITMAP *bitmap, GR_SIZE width, GR_SIZE height)</td></tr><tr><td> </td><td><em class="mdesc">Creates a new region structure, fills it with the region described by the specified polygon, and returns the ID used to refer to it.</em> <a href="#a15"></a><em></em><br><br></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>Functions for handling clipping regions - these are used for clipping drawing, and for non-rectangular windows.<p><hr><h2>Function Documentation</h2><a name="a1" doxytag="nano-X.h::GrDestroyRegion"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void GrDestroyRegion </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">GR_REGION_ID </td> <td class="mdname1" valign="top" nowrap> <em>region</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Destroys a region structure.<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>region</em> </td><td>The ID of the region structure to destroy. </td></tr> </table></dl> </td> </tr></table><a name="a10" doxytag="nano-X.h::GrEmptyRegion"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> GR_BOOL GrEmptyRegion </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">GR_REGION_ID </td> <td class="mdname1" valign="top" nowrap> <em>region</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Determines whether the specified region is empty.<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>region</em> </td><td>The ID of the region to examine. </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>GR_TRUE if the region is empty, or GR_FALSE if it is not. </dd></dl> </td> </tr></table><a name="a11" doxytag="nano-X.h::GrEqualRegion"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> GR_BOOL GrEqualRegion </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">GR_REGION_ID </td> <td class="mdname" nowrap> <em>rgn1</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>GR_REGION_ID </td> <td class="mdname" nowrap> <em>rgn2</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Determines whether the specified regions are identical, and returns GR_TRUE if it is, or GR_FALSE otherwise.<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>rgn1</em> </td><td>The ID of the first region to examine. </td></tr> <tr><td valign=top><em>rgn2</em> </td><td>The ID of the second region to examine. </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>GR_TRUE if the regions are equal, or GR_FALSE otherwise </dd></dl> </td> </tr></table><a name="a13" doxytag="nano-X.h::GrGetRegionBox"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int GrGetRegionBox </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">GR_REGION_ID </td> <td class="mdname" nowrap> <em>region</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="structGR__RECT.html">GR_RECT</a> * </td> <td class="mdname" nowrap> <em>rect</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Fills in the specified rectangle structure with a bounding box that would completely enclose the specified region, and also returns the type of the specified region.<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>region</em> </td><td>The ID of the region to get the bounding box of </td></tr> <tr><td valign=top><em>rect</em> </td><td>Pointer to a rectangle structure </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>The region type</dd></dl><p><dl compact><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>FIXME check Doxygen comments from this point down. </dd></dl> </td> </tr></table><a name="a6" doxytag="nano-X.h::GrIntersectRegion"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void GrIntersectRegion </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">GR_REGION_ID </td> <td class="mdname" nowrap> <em>dst_rgn</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>GR_REGION_ID </td> <td class="mdname" nowrap> <em>src_rgn1</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>GR_REGION_ID </td> <td class="mdname" nowrap> <em>src_rgn2</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Calculates the intersection of the two specified source regions and places the result in the specified destination region.<p>The destination region will contain only the parts of the source regions which overlap each other.<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>dst_rgn</em> </td><td>The ID of the destination region. </td></tr> <tr><td valign=top><em>src_rgn1</em> </td><td>The ID of the first source region. </td></tr> <tr><td valign=top><em>src_rgn2</em> </td><td>The ID of the second source region. </td></tr> </table></dl> </td> </tr></table><a name="a15" doxytag="nano-X.h::GrNewBitmapRegion"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> GR_REGION_ID GrNewBitmapRegion </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">GR_BITMAP * </td> <td class="mdname" nowrap> <em>bitmap</em>, </td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -