<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Assimp: assimp.hpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Assimp
 <span id="projectnumber">v2.0 (November 2010)</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">assimp.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Defines the C++-API to the Open Asset Import Library.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_assimp_1_1_importer.html">Assimp::Importer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">CPP-API: The <a class="el" href="class_assimp_1_1_importer.html" title="CPP-API: The Importer class forms an C++ interface to the functionality of the Open Asset Import Libr...">Importer</a> class forms an C++ interface to the functionality of the Open Asset Import Library. <a href="class_assimp_1_1_importer.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespace_assimp"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_assimp.html">Assimp</a></td></tr>
<tr class="memdesc:namespace_assimp"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="namespace_assimp.html" title="Assimp's CPP-API and all internal APIs.">Assimp</a>'s CPP-API and all internal APIs. <br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:adb9160ea5bf307fd2ee2b1fb945a4468"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="assimp_8hpp.html#adb9160ea5bf307fd2ee2b1fb945a4468">AI_PROPERTY_WAS_NOT_EXISTING</a>   0xffffffff</td></tr>
<tr class="memdesc:adb9160ea5bf307fd2ee2b1fb945a4468"><td class="mdescLeft"> </td><td class="mdescRight">namespace <a class="el" href="namespace_assimp.html" title="Assimp's CPP-API and all internal APIs.">Assimp</a> <a href="#adb9160ea5bf307fd2ee2b1fb945a4468"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a590ab8b19137bc0fe4af1f404334beeb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ai_defines_8h.html#a7d617d307e656cb6ff315ba71ff958d4">ASSIMP_API</a> const <a class="el" href="structai_scene.html">aiScene</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="assimp_8hpp.html#a590ab8b19137bc0fe4af1f404334beeb">aiImportFileEx</a> (const char *, unsigned int, <a class="el" href="structai_file_i_o.html">aiFileIO</a> *)</td></tr>
<tr class="memitem:a606c1b173463d78f2ae4bd114673fa95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ai_defines_8h.html#a7d617d307e656cb6ff315ba71ff958d4">ASSIMP_API</a> const <a class="el" href="structai_scene.html">aiScene</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="assimp_8hpp.html#a606c1b173463d78f2ae4bd114673fa95">aiImportFileFromMemory</a> (const char *, unsigned int, unsigned int, const char *)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines the C++-API to the Open Asset Import Library. </p>
</div><hr/><h2>Macro Definition Documentation</h2>
<a class="anchor" id="adb9160ea5bf307fd2ee2b1fb945a4468"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AI_PROPERTY_WAS_NOT_EXISTING   0xffffffff</td>
</tr>
</table>
</div><div class="memdoc">
<p>namespace <a class="el" href="namespace_assimp.html" title="Assimp's CPP-API and all internal APIs.">Assimp</a> </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a590ab8b19137bc0fe4af1f404334beeb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ai_defines_8h.html#a7d617d307e656cb6ff315ba71ff958d4">ASSIMP_API</a> const <a class="el" href="structai_scene.html">aiScene</a>* aiImportFileEx </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>int</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structai_file_i_o.html">aiFileIO</a> * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>If the call succeeds, the imported data is returned in an <a class="el" href="structai_scene.html" title="The root structure of the imported data.">aiScene</a> structure. The data is intended to be read-only, it stays property of the ASSIMP library and will be stable until <a class="el" href="assimp_8h.html#a00a8db599403d4972ce70d97b9219080" title="Releases all resources associated with the given import process.">aiReleaseImport()</a> is called. After you're done with it, call <a class="el" href="assimp_8h.html#a00a8db599403d4972ce70d97b9219080" title="Releases all resources associated with the given import process.">aiReleaseImport()</a> to free the resources associated with this file. If the import fails, NULL is returned instead. Call <a class="el" href="assimp_8h.html#abe72551b74cc4bc3c49349ce3014bc9b" title="Returns the error text of the last failed import process.">aiGetErrorString()</a> to retrieve a human-readable error text. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">pFile</td><td>Path and filename of the file to be imported, expected to be a null-terminated c-string. NULL is not a valid value. </td></tr>
<tr><td class="paramname">pFlags</td><td>Optional post processing steps to be executed after a successful import. Provide a bitwise combination of the <a class="el" href="ai_post_process_8h.html#a64795260b95f5a4b3f3dc1be4f52e410" title="Defines the flags for all possible post processing steps.">aiPostProcessSteps</a> flags. </td></tr>
<tr><td class="paramname">pFS</td><td><a class="el" href="structai_file_i_o.html" title="C-API: File system callbacks.">aiFileIO</a> structure. Will be used to open the model file itself and any other files the loader needs to open. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>Pointer to the imported data or NULL if the import failed. </dd></dl>
<dl class="section note"><dt>Note:</dt><dd>Include <<a class="el" href="ai_file_i_o_8h.html" title="Defines generic C routines to access memory-mapped files.">aiFileIO.h</a>> for the definition of <a class="el" href="structai_file_i_o.html" title="C-API: File system callbacks.">aiFileIO</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a606c1b173463d78f2ae4bd114673fa95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ai_defines_8h.html#a7d617d307e656cb6ff315ba71ff958d4">ASSIMP_API</a> const <a class="el" href="structai_scene.html">aiScene</a>* aiImportFileFromMemory </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>int</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>int</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>If the call succeeds, the contents of the file are returned as a pointer to an <a class="el" href="structai_scene.html" title="The root structure of the imported data.">aiScene</a> object. The returned data is intended to be read-only, the importer keeps ownership of the data and will destroy it upon destruction. If the import fails, NULL is returned. A human-readable error description can be retrieved by calling <a class="el" href="assimp_8h.html#abe72551b74cc4bc3c49349ce3014bc9b" title="Returns the error text of the last failed import process.">aiGetErrorString()</a>. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">pBuffer</td><td>Pointer to the file data </td></tr>
<tr><td class="paramname">pLength</td><td>Length of pBuffer, in bytes </td></tr>
<tr><td class="paramname">pFlags</td><td>Optional post processing steps to be executed after a successful import. Provide a bitwise combination of the <a class="el" href="ai_post_process_8h.html#a64795260b95f5a4b3f3dc1be4f52e410" title="Defines the flags for all possible post processing steps.">aiPostProcessSteps</a> flags. If you wish to inspect the imported scene first in order to fine-tune your post-processing setup, consider to use <a class="el" href="assimp_8h.html#a683b19fdda7fec063d07a412268a7a24" title="Apply post-processing to an already-imported scene.">aiApplyPostProcessing()</a>. </td></tr>
<tr><td class="paramname">pHint</td><td>An additional hint to the library. If this is a non empty string, the library looks for a loader to support the file extension specified by pHint and passes the file to the first matching loader. If this loader is unable to completely the request, the library continues and tries to determine the file format on its own, a task that may or may not be successful. Check the return value, and you'll know ... </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>A pointer to the imported data, NULL if the import failed.</dd></dl>
<dl class="section note"><dt>Note:</dt><dd>This is a straightforward way to decode models from memory buffers, but it doesn't handle model formats spreading their data across multiple files or even directories. Examples include OBJ or MD3, which outsource parts of their material stuff into external scripts. If you need the full functionality, provide a custom IOSystem to make <a class="el" href="namespace_assimp.html" title="Assimp's CPP-API and all internal APIs.">Assimp</a> find these files. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.1
</small></address>
</body>
</html>
