1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../css/manpage.css" type="text/css" />
7<title>nngxTransferRenderImage</title>
8  </head>
9  <body>
10<h1><CODE>nngxTransferRenderImage</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14NNGX_APICALL void NNGX_APIENTRY nngxTransferRenderImage(
15     GLuint buffer,
16     GLenum mode,
17     GLboolean yflip,
18     GLint colorx,
19     GLint colory
20);
21</pre>
22    </div>
23<h2>Arguments</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29<th>Name</th>
30<td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34<td>in</td>
35<th>buffer</th>
36<td>Display buffer to transfer to</td>
37        </tr>
38        <tr>
39<td>in</td>
40<th>mode</th>
41<td>Antialias mode</td>
42        </tr>
43        <tr>
44<td>in</td>
45<th>yflip</th>
46<td>Enables or disables flipping in the y direction</td>
47        </tr>
48        <tr>
49<td>in</td>
50<th>colorx</th>
51<td>X coordinate from which to start transferring the color buffer</td>
52        </tr>
53        <tr>
54<td>in</td>
55<th>colory</th>
56<td>Y coordinate from which to start transferring the color buffer</td>
57        </tr> </table>
58    </div>
59<h2>Return Values</h2>
60<div class="section">No values are returned. </div>
61<h2>Description</h2>
62    <div class="section">
63<p>Transfers images from the current color buffer to the display buffer specified by <SPAN class="argument">buffer</SPAN>.</p><P>
64A partial rectangle with the coordinates (<SPAN class="argument">colorx</SPAN>, <SPAN class="argument">colory</SPAN>) at the lower-left corner is transferred from the color buffer to the display buffer. The distance from <SPAN class="argument">colorx</SPAN> to the right, and from <SPAN class="argument">colory</SPAN> to the top, of the color buffer being transferred must be at least the size of the width and height, respectively, of the display buffer being transferred to.
65            </P><P>
66You can perform anti-aliasing during the transfer. Set <SPAN class="argument">mode</SPAN> to one of the following values for the anti-aliasing mode.
67</P><P><TABLE><TR><TH>NN_GX_ANTIALIASE_NOT_USED</TH><TD>No anti-aliasing</TD></TR><TR><TH>NN_GX_ANTIALIASE_2x1</TH><TD>2x1 anti-aliasing</TD></TR><TR><TH>NN_GX_ANTIALIASE_2x2</TH><TD>2x2 anti-aliasing</TD></TR></TABLE><!-- source                      NN_GX_ANTIALIASE_NOT_USED ・・・ アンチエイリアスなし NN_GX_ANTIALIASE_2x1 ・・・ 2x1アンチエイリアス NN_GX_ANTIALIASE_2x2 ・・・ 2x2アンチエイリアス                 --></P><P>
68With 2x1 anti-aliasing, the color buffer's partial rectangle must be at least twice as wide as the display buffer it is being transferred to. With 2x2 anti-aliasing, the color buffer's partial rectangle must be at least twice as wide and twice as tall as the display buffer it is being transferred to.
69            </P><P>
70Set <SPAN class="argument">yflip</SPAN> to <CODE>GL_TRUE</CODE> to flip data in the y direction during the transfer. If you set <SPAN class="argument">yflip</SPAN> to <CODE>GL_FALSE</CODE>, data is not flipped in the y direction.
71            </P><P>
72Set <SPAN class="argument">colorx</SPAN> and <SPAN class="argument">colory</SPAN> to a value greater than or equal to 0. You must set <SPAN class="argument">colorx</SPAN> and <SPAN class="argument">colory</SPAN> to a multiple of the block size. The block size is set by <CODE>glRenderBlockModeDMP</CODE>.
73            </P><P>
74This function generates the following errors.
75<TABLE><TR><TH>GL_ERROR_8027_DMP</TH><TD>0 is bound to the current command list.</TD></TR><TR><TH>GL_ERROR_8028_DMP</TH><TD>An overflow occurred in the current command request.</TD></TR><TR><TH>GL_ERROR_8029_DMP</TH><TD>Either an invalid value was specified for <SPAN class="argument">buffer</SPAN>, or no memory was allocated for the display buffer.</TD></TR><TR><TH>GL_ERROR_802A_DMP</TH><TD>Either the destination color buffer was not set correctly (the render buffer is not attached), or no memory has been allocated for the render buffer.</TD></TR><TR><TH>GL_ERROR_802B_DMP</TH><TD>The <span class="argument">mode</span> argument was set to an invalid value.</TD></TR><TR><TH>GL_ERROR_802C_DMP</TH><TD>Either the width of the transfer region of the color buffer (<CODE>ColorBufferWidthInPixels</CODE> - <SPAN class="argument">colorx</SPAN>) is smaller than the width of the display buffer, or the height of the transfer region of the color buffer (<CODE>ColorBufferHeightInPixels</CODE> - <SPAN class="argument">colory</SPAN>) is smaller than the height of the display buffer.</TD></TR><TR><TH>GL_ERROR_802D_DMP</TH><TD>The <SPAN class="argument">colorx</SPAN> or <SPAN class="argument">colory</SPAN> argument was set to an invalid value.</TD></TR><TR><TH>GL_ERROR_802E_DMP</TH><TD>The dimensions (in pixels) of the destination display buffer were larger than those of the source color buffer from which the data was supposed to be transferred.</TD></TR><TR><TH>GL_ERROR_802F_DMP</TH><TD>A split command could not be added because the command buffer is full.</TD></TR></TABLE></P></div>
76<h2>Revision History</h2>
77    <div class="section">
78      <dl class="history">
79        <dt>2010/03/12</dt>
80<dd>Added extended error code(s).<br />
81        </dd>
82        <dt>2010/01/07</dt>
83<dd>Initial version.<br />
84        </dd>
85      </dl>
86    </div>
87  <hr><p>CONFIDENTIAL</p></body>
88</html>