Skip to content

Commit c5f7496

Browse files
author
github-actions
committed
Update documentation for branch developing
1 parent 9efe094 commit c5f7496

14 files changed

+1581
-1519
lines changed

developing/arm__2d__helper_8h_source.html

Lines changed: 143 additions & 132 deletions
Large diffs are not rendered by default.

developing/footer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
function writeHeader() {
2-
document.write('Version 1.2.6-dev204');
2+
document.write('Version 1.2.6-dev205');
33
};
44

55
function writeFooter() {
6-
document.write('Generated on Tue Feb 10 2026 11:08:30 for Arm-2D 1.2.6-dev204+gd3d23a6. Copyright © 2022-2026 Arm Limited (or its affiliates). All rights reserved.');
6+
document.write('Generated on Wed Feb 11 2026 04:55:53 for Arm-2D 1.2.6-dev205+g579ca26. Copyright © 2022-2026 Arm Limited (or its affiliates). All rights reserved.');
77
};

developing/group__gHelper.html

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1271,6 +1271,9 @@
12711271
<tr class="memitem:ga44e78d3e1990b1721c40fc6a93c78fcf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gHelper.html#ga44e78d3e1990b1721c40fc6a93c78fcf">arm_2d_byte_fifo_enqueue</a> (<a class="el" href="group__gHelper.html#structarm__2d__byte__fifo__t">arm_2d_byte_fifo_t</a> *ptThis, uint8_t chChar)</td></tr>
12721272
<tr class="memdesc:ga44e78d3e1990b1721c40fc6a93c78fcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">write a byte to a given fifo <a href="group__gHelper.html#ga44e78d3e1990b1721c40fc6a93c78fcf">More...</a><br /></td></tr>
12731273
<tr class="separator:ga44e78d3e1990b1721c40fc6a93c78fcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
1274+
<tr class="memitem:ga5fbb1d96b72bc539962d69ff1ecade1c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gHelper.html#ga5fbb1d96b72bc539962d69ff1ecade1c">arm_2d_byte_fifo_vomit</a> (<a class="el" href="group__gHelper.html#structarm__2d__byte__fifo__t">arm_2d_byte_fifo_t</a> *ptThis, uint8_t *pchChar)</td></tr>
1275+
<tr class="memdesc:ga5fbb1d96b72bc539962d69ff1ecade1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">remove a byte from the queue tail <a href="group__gHelper.html#ga5fbb1d96b72bc539962d69ff1ecade1c">More...</a><br /></td></tr>
1276+
<tr class="separator:ga5fbb1d96b72bc539962d69ff1ecade1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
12741277
<tr class="memitem:ga39659f1502b567be1120836a358e84cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gHelper.html#ga39659f1502b567be1120836a358e84cb">arm_2d_byte_fifo_squeeze</a> (<a class="el" href="group__gHelper.html#structarm__2d__byte__fifo__t">arm_2d_byte_fifo_t</a> *ptThis, uint8_t chChar)</td></tr>
12751278
<tr class="memdesc:ga39659f1502b567be1120836a358e84cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">enter a byte to the FIFO, if the FIFO is full, drop one from the FIFO <a href="group__gHelper.html#ga39659f1502b567be1120836a358e84cb">More...</a><br /></td></tr>
12761279
<tr class="separator:ga39659f1502b567be1120836a358e84cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -14375,6 +14378,50 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga44e78d3e1990b1721c40fc6
1437514378
</dd>
1437614379
</dl>
1437714380

