1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 4 <head> 5 <meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" /> 6 <meta name="generator" content="JsDoc Toolkit" /> 7 {! Link.base = "../"; /* all generated links will be relative to this */ !} 8 <title>glMatrix - {+data.alias+}</title> 9 10 <style type="text/css"> 11 {+include("static/default.css")+} 12 </style> 13 </head> 14 15 <body> 16 <!-- ============================== header ================================= --> 17 <!-- begin static/header.html --> 18 {+include("static/header.html")+} 19 <!-- end static/header.html --> 20 21 <div class="wrapper"> 22 <!-- ============================== classes index ============================ --> 23 <header id="index"> 24 <!-- begin publish.classesIndex --> 25 {+publish.classesIndex+} 26 <!-- end publish.classesIndex --> 27 </header> 28 29 <section id="content"> 30 <!-- ============================== class title ============================ --> 31 <h1 class="classTitle"> 32 {! 33 var classType = ""; 34 35 if (data.isBuiltin()) { 36 classType += "Built-In "; 37 } 38 39 if (data.isNamespace) { 40 if (data.is('FUNCTION')) { 41 classType += "Function "; 42 } 43 classType += "Namespace "; 44 } 45 else { 46 classType += "Class "; 47 } 48 !} 49 {+classType+}{+data.alias+} 50 </h1> 51 52 <!-- ============================== class summary ========================== --> 53 <p class="description"> 54 <if test="data.version"><br />Version 55 {+ data.version +}.<br /> 56 </if> 57 <if test="data.augments.length"><br />Extends 58 {+ 59 data.augments 60 .sort() 61 .map( 62 function($) { return new Link().toSymbol($); } 63 ) 64 .join(", ") 65 +}.<br /> 66 </if> 67 68 {+resolveLinks(data.classDesc)+} 69 70 <if test="data.desc"> 71 <div class="description">{+resolveLinks(summarize(data.desc))+}</div> 72 </if> 73 74 <if test="!data.isBuiltin()">{# isn't defined in any file #} 75 <br /><i>Defined in: </i> {+new Link().toSrc(data.srcFile)+}. 76 </if> 77 </p> 78 79 <!-- ============================== properties summary ===================== --> 80 <if test="data.properties.length"> 81 {! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} 82 <if test="ownProperties.length"> 83 <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class {+data.alias+}."> 84 <caption>Field Summary</caption> 85 <thead> 86 <tr> 87 <th scope="col">Field Attributes</th> 88 <th scope="col">Field Name and Description</th> 89 </tr> 90 </thead> 91 <tbody> 92 <for each="member" in="ownProperties"> 93 <tr> 94 <td class="attributes">{! 95 if (member.isPrivate) output += "<private> "; 96 if (member.isInner) output += "<inner> "; 97 if (member.isStatic) output += "<static> "; 98 if (member.isConstant) output += "<constant> "; 99 !} </td> 100 <td class="nameDescription"> 101 <div class="fixedFont"> 102 <if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b> 103 </div> 104 <div class="description">{+resolveLinks(summarize(member.desc))+}</div> 105 </td> 106 </tr> 107 </for> 108 </tbody> 109 </table> 110 </if> 111 112 <if test="data.inheritsFrom.length"> 113 <dl class="inheritsList"> 114 {! 115 var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias}); 116 117 var contributers = []; 118 borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); 119 for (var i = 0, l = contributers.length; i < l; i++) { 120 output += 121 "<dt>Fields borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>" 122 + 123 "<dd>" + 124 borrowedMembers 125 .filter( 126 function($) { return $.memberOf == contributers[i] } 127 ) 128 .sort(makeSortby("name")) 129 .map( 130 function($) { return new Link().toSymbol($.alias).withText($.name) } 131 ) 132 .join(", ") 133 + 134 "</dd>"; 135 } 136 !} 137 </dl> 138 </if> 139 </if> 140 141 <!-- ============================== methods summary ======================== --> 142 <if test="data.methods.length"> 143 {! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} 144 <if test="ownMethods.length"> 145 <h2>Methods</h2> 146 <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class {+data.alias+}."> 147 <tbody> 148 <for each="member" in="ownMethods"> 149 <tr> 150 <td class="nameDescription"> 151 <code class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, ''))+}</b>{+makeSignature(member.params)+} 152 </code> 153 <div class="description">{+resolveLinks(summarize(member.desc))+}</div> 154 </td> 155 </tr> 156 </for> 157 </tbody> 158 </table> 159 </if> 160 </if> 161 162 <!-- ============================== field details ========================== --> 163 <if test="defined(ownProperties) && ownProperties.length"> 164 <div class="sectionTitle"> 165 Field Detail 166 </div> 167 <for each="member" in="ownProperties"> 168 <a name="{+Link.symbolNameToLinkName(member)+}"> </a> 169 <div class="fixedFont">{! 170 if (member.isPrivate) output += "<private> "; 171 if (member.isInner) output += "<inner> "; 172 if (member.isStatic) output += "<static> "; 173 if (member.isConstant) output += "<constant> "; 174 !} 175 176 <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if> 177 <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b> 178 179 </div> 180 <div class="description"> 181 {+resolveLinks(member.desc)+} 182 <if test="member.srcFile != data.srcFile"> 183 <br /> 184 <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}. 185 </if> 186 <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if> 187 </div> 188 189 <if test="member.example.length"> 190 <for each="example" in="member.example"> 191 <pre class="code">{+example+}</pre> 192 </for> 193 </if> 194 195 <if test="member.deprecated"> 196 <dl class="detailList"> 197 <dt class="heading">Deprecated:</dt> 198 <dt> 199 {+ resolveLinks(member.deprecated) +} 200 </dt> 201 </dl> 202 </if> 203 <if test="member.since"> 204 <dl class="detailList"> 205 <dt class="heading">Since:</dt> 206 <dd>{+ member.since +}</dd> 207 </dl> 208 </if> 209 <if test="member.see.length"> 210 <dl class="detailList"> 211 <dt class="heading">See:</dt> 212 <for each="item" in="member.see"> 213 <dd>{+ new Link().toSymbol(item) +}</dd> 214 </for> 215 </dl> 216 </if> 217 <if test="member.defaultValue"> 218 <dl class="detailList"> 219 <dt class="heading">Default Value:</dt> 220 <dd> 221 {+resolveLinks(member.defaultValue)+} 222 </dd> 223 </dl> 224 </if> 225 226 <if test="!$member_last"><hr /></if> 227 </for> 228 </if> 229 230 <!-- ============================== method details ========================= --> 231 <if test="defined(ownMethods) && ownMethods.length"> 232 <h2>Method Detail</h2> 233 <for each="member" in="ownMethods"> 234 <a name="{+Link.symbolNameToLinkName(member)+}"> </a> 235 <h3 class="fixedFont"> 236 <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if> 237 <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name.replace(/\^\d+$/, '')+}</b>{+makeSignature(member.params)+} 238 </h3> 239 240 <div style="margin-left: 1em;"> 241 <p class="description"> 242 {+resolveLinks(member.desc)+} 243 <if test="member.srcFile != data.srcFile"> 244 <br /> 245 <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}. 246 </if> 247 <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if> 248 </p> 249 250 <if test="member.example.length"> 251 <for each="example" in="member.example"> 252 <pre class="code">{+example+}</pre> 253 </for> 254 </if> 255 256 <if test="member.params.length"> 257 <dl class="detailList"> 258 <dt class="heading">Parameters:</dt> 259 <for each="item" in="member.params"> 260 <dt> 261 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b> 262 <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if> 263 </dt> 264 <dd>{+resolveLinks(item.desc)+}</dd> 265 </for> 266 </dl> 267 </if> 268 <if test="member.deprecated"> 269 <dl class="detailList"> 270 <dt class="heading">Deprecated:</dt> 271 <dt> 272 {+ resolveLinks(member.deprecated) +} 273 </dt> 274 </dl> 275 </if> 276 <if test="member.since"> 277 <dl class="detailList"> 278 <dt class="heading">Since:</dt> 279 <dd>{+ member.since +}</dd> 280 </dl> 281 </dl> 282 </if> 283 <if test="member.exceptions.length"> 284 <dl class="detailList"> 285 <dt class="heading">Throws:</dt> 286 <for each="item" in="member.exceptions"> 287 <dt> 288 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b> 289 </dt> 290 <dd>{+resolveLinks(item.desc)+}</dd> 291 </for> 292 </dl> 293 </if> 294 <if test="member.returns.length"> 295 <dl class="detailList"> 296 <dt class="heading">Returns:</dt> 297 <for each="item" in="member.returns"> 298 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd> 299 </for> 300 </dl> 301 </if> 302 <if test="member.requires.length"> 303 <dl class="detailList"> 304 <dt class="heading">Requires:</dt> 305 <for each="item" in="member.requires"> 306 <dd>{+ resolveLinks(item) +}</dd> 307 </for> 308 </dl> 309 </if> 310 <if test="member.see.length"> 311 <dl class="detailList"> 312 <dt class="heading">See:</dt> 313 <for each="item" in="member.see"> 314 <dd>{+ new Link().toSymbol(item) +}</dd> 315 </for> 316 </dl> 317 </if> 318 319 <if test="!$member_last"><hr /></if> 320 </div> 321 </for> 322 </if> 323 324 <hr /> 325 </section> 326 327 328 <!-- ============================== footer ================================= --> 329 <footer> 330 <small> 331 <if test="JSDOC.opt.D.copyright">©{+JSDOC.opt.D.copyright+}<br /></if> 332 Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+} 333 <br/><br/> 334 Theme based on Github Pages template by <a href="https://github.com/orderedlist">orderedlist</a> 335 </small> 336 </footer> 337 338 </div> 339 </body> 340 </html> 341
