<?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_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>gif_open</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_open"/>
<meta name="rh-index-keywords" content="gif_open"/>
<meta name="search-keywords" content="gif_open"/>
</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_open">
<span>gif_open</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_open</h1>
<p>With this function you can create an empty GIF format image, ready to have data added to it. When you call the function, you need to specify the width and height of the gif (in pixels, and there is no upper limit on size except for available memory),
and the function will return the unique ID value used to identify the gift in subsequent functions, or it will return -1 if the gif could not be initialized (for example, if the width/height are too big for the memory available). You may also specify
an optional argument to set the "clear colour" for the gif. This is an RGB value (no alpha component), and will clear the gif to this colour before anything is added to it. If you do not supply a clear colour argument, the default colour
of black will be used.</p>
<p>Note that when using this function you must call <a href="gif_save.htm"><tt>gif_save()</tt></a> to end the creation of the gif before open another file for recording (so for every <tt>gif_open()</tt> there must be an accompanying <tt>gif_save()</tt>).</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code">gif_open(width, height, [clear_colour]);</p>
<table>
<tbody>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>width</td>
<td>The width of the gif to create</td>
</tr>
<tr>
<td>height</td>
<td>The height of the gif to create</td>
</tr>
<tr>
<td>[clear_colour]</td>
<td>[<b>Optional</b>] The colour (RGB) to clear the gif to</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"><a href="Cameras_And_Display.htm">Cameras And Display</a>
<div style="float:left">Back: </div>
<div style="float:right">Next: <a href="gif_add_surface.htm">gif_add_surface</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>