mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 10:12:06 +00:00
0e0e12a769
It has been obtained from here: http://mdocml.bsd.lv/cgi-bin/cvsweb/mandoc.css Signed-off-by: Antonio Niño Díaz <antonio_nd@outlook.com>
176 lines
8.8 KiB
HTML
176 lines
8.8 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8"/>
|
|
<style>
|
|
table.head, table.foot { width: 100%; }
|
|
td.head-rtitle, td.foot-os { text-align: right; }
|
|
td.head-vol { text-align: center; }
|
|
div.Pp { margin: 1ex 0ex; }
|
|
</style>
|
|
<link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
|
|
<title>RGBGFX(1)</title>
|
|
</head>
|
|
<body>
|
|
<table class="head">
|
|
<tr>
|
|
<td class="head-ltitle">RGBGFX(1)</td>
|
|
<td class="head-vol">General Commands Manual</td>
|
|
<td class="head-rtitle">RGBGFX(1)</td>
|
|
</tr>
|
|
</table>
|
|
<div class="manual-text">
|
|
<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1>
|
|
<b class="Nm" title="Nm">rgbgfx</b> — <span class="Nd" title="Nd">Game
|
|
Boy graphics converter</span>
|
|
<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1>
|
|
<table class="Nm">
|
|
<tr>
|
|
<td><b class="Nm" title="Nm">rgbgfx</b></td>
|
|
<td>[<span class="Op"><b class="Fl" title="Fl">-DfFhPTVv</b></span>]
|
|
[<span class="Op"><b class="Fl" title="Fl">-o</b>
|
|
<var class="Ar" title="Ar">outfile</var></span>]
|
|
[<span class="Op"><b class="Fl" title="Fl">-d</b>
|
|
<var class="Ar" title="Ar">depth</var></span>]
|
|
[<span class="Op"><b class="Fl" title="Fl">-p</b>
|
|
<var class="Ar" title="Ar">palfile</var></span>]
|
|
[<span class="Op"><b class="Fl" title="Fl">-t</b>
|
|
<var class="Ar" title="Ar">mapfile</var></span>]
|
|
[<span class="Op"><b class="Fl" title="Fl">-x</b>
|
|
<var class="Ar" title="Ar">tiles</var></span>]
|
|
<var class="Ar" title="Ar">file</var></td>
|
|
</tr>
|
|
</table>
|
|
<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1>
|
|
The <b class="Nm" title="Nm">rgbgfx</b> program converts PNG images into the
|
|
Nintendo Game Boy's planar tile format.
|
|
<div style="height: 1.00em;"> </div>
|
|
The resulting colors and their palette indices are determined differently
|
|
depending on the input PNG file:
|
|
<ul class="Bl-dash">
|
|
<li class="It-dash">If the file has an embedded palette, that palette's color
|
|
and order are used.</li>
|
|
<li class="It-dash">If not, and the image only contains shades of gray, rgbgfx
|
|
maps them to the indices appropriate for each shade. Any undetermined
|
|
indices are set to respective default shades of gray. For example: if the
|
|
bit depth is 2 and the image contains light gray and black, they become
|
|
the second and fourth colors - and the first and third colors get set to
|
|
default white and dark gray. If the image has multiple shades that map to
|
|
the same index, the palette is instead determined as if the image had
|
|
color.</li>
|
|
<li class="It-dash">If the image has color (or the grayscale method failed),
|
|
the colors are sorted from lightest to darkest.</li>
|
|
</ul>
|
|
<div style="height: 1.00em;"> </div>
|
|
The input image may not contain more colors than the selected bit depth allows.
|
|
Transparent pixels are set to palette index 0.
|
|
<h1 class="Sh" title="Sh" id="ARGUMENTS"><a class="selflink" href="#ARGUMENTS">ARGUMENTS</a></h1>
|
|
<dl class="Bl-tag">
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#D"><b class="Fl" title="Fl" id="D">-D</b></a></dt>
|
|
<dd class="It-tag">Debug features are enabled.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#f"><b class="Fl" title="Fl" id="f">-f</b></a></dt>
|
|
<dd class="It-tag">Fix the input PNG file to be a correctly indexed
|
|
image.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#F"><b class="Fl" title="Fl" id="F">-F</b></a></dt>
|
|
<dd class="It-tag">Same as <b class="Fl" title="Fl">-f</b>, but additionally,
|
|
the supplied command line parameters are saved within the PNG and will be
|
|
loaded and automatically used next time.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#d"><b class="Fl" title="Fl" id="d">-d</b></a>
|
|
<var class="Ar" title="Ar">depth</var></dt>
|
|
<dd class="It-tag">The bit depth of the output image (either 1 or 2). By
|
|
default, the bit depth is 2 (two bits per pixel).</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#h"><b class="Fl" title="Fl" id="h">-h</b></a></dt>
|
|
<dd class="It-tag">Lay out tiles horizontally rather than vertically.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#o"><b class="Fl" title="Fl" id="o">-o</b></a>
|
|
<var class="Ar" title="Ar">outfile</var></dt>
|
|
<dd class="It-tag">The name of the output file.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#p"><b class="Fl" title="Fl" id="p">-p</b></a>
|
|
<var class="Ar" title="Ar">palfile</var></dt>
|
|
<dd class="It-tag">Output the image's palette in standard GBC palette format -
|
|
bytes (8 bytes for two bits per pixel, 4 bytes for one bit per pixel)
|
|
containing the RGB15 values in little-endian byte order. If the palette
|
|
contains too few colors, the remaining entries are set to black.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#P"><b class="Fl" title="Fl" id="P">-P</b></a></dt>
|
|
<dd class="It-tag">Same as <b class="Fl" title="Fl">-p</b>, but the palette
|
|
file output name is made by taking the input PNG file's filename, removing
|
|
the file extension, and appending <i class="Pa" title="Pa">.pal</i>.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#t"><b class="Fl" title="Fl" id="t">-t</b></a>
|
|
<var class="Ar" title="Ar">mapfile</var></dt>
|
|
<dd class="It-tag">If any tiles are the same, don't place the repeat tiles in
|
|
the output file, and make a tilemap file.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#T"><b class="Fl" title="Fl" id="T">-T</b></a></dt>
|
|
<dd class="It-tag">Same as <b class="Fl" title="Fl">-t</b>, but the tilemap
|
|
file output name is made by taking the input filename, removing the file
|
|
extension, and appending <i class="Pa" title="Pa">.tilemap</i>.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#u"><b class="Fl" title="Fl" id="u">-u</b></a></dt>
|
|
<dd class="It-tag">Truncate repeated tiles. Useful with tilemaps.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#V"><b class="Fl" title="Fl" id="V">-V</b></a></dt>
|
|
<dd class="It-tag">Print the version of the program and exit.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a></dt>
|
|
<dd class="It-tag">Verbose. Print errors when the command line parameters and
|
|
the parameters in the PNG file don't match.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#x"><b class="Fl" title="Fl" id="x">-x</b></a>
|
|
<var class="Ar" title="Ar">tiles</var></dt>
|
|
<dd class="It-tag">Trim the end of the output file by this many tiles.</dd>
|
|
</dl>
|
|
<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1>
|
|
The following will take a PNG file with a bit depth of 1, 2, or 8, and output
|
|
planar 2bpp data:
|
|
<div class="Pp"></div>
|
|
<div class="D1">$ rgbgfx -o out.2bpp in.png</div>
|
|
<div class="Pp"></div>
|
|
The following creates a planar 2bpp file with only unique tiles, and its tilemap
|
|
<i class="Pa" title="Pa">out.tilemap</i>:
|
|
<div class="Pp"></div>
|
|
<div class="D1">$ rgbgfx -T -u -o out.2bpp in.png</div>
|
|
<div class="Pp"></div>
|
|
The following will do nothing:
|
|
<div class="Pp"></div>
|
|
<div class="D1">$ rgbgfx in.png</div>
|
|
<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE
|
|
ALSO</a></h1>
|
|
<a class="Xr" title="Xr">rgbds(7)</a>, <a class="Xr" title="Xr">rgbasm(1)</a>,
|
|
<a class="Xr" title="Xr">rgblink(1)</a>,
|
|
<a class="Xr" title="Xr">rgbfix(1)</a>, <a class="Xr" title="Xr">gbz80(7)</a>
|
|
<h1 class="Sh" title="Sh" id="HISTORY"><a class="selflink" href="#HISTORY">HISTORY</a></h1>
|
|
<b class="Nm" title="Nm">rgbgfx</b> was created by
|
|
<span class="An" title="An">stag019</span> to be included in RGBDS. It is now
|
|
maintained by a number of contributors at
|
|
<a class="Lk" title="Lk" href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a>.</div>
|
|
<table class="foot">
|
|
<tr>
|
|
<td class="foot-date">January 26, 2018</td>
|
|
<td class="foot-os">RGBDS Manual</td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|