Skip to content

Commit

Permalink
Last updates to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@lronaldo
lronaldo committed Oct 17, 2015
1 parent 123115d commit 645e3e1
Show file tree
Hide file tree
Showing 8 changed files with 184 additions and 184 deletions.
2 changes: 1 addition & 1 deletion cpctelera/docs/files/commandline/cpct_img2tileset-.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@



<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="cpct_img2tileset"></a>cpct_img2tileset</h1><div class=CBody><p>Converts an image file with a set of tile or sprite images into a CPCtelera C-array tileset along with arrays for all tiles/sprites.</p><h4 class=CHeading>Usage</h4><p><a href="#cpct_img2tileset" class=LFile id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">cpct_img2tileset</a> [options] [image_file]</p><h4 class=CHeading>Requisites</h4><p>This scripts uses Img2CPC utility by Augusto Ruiz to convert the PNG file into screen pixel definitions.&nbsp; This requires freeimage libraries to be installed under Linux and MacOSX (they are already included for Windows/Cygwin)</p><h4 class=CHeading>Description</h4><p>This script converts an image file containing a set of tile or sprite definitions of the same size into 2 files (.c and .h) ready to be passed to the C compiler for inclusion into a program.&nbsp; By default, this script converts the image into 4x4-pixel tiles.&nbsp; This means that the script splits the whole image into 4x4-pixel individual images and converts each one of them into a tile.&nbsp; You may change sizes by using -tw / -th command line modifiers.&nbsp; Generated output contains screen-pixel-format defined arrays with all the individual sprites extracted from the image file.&nbsp; It also contains an aditional array, named _tileset, with pointers to all generated tiles/sprites.&nbsp; This tileset array may be optinally not generated with -nt | --no-tileset modifier.&nbsp; To do the conversion, the script calls Img2CPC, which reads pixels one by one and transform them into the closest colour value from the defined Amstrad CPC palette.&nbsp; If no palette is given to this script, standard Amstrad CPC palette is used (the one that is set when a CPC computer starts).&nbsp; Provided image file may be a PNG, JPG, BMP, GIF or TIFF file.</p><h4 class=CHeading>Command line options</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>-pf | --palette-firmware &lt;palete_array&gt;</td><td class=CDLDescription>Sets the Amstrad CPC palette to be used for the conversion as an array of firmware colour values (up to 16, in mode 0).&nbsp; Values must be passed inside &lsquo;{&lsquo; &lsquo;}&rsquo; and separated by spaces.&nbsp; Following example sets mode 1 palette to Black, white, red and green colours, to convert the file tiles.png,</td></tr></table><blockquote><pre>cpct_img2tileset -m 1 -pf { 0 26 6 18 } tiles.png</pre></blockquote><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>-nt | --no-tileset</td><td class=CDLDescription>Do not generate a tileset array containing pointers to generated sprites/tiles.</td></tr><tr><td class=CDLEntry>-im | --interlaced-masks &lt;transp_idx&gt;</td><td class=CDLDescription>Generates transparent sprites with interlaced masks using &lt;trasnp_idx&gt; as the index of the palette colour to be considered transparent</td></tr><tr><td class=CDLEntry>-bn | --tiles-basename &lt;name&gt;</td><td class=CDLDescription>Sets the basename that will be used as C identifier for tiles or sprites.&nbsp; Default: g_tile</td></tr><tr><td class=CDLEntry>-m | --mode &lt;cpc_graphics_mode&gt;</td><td class=CDLDescription>Sets the CPC Graphics mode the output data will be produced for (0, 1 or 2).&nbsp; Default: 0.</td></tr><tr><td class=CDLEntry>-tw | --tile-width &lt;pixels&gt;</td><td class=CDLDescription>Sets the width of a tile in pixels.&nbsp; Default: 4.</td></tr><tr><td class=CDLEntry>-th | --tile-height &lt;pixels&gt;</td><td class=CDLDescription>Sets the height of a tile in pixels.&nbsp; Default: 4.</td></tr><tr><td class=CDLEntry>-h | --help</td><td class=CDLDescription>Shows help information on the terminal.</td></tr></table></div></div></div>
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="cpct_img2tileset"></a>cpct_img2tileset</h1><div class=CBody><p>Converts an image file with a set of tile or sprite images into a CPCtelera C-array tileset along with arrays for all tiles/sprites.</p><h4 class=CHeading>Usage</h4><p><a href="#cpct_img2tileset" class=LFile id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">cpct_img2tileset</a> [options] [image_file]</p><h4 class=CHeading>Requisites</h4><p>This scripts uses Img2CPC utility by Augusto Ruiz to convert the PNG file into screen pixel definitions.&nbsp; This requires freeimage libraries to be installed under Linux and MacOSX (they are already included for Windows/Cygwin)</p><h4 class=CHeading>Description</h4><p>This script converts an image file containing a set of tile or sprite definitions of the same size into 2 files (.c and .h) ready to be passed to the C compiler for inclusion into a program.&nbsp; By default, this script converts the image into 4x4-pixel tiles.&nbsp; This means that the script splits the whole image into 4x4-pixel individual images and converts each one of them into a tile.&nbsp; You may change sizes by using -tw / -th command line modifiers.&nbsp; Generated output contains screen-pixel-format defined arrays with all the individual sprites extracted from the image file.&nbsp; It also contains an aditional array, named _tileset, with pointers to all generated tiles/sprites.&nbsp; This tileset array may be optinally not generated with -nt | --no-tileset modifier.&nbsp; To do the conversion, the script calls Img2CPC, which reads pixels one by one and transform them into the closest colour value from the defined Amstrad CPC palette.&nbsp; If no palette is given to this script, standard Amstrad CPC palette is used (the one that is set when a CPC computer starts).&nbsp; Provided image file may be a PNG, JPG, BMP, GIF or TIFF file.</p><h4 class=CHeading>Command line options</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>-pf | --palette-firmware &lt;palete_array&gt;</td><td class=CDLDescription>Sets the Amstrad CPC palette to be used for the conversion as an array of firmware colour values (up to 16, in mode 0).&nbsp; Values must be passed inside &lsquo;{&lsquo; &lsquo;}&rsquo; and separated by spaces.&nbsp; Following example sets mode 1 palette to Black, white, red and green colours, to convert the file tiles.png,</td></tr></table><blockquote><pre>cpct_img2tileset -m 1 -pf { 0 26 6 18 } tiles.png</pre></blockquote><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>-nt | --no-tileset</td><td class=CDLDescription>Do not generate a tileset array containing pointers to generated sprites/tiles.</td></tr><tr><td class=CDLEntry>-im | --interlaced-masks</td><td class=CDLDescription>Generates transparent sprites with interlaced masks using 0 as the index of the palette colour to be considered transparent</td></tr><tr><td class=CDLEntry>-bn | --tiles-basename &lt;name&gt;</td><td class=CDLDescription>Sets the basename that will be used as C identifier for tiles or sprites.&nbsp; Default: g_tile</td></tr><tr><td class=CDLEntry>-m | --mode &lt;cpc_graphics_mode&gt;</td><td class=CDLDescription>Sets the CPC Graphics mode the output data will be produced for (0, 1 or 2).&nbsp; Default: 0.</td></tr><tr><td class=CDLEntry>-tw | --tile-width &lt;pixels&gt;</td><td class=CDLDescription>Sets the width of a tile in pixels.&nbsp; Default: 4.</td></tr><tr><td class=CDLEntry>-th | --tile-height &lt;pixels&gt;</td><td class=CDLDescription>Sets the height of a tile in pixels.&nbsp; Default: 4.</td></tr><tr><td class=CDLEntry>-h | --help</td><td class=CDLDescription>Shows help information on the terminal.</td></tr></table></div></div></div>