14381+
</div>
14382+
</div>
14383+
<a id="ga5fbb1d96b72bc539962d69ff1ecade1c" name="ga5fbb1d96b72bc539962d69ff1ecade1c"></a>
14384+
<h2 class="memtitle"><span class="permalink"><a href="#ga5fbb1d96b72bc539962d69ff1ecade1c">&#9670;&#160;</a></span>arm_2d_byte_fifo_vomit()</h2>
14385+
14386+
<div class="memitem">
14387+
<div class="memproto">
14388+
<table class="memname">
14389+
<tr>
14390+
<td class="memname">bool arm_2d_byte_fifo_vomit </td>
14391+
<td>(</td>
14392+
<td class="paramtype"><a class="el" href="group__gHelper.html#structarm__2d__byte__fifo__t">arm_2d_byte_fifo_t</a> *&#160;</td>
14393+
<td class="paramname"><em>ptThis</em>, </td>
14394+
</tr>
14395+
<tr>
14396+
<td class="paramkey"></td>
14397+
<td></td>
14398+
<td class="paramtype">uint8_t *&#160;</td>
14399+
<td class="paramname"><em>pchChar</em>&#160;</td>
14400+
</tr>
14401+
<tr>
14402+
<td></td>
14403+
<td>)</td>
14404+
<td></td><td></td>
14405+
</tr>
14406+
</table>
14407+
</div><div class="memdoc">
14408+
14409+
<p>remove a byte from the queue tail </p>
14410+
<dl class="params"><dt>Parameters</dt><dd>
14411+
<table class="params">
14412+
<tr><td class="paramdir">[in]</td><td class="paramname">ptThis</td><td>the target FIFO control block </td></tr>
14413+
<tr><td class="paramdir">[in]</td><td class="paramname">pchChar</td><td>a buffer to store the byte, NULL means drop a byte </td></tr>
14414+
</table>
14415+
</dd>
14416+
</dl>
14417+
<dl class="retval"><dt>Return values</dt><dd>
14418+
<table class="retval">
14419+
<tr><td class="paramname">false</td><td>the FIFO is EMPTY </td></tr>
14420+
<tr><td class="paramname">true</td><td>operation is successful </td></tr>
14421+
</table>
14422+
</dd>
14423+
</dl>
14424+
1437814425
</div>
1437914426
</div>
1438014427
<a id="ga39659f1502b567be1120836a358e84cb" name="ga39659f1502b567be1120836a358e84cb"></a>

developing/group__gHelper.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,7 @@ var group__gHelper =
492492
[ "arm_2d_byte_fifo_init", "group__gHelper.html#gac3bdc393bc8cbb86351a7647372854d8", null ],
493493
[ "arm_2d_byte_fifo_drop_all", "group__gHelper.html#gae5ef53c867010fd51592debcba60441a", null ],
494494
[ "arm_2d_byte_fifo_enqueue", "group__gHelper.html#ga44e78d3e1990b1721c40fc6a93c78fcf", null ],
495+
[ "arm_2d_byte_fifo_vomit", "group__gHelper.html#ga5fbb1d96b72bc539962d69ff1ecade1c", null ],
495496
[ "arm_2d_byte_fifo_squeeze", "group__gHelper.html#ga39659f1502b567be1120836a358e84cb", null ],
496497
[ "arm_2d_byte_fifo_get_item_count", "group__gHelper.html#gae315df9c1c2853c5cddae4f829a207c9", null ],
497498
[ "arm_2d_byte_fifo_get_capcity", "group__gHelper.html#gae088da98a4a858328dc2a15fb30c48b2", null ],

developing/navtreedata.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -310,10 +310,10 @@ var NAVTREEINDEX =
310310
"deprecated.html",
311311
"group__gAlpha.html#ga5dc869d95021852f76179a082ef20bf2",
312312
"group__gHelper.html#ac7afe838e59ecfe4d41f0ac1420ac010",
313-
"group__gHelper.html#gga37fc2d9f259e9fd0f5f0957393ceddbba97b1f0f3001d78d2d20e14efdd9e780c",
314-
"group__gKernel.html#ae48973023807fe240dfa88082b816dcc",
315-
"group__gKernel.html#gga3249990f0553a40aa0e48e3568172e59afeef30963a857f2b0a15a8a7d1f01495",
316-
"group__gTransform.html#unionarm__2d__op__trans__msk__opa__t_8____unnamed125____"
313+
"group__gHelper.html#gga37fc2d9f259e9fd0f5f0957393ceddbba458af1125a31d8cf8175a1d88fb81162",
314+
"group__gKernel.html#ae2058b1efa649f0c544c7317e3e01886",
315+
"group__gKernel.html#gga3249990f0553a40aa0e48e3568172e59a5d3ce11b32268835bc89401fba037832",
316+
"group__gTransform.html#union____arm__2d__transform__info__t_8Mask"
317317
];
318318

