/usr/share/doc/sludge/SLUDGEDevKitHelp/snapshotGrab.html is in sludge-doc 2.2-1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>snapshotGrab</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>snapshotGrab</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">snapshotGrab ();</pre>
</P>
<H3>Purpose:</H3>
<P>
Takes a snapshot of whatever is currently on the screen (or rather, the area of <a href="The_Background_Image.html">background image</a> that's currently visible, plus any characters on it - in other words, what the screen will look like the next time it is drawn provided nothing changes in the meantime).
</P>
<P>
This snapshot can then be used to crossfade one image into another, or even one room into another. To achieve this use the CROSSFADE transition mode and gradually change the transition level from 0 to 256 using the <a href="transitionMode_and_transitionLevel.html">transitionMode and transitionLevel</a> functions.
</P>
<P>
When you no longer need your snapshot image, use <a href="snapshotClear.html">snapshotClear</a> to remove it from memory.
</P>
<H3>Return value:</H3>
<P>
No return value.
</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>
|