</div><!--Content-->

Expand Down
114 changes: 57 additions & 57 deletions cpctelera/docs/javascript/searchdata.js
View file
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@
var indexSectionsWithContent = {
"General": {
"Types": {
"Symbols": false,
"Numbers": true,
"Numbers": false,
"A": true,
"B": false,
"C": true,
"D": true,
"E": true,
"D": false,
"E": false,
"F": true,
"G": true,
"H": true,
"G": false,
"H": false,
"I": true,
"J": false,
"K": true,
"L": true,
"M": true,
"K": false,
"L": false,
"M": false,
"N": false,
"O": false,
"P": true,
"P": false,
"Q": false,
"R": true,
"S": true,
"T": true,
"R": false,
"S": false,
"T": false,
"U": true,
"V": true,
"W": true,
"V": false,
"W": false,
"X": false,
"Y": false,
"Z": false
},
"Constants": {
"Functions": {
"Symbols": false,
"Numbers": false,
"A": true,
"A": false,
"B": false,
"C": true,
"D": false,
"E": false,
"F": true,
"G": true,
"F": false,
"G": false,
"H": false,
"I": false,
"J": false,
"K": false,
"L": false,
"L": true,
"M": false,
"N": false,
"O": false,
Expand All @@ -52,58 +52,58 @@ var indexSectionsWithContent = {
"R": false,
"S": false,
"T": false,
"U": false,
"V": true,
"U": true,
"V": false,
"W": false,
"X": false,
"Y": false,
"Z": false
},
"Variables": {
"General": {
"Symbols": false,
"Numbers": false,
"A": false,
"Numbers": true,
"A": true,
"B": false,
"C": true,
"D": true,
"E": false,
"F": false,
"G": false,
"H": false,
"I": false,
"E": true,
"F": true,
"G": true,
"H": true,
"I": true,
"J": false,
"K": false,
"L": false,
"M": false,
"K": true,
"L": true,
"M": true,
"N": false,
"O": false,
"P": false,
"P": true,
"Q": false,
"R": false,
"S": false,
"T": false,
"U": false,
"V": false,
"W": false,
"R": true,
"S": true,
"T": true,
"U": true,
"V": true,
"W": true,
"X": false,
"Y": false,
"Z": false
},
"Functions": {
"Constants": {
"Symbols": false,
"Numbers": false,
"A": false,
"A": true,
"B": false,
"C": true,
"D": false,
"E": false,
"F": false,
"G": false,
"F": true,
"G": true,
"H": false,
"I": false,
"J": false,
"K": false,
"L": true,
"L": false,
"M": false,
"N": false,
"O": false,
Expand All @@ -112,20 +112,20 @@ var indexSectionsWithContent = {
"R": false,
"S": false,
"T": false,
"U": true,
"V": false,
"U": false,
"V": true,
"W": false,
"X": false,
"Y": false,
"Z": false
},
"Macros": {
"Variables": {
"Symbols": false,
"Numbers": false,
"A": false,
"B": false,
"C": true,
"D": false,
"D": true,
"E": false,
"F": false,
"G": false,
Expand All @@ -149,10 +149,10 @@ var indexSectionsWithContent = {
"Y": false,
"Z": false
},
"Files": {
"Macros": {
"Symbols": false,
"Numbers": false,
"A": true,
"A": false,
"B": false,
"C": true,
"D": false,
Expand All @@ -173,24 +173,24 @@ var indexSectionsWithContent = {
"S": false,
"T": false,
"U": false,
"V": true,
"V": false,
"W": false,
"X": false,
"Y": false,
"Z": false
},
"Types": {
"Files": {
"Symbols": false,
"Numbers": false,
"A": true,
"B": false,
"C": true,
"D": false,
"E": false,
"F": true,
"F": false,
"G": false,
"H": false,
"I": true,
"I": false,
"J": false,
"K": false,
"L": false,
Expand All @@ -202,8 +202,8 @@ var indexSectionsWithContent = {
"R": false,
"S": false,
"T": false,
"U": true,
"V": false,
"U": false,
"V": true,
"W": false,
"X": false,
"Y": false,
Expand Down
Binary file modified cpctelera/docs/nd/Data/ConfigFileInfo.nd
View file
Binary file not shown.
Loading

0 comments on commit 645e3e1

Please sign in to comment.