summaryrefslogtreecommitdiff
path: root/otr_texture.html
blob: 8da1f556f444ce8287b1339db80bee0111f4c147 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torch: Texture Resource</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>
<script type="text/javascript" src="clipboard.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" />
</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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torch
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.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('otr_texture.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><div class="header">
  <div class="headertitle"><div class="title">Texture Resource </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1 class="doxsection"><a class="anchor" id="autotoc_md36"></a>
Texture Resource (OTEX)</h1>
<p>If the Resource Type is <span class="tt">OTEX</span> (<span class="tt">0x4F544558</span>), the header is immediately followed by the texture definition.</p>
<h2 class="doxsection"><a class="anchor" id="autotoc_md37"></a>
Texture Header</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Offset  </th><th class="markdownTableHeadLeft">Size  </th><th class="markdownTableHeadLeft">Type  </th><th class="markdownTableHeadLeft">Description  </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">0x40  </td><td class="markdownTableBodyLeft">4  </td><td class="markdownTableBodyLeft">u32  </td><td class="markdownTableBodyLeft">Texture Type ID  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">0x44  </td><td class="markdownTableBodyLeft">4  </td><td class="markdownTableBodyLeft">u32  </td><td class="markdownTableBodyLeft">Width  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">0x48  </td><td class="markdownTableBodyLeft">4  </td><td class="markdownTableBodyLeft">u32  </td><td class="markdownTableBodyLeft">Height  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">0x4C  </td><td class="markdownTableBodyLeft">4  </td><td class="markdownTableBodyLeft">u32  </td><td class="markdownTableBodyLeft">Data Size  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">0x50  </td><td class="markdownTableBodyLeft">...  </td><td class="markdownTableBodyLeft">[u8]  </td><td class="markdownTableBodyLeft">Raw Texture Data  </td></tr>
</table>
<h2 class="doxsection"><a class="anchor" id="autotoc_md38"></a>
Texture Types</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">ID  </th><th class="markdownTableHeadLeft">Name  </th><th class="markdownTableHeadLeft">Bits Per Pixel  </th><th class="markdownTableHeadLeft">Description  </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">0  </td><td class="markdownTableBodyLeft">Error  </td><td class="markdownTableBodyLeft">-  </td><td class="markdownTableBodyLeft">Invalid / Error  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">1  </td><td class="markdownTableBodyLeft">RGBA32bpp  </td><td class="markdownTableBodyLeft">32  </td><td class="markdownTableBodyLeft">Red, Green, Blue, Alpha (8 bits each)  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">2  </td><td class="markdownTableBodyLeft">RGBA16bpp  </td><td class="markdownTableBodyLeft">16  </td><td class="markdownTableBodyLeft">RGBA 5-5-5-1  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">3  </td><td class="markdownTableBodyLeft">Palette4bpp  </td><td class="markdownTableBodyLeft">4  </td><td class="markdownTableBodyLeft">4-bit Color Index (CI4)  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">4  </td><td class="markdownTableBodyLeft">Palette8bpp  </td><td class="markdownTableBodyLeft">8  </td><td class="markdownTableBodyLeft">8-bit Color Index (CI8)  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">5  </td><td class="markdownTableBodyLeft">Grayscale4bpp  </td><td class="markdownTableBodyLeft">4  </td><td class="markdownTableBodyLeft">4-bit Intensity (I4)  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">6  </td><td class="markdownTableBodyLeft">Grayscale8bpp  </td><td class="markdownTableBodyLeft">8  </td><td class="markdownTableBodyLeft">8-bit Intensity (I8)  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">7  </td><td class="markdownTableBodyLeft">GrayscaleAlpha4bpp  </td><td class="markdownTableBodyLeft">4  </td><td class="markdownTableBodyLeft">4-bit Intensity with Alpha (IA4)  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">8  </td><td class="markdownTableBodyLeft">GrayscaleAlpha8bpp  </td><td class="markdownTableBodyLeft">8  </td><td class="markdownTableBodyLeft">8-bit Intensity with Alpha (IA8)  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">9  </td><td class="markdownTableBodyLeft">GrayscaleAlpha16bpp  </td><td class="markdownTableBodyLeft">16  </td><td class="markdownTableBodyLeft">16-bit Intensity with Alpha (IA16)  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">10  </td><td class="markdownTableBodyLeft">GrayscaleAlpha1bpp  </td><td class="markdownTableBodyLeft">1  </td><td class="markdownTableBodyLeft">1-bit Black/White (I1)  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">11  </td><td class="markdownTableBodyLeft">TLUT  </td><td class="markdownTableBodyLeft">-  </td><td class="markdownTableBodyLeft">Texture Look-Up <a class="el" href="structTable.html">Table</a> (Palette)  </td></tr>
</table>
<p><b>Note:</b> When a <span class="tt">TLUT</span> is exported to an OTR file, its type is converted to <span class="tt">RGBA16bpp</span> (ID 2).</p>
<h2 class="doxsection"><a class="anchor" id="autotoc_md39"></a>
YAML Configuration</h2>
<p>When defining textures in the asset configuration, the following format strings are supported:</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Format String  </th><th class="markdownTableHeadLeft">Texture Type  </th><th class="markdownTableHeadLeft">Bit Depth  </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><span class="tt">rgba16</span>  </td><td class="markdownTableBodyLeft">RGBA16bpp  </td><td class="markdownTableBodyLeft">16  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><span class="tt">rgba32</span>  </td><td class="markdownTableBodyLeft">RGBA32bpp  </td><td class="markdownTableBodyLeft">32  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><span class="tt">ci4</span>  </td><td class="markdownTableBodyLeft">Palette4bpp  </td><td class="markdownTableBodyLeft">4  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><span class="tt">ci8</span>  </td><td class="markdownTableBodyLeft">Palette8bpp  </td><td class="markdownTableBodyLeft">8  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><span class="tt">i4</span>  </td><td class="markdownTableBodyLeft">Grayscale4bpp  </td><td class="markdownTableBodyLeft">4  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><span class="tt">i8</span>  </td><td class="markdownTableBodyLeft">Grayscale8bpp  </td><td class="markdownTableBodyLeft">8  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><span class="tt">ia1</span>  </td><td class="markdownTableBodyLeft">GrayscaleAlpha1bpp  </td><td class="markdownTableBodyLeft">1  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><span class="tt">ia4</span>  </td><td class="markdownTableBodyLeft">GrayscaleAlpha4bpp  </td><td class="markdownTableBodyLeft">4  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><span class="tt">ia8</span>  </td><td class="markdownTableBodyLeft">GrayscaleAlpha8bpp  </td><td class="markdownTableBodyLeft">8  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><span class="tt">ia16</span>  </td><td class="markdownTableBodyLeft">GrayscaleAlpha16bpp  </td><td class="markdownTableBodyLeft">16  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><span class="tt">tlut</span>  </td><td class="markdownTableBodyLeft">TLUT  </td><td class="markdownTableBodyLeft">16  </td></tr>
</table>
<h3 class="doxsection"><a class="anchor" id="autotoc_md40"></a>
Paletted Textures (CI4 / CI8)</h3>
<p>For paletted textures (<span class="tt">ci4</span> or <span class="tt">ci8</span>), you can optionally define the accompanying TLUT within the same entry. If <span class="tt">tlut</span> (offset) and <span class="tt">colors</span> (count) are provided, Torch will automatically generate a separate TLUT asset.</p>
<p>You can also specify <span class="tt">tlut_symbol</span> to explicitly name the generated TLUT asset. If omitted, it defaults to the texture symbol with <span class="tt">_tlut</span> appended.</p>
<p>Example: </p><div class="fragment"><div class="line">- type: TEXTURE</div>
<div class="line">  format: ci8</div>
<div class="line">  width: 32</div>
<div class="line">  height: 32</div>
<div class="line">  offset: 0x12345</div>
<div class="line">  tlut: 0x12545</div>
<div class="line">  colors: 256</div>
<div class="line">  tlut_symbol: my_custom_tlut_name # Optional</div>
</div><!-- fragment --><p> This will create the texture asset and a separate TLUT asset. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</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 -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a href="index.html">Torch Documentation</a></li><li class="navelem"><a href="otr_format.html">OTR File Format Specification</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
  </ul>
</div>
</body>
</html>