/usr/share/doc/sludge/SLUDGEDevKitHelp/addOverlay.html is in sludge-doc 2.2.1-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>addOverlay</TITLE>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<BODY>
<HR>
<div align="center"><img id="headerGraphic" src="images/sludge300.png" alt="SLUDGE"/></div>
<h2>addOverlay</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">addOverlay (<i>thisFile, atX, atY</i>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Loads an image from the file handle <i>thisFile</i> and overlays it onto the screen.
Bright magenta (255, 0, 255 or #FF00FF) is used as the transparency colour
(except for 32-bit images, where the alpha channel is used!), making it
possible to add irregular shapes.
</P>
<P>
The values <i>atX</i> and <i>atY</i> define the top left corner of the area into which the image will be added. If the value of <i>atX</i> is CENTRE (or CENTER) the image will be added halfway across the window. If the value of <i>atY</i> is CENTRE (or CENTER) the image will be added halfway down the window.
</P>
<H3>Return value:</H3>
<P>
No return value.
</P>
<H3>Example:</H3>
<P>
<pre>sub init () {
addOverlay ('someImage.tga', CENTER, CENTER);
}</pre>
</P>
<H3>See also:</H3>
<P>
<a href="File_Handling.html">File Handling</a>
</P>
<P>
<a href="The_Background_Image.html">The Background Image</a>
</P>
<P>
<a href="darkBackground.html">darkBackground</a>
</P>
<P>
<a href="mixOverlay.html">mixOverlay</a>
</P>
<p>
<a href="parallaxAdd.html">parallaxAdd</a>
</p>
<P class="copyright-notice">SLUDGE and this SLUDGE documentation are <A HREF="Copyright.html">copyright</A> Hungry Software and contributors 2000-2012
</P>
<HR>
</BODY>
</html>
|