<?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.19.0_19";
<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>gml_pragma</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 page for gml_pragma"/>
<meta name="rh-index-keywords" content="gml_pragma"/>
<meta name="search-keywords" content="gml_pragma"/>
</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="gml_pragma">
<span>gml_pragma</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>gml_pragma</h1>
<p>The <tt>gml_pragma</tt> function affects how the given target compiles your code and should be called with the different commands to further optimise the final compilation of your project. These commands are effectively <i>pre-processed</i> before the
game is compiled and so the function can be placed anywhere in your project and it will still be processed before the game is fully compiled. The available commands are as follows:</p>
<ul class="colour">
<li>"<b>forceinline</b>" - When the function is called with the "forceinline" pragma in a <b>script function</b>, the YYC will compile the project with the function inline, rather than referenced. This will give a further processing
boost, but care must be taken when using it as it will also inflate the final executable file size, especially if the in-lined code is large and/or used in multiple different places, as well as greatly increase the compile time. Note that this pragma
is <b>only valid when building using the YYC</b>.</li>
<li>"<b>global</b>", "<b>[gml code]</b>" - The "global" pragma permits you to call some GML code formatted as a string, at a <b>global</b> scope, at compile time, before the first room of the game executes. For example:<br/>
<p class="code">gml_pragma("global", "Init()");</p>
This will call the script function "Init" before the first room of the game is run. Note that the GML supplied as the second argument <b>must be a compile time constant</b>, and also note that you cannot use this pragma to create instances
or perform any operations that require a room (or anything in a room) to function.</li>
<li>"<b>PNGCrush</b>" - The "PNGCrush" pragma will use the <a href="https://pmt.sourceforge.io/pngcrush/" target="_blank">PNGCrush</a> program on each texture created. Note that this can add significantly to the time that it takes
to compile the game, so you don't want it on all the time, although it can make significant savings on final file size.</li>
<li>"<b>Texgroup.Scale</b>", "<b>[TextureGroupName]</b>", "<b>[Scale Divisor]</b>" - The "Texgroup.Scale" will scale the given texture group on compile. You need to give an additional two arguments here: the "[TexGroupName]",
which is the name (a string) of the texture group to scale, and the "[Scale Divisor]" (also a string), which is the divisor you wish to use for the scaling, i.e:<br/>
<p class="code">gml_pragma("Texgroup.Scale", "level1", "2");</p>
This will half all the textures in the "level1" texture group.</li>
<li>"<b>UnityBuild</b>", "<b>[enable/disable]</b>" - If you call the function with this pragma and set the enable/disable argument to <tt>true</tt> then on compile it will collapse all the .cpp files in the project into a single file
which it then uses to build everything, for example:<br/>
<p class="code">gml_pragma("UnityBuild", "true");</p>
The benefit of doing a unity build is that builds are faster but the down side is that it does a <i>full</i> build each time so even if you change a single part of the code it will build everything again without using any cached files. This has
been added specifically for the Xbox One export using the YYC although it can be called for other builds (<b>YYC only</b>). For more information on unity builds, please see <a href="http://buffered.io/posts/the-magic-of-unity-builds/" target="_blank">here</a>.</li>
</ul>
<p class="note"><b>NOTE</b>: The first argument to the <tt>gml_pragma</tt> function <b>must be a compile time string constant</b> and not a variable.</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code">gml_pragma(command, [optional...]);</p>
<table>
<tbody>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>command</td>
<td>A string with one of the commands listed below.</td>
</tr>
<tr>
<td>[optional]</td>
<td>Some of the available commands require an optional argument or arguments. These are explained below for each command.</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Returns:</h4>
<p class="code">N/A</p>
<p> </p>
<h4>Example:</h4>
<p class="code">gml_pragma("forceinline");</p>
<p>The above example code will force the script function where it is used to be in-lined on compile.</p>
<p> </p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div style="float:left">Back: <a href="OS_And_Compiler.htm">OS And Compiler</a></div>
<div style="float:right">Next: <a href="parameter_count.htm">parameter_count</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>