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>CopyTexture2DResourceBlockToLinear</title>
8  </head>
9  <body>
10    <h1>nn::gd::CTR::Memory::CopyTexture2DResourceBlockToLinear Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../nnResult/Overview.html">nnResult</a> CopyTexture2DResourceBlockToLinear(
15     const Texture2DResource * source,
16     s32 srcMipLevelIndex,
17     u32 srcOffestY,
18     s32 srcCountRow,
19     const Texture2DResource * dest,
20     s32 dstMipLevelIndex,
21     u32 dstOffestY,
22     <a href="../../../../nn/gd/CTR/Memory/DownScalingMode.html">DownScalingMode</a> downScalingMode,
23     <span>gdBool</span> yFlip
24);
25</pre>
26    </div>
27    <h2>Arguments</h2>
28    <div class="section">
29      <table class="arguments">
30        <thead>
31          <tr>
32            <td width="15" />
33            <th>Name</th>
34            <td>Description</td>
35          </tr>
36        </thead>
37        <tr>
38          <td>in</td>
39          <th>source</th>
40          <td>Pointer to the <SPAN class="Argument">Texture2DResource</SPAN> resource transfer source.</td>
41        </tr>
42        <tr>
43          <td>in</td>
44          <th>srcMipLevelIndex</th>
45          <td>Specifies the index of the mipmap level of the transfer source. If <CODE>-1</CODE> is specified, the last mipmap level index is used. </td>
46        </tr>
47        <tr>
48          <td>in</td>
49          <th>srcOffestY</th>
50          <td>Specifies the Y offset of the transfer source. This value must be a multiple of <SPAN class="Argument">srcBlockSize</SPAN> and less than the height of the mipmap level of the transfer source.</td>
51        </tr>
52        <tr>
53          <td>in</td>
54          <th>srcCountRow</th>
55          <td>Specifies the height to transfer. If <CODE>-1</CODE> is specified, transfer is made at a size found by subtracting <SPAN class="Argument">srcOffestY</SPAN> from the height of the transfer source resource.  <SPAN class="Argument">srcCountRow</SPAN> is a multiple of <SPAN class="Argument">srcBlockSize</SPAN>. <CODE>srcOffestY + srcCountRow</CODE> must be equal to or less than the height of the transfer source resource. </td>
56        </tr>
57        <tr>
58          <td>in</td>
59          <th>dest</th>
60          <td>Specifies a pointer to the <SPAN class="Argument">Texture2DResource</SPAN> of the transfer destination.</td>
61        </tr>
62        <tr>
63          <td>in</td>
64          <th>dstMipLevelIndex</th>
65          <td>Specifies the index of the mipmap level of the transfer destination. If <CODE>-1</CODE> is specified, the last mipmap level index is used. </td>
66        </tr>
67        <tr>
68          <td>in</td>
69          <th>dstOffestY</th>
70          <td>Specifies the Y offset of the transfer destination. </td>
71        </tr>
72        <tr>
73          <td>in</td>
74          <th>downScalingMode</th>
75          <td>Specifies antialiasing filter mode.</td>
76        </tr>
77        <tr>
78          <td>in</td>
79          <th>yFlip</th>
80          <td>The transferred image is flipped vertically when <SPAN class="Argument">yflip</SPAN> is <CODE>GD_TRUE</CODE>. The image is not flipped when <CODE>GD_FALSE</CODE>.</td>
81        </tr> </table>
82    </div>
83    <h2>Return Values</h2>
84    <div class="section">Returns the result of the operation. <br />
85      <table class="arguments">
86        <thead>
87          <tr>
88            <th>Value</th>
89            <td>Description</td>
90          </tr>
91        </thead>
92        <tr>
93          <th>ResultSuccess</th>
94          <td>Process was successful.</td>
95        </tr>
96        <tr>
97          <th>ResultNullParameter</th>
98          <td><CODE>NULL</CODE> was specified for <SPAN class="Argument">source</SPAN> or <SPAN class="Argument">dest</SPAN>.</td>
99        </tr>
100        <tr>
101          <th>ResultInvalidMemoryLayout</th>
102          <td>Either the transfer source resource is not <CODE>LAYOUT_BLOCK_8</CODE> or <CODE>LAYOUT_BLOCK_32</CODE> format, or the transfer destination is not <CODE>LAYOUT_LINEAR</CODE>. </td>
103        </tr>
104        <tr>
105          <th>ResultInvalidTextureOffset</th>
106          <td><SPAN class="Argument">srcOffsetY</SPAN> and <SPAN class="Argument">srcCountRow</SPAN> are not multiples of the memory layout.  Or, <SPAN class="Argument">dstOffestY</SPAN> is larger than the transfer destination. Or, the transfer source offset is larger than the transfer source resource.  Or, <SPAN class="Argument">downScalingMode</SPAN> is invalid. Or, the transfer destination offset is larger than the transfer destination resource. </td>
107        </tr>
108        <tr>
109          <th>ResultInvalidTextureMipLevelIndex</th>
110          <td>The mipmap level index of the transfer source or transfer destination is invalid. </td>
111        </tr>
112        <tr>
113          <th>ResultInvalidTextureFormat</th>
114          <td>The pixel format of the transfer source or transfer destination is invalid. </td>
115        </tr>
116      </table> </div>
117    <h2>Description</h2>
118    <div class="section">
119      <p>Adds a command for converting the source <SPAN class="Argument">Texture2DResource</SPAN> resource from a block image to a linear image and transferring it to the destination <SPAN class="Argument">Texture2DResource</SPAN>. </p><p>Pixel formats that can be specified for the source and destination:  <br /><itemizedlist><listitem><para>NATIVE_FORMAT_RGBA_8888 <br /></para></listitem><listitem><para>NATIVE_FORMAT_RGB_888 <br /></para></listitem><listitem><para>NATIVE_FORMAT_RGBA_4444 <br /></para></listitem><listitem><para>NATIVE_FORMAT_RGBA_5551 <br /></para></listitem><listitem><para>NATIVE_FORMAT_RGB_565 <br /> . <br /></para></listitem></itemizedlist></p><!-- write here --></div>
120    <h2>Revision History</h2>
121    <div class="section">
122      <dl class="history">
123        <dt>2011/02/21</dt>
124        <dd>Initial version.<br />
125        </dd>
126      </dl>
127    </div>
128  <hr><p>CONFIDENTIAL</p></body>
129</html>
130