<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head>
<script type="text/javascript" language="JavaScript">
function reDo() {
if (innerWidth != origWidth || innerHeight != origHeight)
location.reload();
}
if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {
origWidth = innerWidth;
origHeight = innerHeight;
onresize = reDo;
}
onerror = null;
</script>
<style type="text/css">
< !-- div.WebHelpPopupMenu {
position: absolute;
left: 0px;
top: 0px;
z-index: 4;
visibility: hidden;
}
p.WebHelpNavBar {
text-align: right;
}
-->
</style>
<script type="text/javascript">
gRootRelPath = "../../../..";
gCommonRootRelPath = "../../../..";
gTopicId = "9.2.5.8.0_21";
<script type="text/javascript" src="../../../../template/scripts/rh.min.js"></script>
<script type="text/javascript" src="../../../../template/scripts/common.min.js"></script>
<script type="text/javascript" src="../../../../template/scripts/topic.min.js"></script>
<script type="text/javascript" src="../../../../template/scripts/topicwidgets.min.js"></script>
<script type="text/javascript" src="../../../../whxdata/projectsettings.js"></script>
<link rel="stylesheet" type="text/css" href="../../../../template/styles/topic.min.css"/>
<link rel="stylesheet" type="text/css" href="../../../../template/Charcoal_Grey/topicheader.css"/>
<meta name="topic-status" content="Draft"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>surface_save_part</title>
<meta name="generator" content="Adobe RoboHelp 2019"/>
<link rel="stylesheet" href="../../../../assets/css/default.css" type="text/css"/>
<meta name="rh-authors" content="Mark Alexander"/>
<meta name="topic-comment" content="Reference for surface_save_part"/>
<meta name="rh-index-keywords" content="surface_save_part"/>
<meta name="search-keywords" content="surface_save_part"/>
</head>
<body>
<div class="topic-header rh-hide" id="rh-topic-header" onclick="rh._.goToFullLayout()">
<div class="logo">
</div>
<div class="nav">
<div class="title" title="surface_save_part">
<span>surface_save_part</span>
</div>
<div class="gotohome" title="Click here to see this page in full context">
<span>Click here to see this page in full context</span>
</div>
</div>
</div>
<div class="topic-header-shadow rh-hide" id="rh-topic-header-shadow"></div>
<h1>surface_save_part</h1>
<p>This function will save a part of a surface to disc using the given filename. The surface <i>must</i> be saved as a <tt>*.png</tt> format file, and the (x,y) position must be given as local coordinates to the surface, bearing in mind that the top left
corner of the surface is always (0,0).</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code">surface_save_part(surface_id, fname, x, y, width, height);</p>
<table>
<tbody>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>surface_id</td>
<td>The ID of the surface to set as the drawing target.</td>
</tr>
<tr>
<td>fname</td>
<td>The name of the saved image file.</td>
</tr>
<tr>
<td>x</td>
<td>The starting x position within the surface.</td>
</tr>
<tr>
<td>y</td>
<td>The starting y position within the surface.</td>
</tr>
<tr>
<td>width</td>
<td>The width of the part to save.</td>
</tr>
<tr>
<td>height</td>
<td>The height of the part to save.</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Returns:</h4>
<p class="code">N/A</p>
<p> </p>
<h4>Example:</h4>
<p class="code">if keyboard_check_pressed(ord("S")<br/> {
<br/> surface_save_part(surf, "test.png", 0, 0, 100, 100);<br/> }
</p>
<p>The above code will check to see if the user presses the "S" key on the keyboard and if they do it will save a part of the surface indexed in the variable "surf" to disc.</p>
<p> </p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div style="float:left">Back: <a href="Surfaces.htm">Surfaces</a></div>
<div style="float:right">Next: <a href="draw_surface.htm">draw_surface</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>