319319
var SYNCONMSG = 'click to disable panel synchronisation';

developing/navtreeindex0.js

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,28 @@ var NAVTREEINDEX0 =
33
"deprecated.html":[11],
44
"group__Deprecated.html":[12,8],
55
"group__Drawing.html":[12,2],
6-
"group__Drawing.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,2,3,1],
76
"group__Drawing.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,2,7,1],
87
"group__Drawing.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,2,5,1],
8+
"group__Drawing.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,2,3,1],
99
"group__Drawing.html#a18975ab3ce177381cc0c77216342636f":[12,2,2,1],
1010
"group__Drawing.html#a2abd5995ab6396a44e136d16cd330a21":[12,2,2,0],
1111
"group__Drawing.html#a352ed9987100b99ce0d2391f2a5d537a":[12,2,2,3],
1212
"group__Drawing.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,2,6,1],
13-
"group__Drawing.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,2,9,1],
1413
"group__Drawing.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,2,10,1],
1514
"group__Drawing.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,2,4,1],
15+
"group__Drawing.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,2,9,1],
1616
"group__Drawing.html#a4853c21ae19c1b2bc936685425c225b5":[12,2,6,0],
17-
"group__Drawing.html#a4853c21ae19c1b2bc936685425c225b5":[12,2,9,0],
1817
"group__Drawing.html#a4853c21ae19c1b2bc936685425c225b5":[12,2,10,0],
18+
"group__Drawing.html#a4853c21ae19c1b2bc936685425c225b5":[12,2,9,0],
1919
"group__Drawing.html#a4853c21ae19c1b2bc936685425c225b5":[12,2,4,0],
2020
"group__Drawing.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,2,7,0],
2121
"group__Drawing.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,2,8,0],
2222
"group__Drawing.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,2,5,0],
2323
"group__Drawing.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,2,3,0],
24-
"group__Drawing.html#a9f162c8dd605b531b0443f4f8d74453d":[12,2,10,2],
24+
"group__Drawing.html#a9f162c8dd605b531b0443f4f8d74453d":[12,2,4,2],
2525
"group__Drawing.html#a9f162c8dd605b531b0443f4f8d74453d":[12,2,9,2],
26+
"group__Drawing.html#a9f162c8dd605b531b0443f4f8d74453d":[12,2,10,2],
2627
"group__Drawing.html#a9f162c8dd605b531b0443f4f8d74453d":[12,2,6,2],
27-
"group__Drawing.html#a9f162c8dd605b531b0443f4f8d74453d":[12,2,4,2],
2828
"group__Drawing.html#ab1bf2464482f46020867f04694749165":[12,2,0,0],
2929
"group__Drawing.html#acdf550648b968f73a598b6b2faa8d62c":[12,2,2,2],
3030
"group__Drawing.html#afd740e4d8b4cc827951fffd9c2a85ba3":[12,2,1,0],
@@ -145,45 +145,45 @@ var NAVTREEINDEX0 =
145145
"group__Tile.html#unionarm__2d__op__cp__cl__key__t_8____unnamed133____":[12,1,3],
146146
"group__gAlpha.html":[12,3],
147147
"group__gAlpha.html#a08ddfde2b216f45914bf76fe86b63cae":[12,3,4,2],
148-
"group__gAlpha.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,3,20,1],
149-
"group__gAlpha.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,3,16,1],
150-
"group__gAlpha.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,3,8,1],
151148
"group__gAlpha.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,3,10,1],
149+
"group__gAlpha.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,3,8,1],
152150
"group__gAlpha.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,3,13,1],
151+
"group__gAlpha.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,3,16,1],
152+
"group__gAlpha.html#a0cb326a2a86a2a0e46a3b1226fb97c65":[12,3,20,1],
153153
"group__gAlpha.html#a0ceaabc437c7f6dfc280643227bc60ba":[12,3,3,2],
154154
"group__gAlpha.html#a1116adbfe72a3d50257f9fcb6c2d05b2":[12,3,1,3],
155155
"group__gAlpha.html#a238e2da6f62c620b64b00b4cf87f3cb0":[12,3,2,2],
156156
"group__gAlpha.html#a23bcb256fb14df9aa49dbf5f7882d2da":[12,3,4,1],
157157
"group__gAlpha.html#a323fb526636166dfa7d3f6303892c46c":[12,3,1,2],
158+
"group__gAlpha.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,3,21,1],
158159
"group__gAlpha.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,3,15,1],
159-
"group__gAlpha.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,3,12,1],
160160
"group__gAlpha.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,3,18,1],
161-
"group__gAlpha.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,3,21,1],
161+
"group__gAlpha.html#a3a90debdbc76b907ebc5d82ee18e56aa":[12,3,12,1],
162162
"group__gAlpha.html#a3eecb67b068680cf206df2a75eefb2f0":[12,3,2,3],
163163
"group__gAlpha.html#a434790e4bf185ebc635e88a3bb8233d6":[12,3,4,0],
164164
"group__gAlpha.html#a4853c21ae19c1b2bc936685425c225b5":[12,3,21,0],
165-
"group__gAlpha.html#a4853c21ae19c1b2bc936685425c225b5":[12,3,12,0],
166165
"group__gAlpha.html#a4853c21ae19c1b2bc936685425c225b5":[12,3,15,0],
167166
"group__gAlpha.html#a4853c21ae19c1b2bc936685425c225b5":[12,3,18,0],
167+
"group__gAlpha.html#a4853c21ae19c1b2bc936685425c225b5":[12,3,12,0],
168168
"group__gAlpha.html#a5a51efdf47c26a54e28619b668bcde03":[12,3,0,1],
169169
"group__gAlpha.html#a62e802b58cbaf51f05e8b5ec41436da8":[12,3,0,3],
170-
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,11,0],
170+
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,16,0],
171+
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,17,0],
172+
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,14,0],
171173
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,13,0],
172-
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,20,0],
174+
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,11,0],
173175
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,10,0],
174-
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,14,0],
175-
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,17,0],
176-
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,8,0],
177-
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,16,0],
178176
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,9,0],
177+
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,8,0],
178+
"group__gAlpha.html#a64a5acb6f6d68bcc4b933310d44c480b":[12,3,20,0],
179179
"group__gAlpha.html#a6dce4413320f2aa7ead0a8deeba8fa1c":[12,3,2,0],
180180
"group__gAlpha.html#a76aae367b0d10ccb4492541180f67787":[12,3,19,0],
181181
"group__gAlpha.html#a847ada916032c171108dd3c81e465d32":[12,3,1,4],
182182
"group__gAlpha.html#a8ce85726f018374e663ab80b3661aefa":[12,3,0,2],
183183
"group__gAlpha.html#a9f162c8dd605b531b0443f4f8d74453d":[12,3,15,2],
184-
"group__gAlpha.html#a9f162c8dd605b531b0443f4f8d74453d":[12,3,21,2],
185-
"group__gAlpha.html#a9f162c8dd605b531b0443f4f8d74453d":[12,3,18,2],
186184
"group__gAlpha.html#a9f162c8dd605b531b0443f4f8d74453d":[12,3,12,2],
185+
"group__gAlpha.html#a9f162c8dd605b531b0443f4f8d74453d":[12,3,18,2],
186+
"group__gAlpha.html#a9f162c8dd605b531b0443f4f8d74453d":[12,3,21,2],
187187
"group__gAlpha.html#aa0bcec9e195fb29ec3077ab17d4994eb":[12,3,2,1],
188188
"group__gAlpha.html#aa25ee06c23b4722003bbbf0abaf6b995":[12,3,1,0],
189189
"group__gAlpha.html#abd6552d22b9450025029e8acb7b71d4f":[12,3,1,1],

0 commit comments

Comments
 (0)