<?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.6.2_23";
<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>gif_save</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 section for gif_save"/>
<meta name="rh-index-keywords" content="gif_save"/>
<meta name="search-keywords" content="gif_save"/>
</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="gif_save">
<span>gif_save</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>gif_save</h1>
<p>With this function you can save out a GIF animation. You supply the GIF index (as returned by the function <a href="gif_open.htm"><tt>gif_open()</tt></a>) as well as a filename to save it with. Note that GameMaker Studio 2 does not automatically
append the <tt>.gif</tt> file extension, so you should include this as part of the filename string if you wish the saved file to be identified as a GIF. The created GIF will be palletized using the Universal 884 Palette (see <a href="https://en.wikipedia.org/wiki/List_of_software_palettes#8-8-4_levels_RGB" target="_blank">here</a> for more information).</p>
<p>Note that if the function is successful and the GIF is saved correctly, then it will return 0, otherwise it will return -1.</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code">gif_save(gif_index, fname);</p>
<table>
<tbody>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>gif_index</td>
<td>The ID of gif to save</td>
</tr>
<tr>
<td>fname</td>
<td>The filename to use for the gif</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Returns:</h4>
<p class="code">Integer</p>
<p> </p>
<h4>Example:</h4>
<p class="code">if save_gif == true<br/> {
<br/> if count == 0<br/> {
<br/> gif_image = gif_open(room_width, room_height);<br/> }
<br/> else if count < 30<br/> {
<br/> gif_add_surface(gif_image, application_surface, 6/100);<br/> }
<br/> else
<br/> {
<br/> gif_save(gif_image, "GameCapture.gif");<br/> count = 0;<br/> save_gif = false;<br/> }
<br/> count++;
<br/> }
</p>
<p>The above code will create a GIF image file with 30 frames taken from the application surface and then save it.</p>
<p> </p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div style="float:left">Back: <a href="Cameras_And_Display.htm">Cameras And Display</a></div>
<div style="float:right">Next: <a href="gif_save_buffer.htm">gif_save_buffer</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>