backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/Microsoft/Xna/Framework/Content/ContentManager.html
Tom Lint 92e29ba3dd Fixed compiler errors 
Regenerated JavaDoc
Updated whitespace usage
Added LWJGL libraries and binaries
2013-10-15 12:34:51 +02:00

404 lines
17 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="nl">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Tue Oct 15 12:25:34 CEST 2013 -->
<title>ContentManager</title>
<meta name="date" content="2013-10-15">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ContentManager";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ContentManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../Microsoft/Xna/Framework/Content/ContentLoadException.html" title="class in Microsoft.Xna.Framework.Content"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../Microsoft/Xna/Framework/Content/ContentReader.html" title="class in Microsoft.Xna.Framework.Content"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Content/ContentManager.html" target="_top">Frames</a></li>
<li><a href="ContentManager.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">Microsoft.Xna.Framework.Content</div>
<h2 title="Class ContentManager" class="title">Class ContentManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>Microsoft.Xna.Framework.Content.ContentManager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../System/IDisposable.html" title="interface in System">IDisposable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ContentManager</span>
extends java.lang.Object
implements <a href="../../../../System/IDisposable.html" title="interface in System">IDisposable</a></pre>
<div class="block">The ContentManager is the run-time component which loads managed objects from the binary files produced by the design time content pipeline. It also manages the
lifespan of the loaded objects, disposing the content manager will also dispose any assets which are themselves IDisposable.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Halofreak1990</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../Microsoft/Xna/Framework/Content/ContentManager.html#ContentManager(System.IServiceProvider)">ContentManager</a></strong>(<a href="../../../../System/IServiceProvider.html" title="interface in System">IServiceProvider</a>&nbsp;serviceProvider)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../Microsoft/Xna/Framework/Content/ContentManager.html#ContentManager(System.IServiceProvider, java.lang.String)">ContentManager</a></strong>(<a href="../../../../System/IServiceProvider.html" title="interface in System">IServiceProvider</a>&nbsp;serviceProvider,
java.lang.String&nbsp;rootDirectory)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Content/ContentManager.html#Dispose()">Dispose</a></strong>()</code>
<div class="block">Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Content/ContentManager.html#Dispose(boolean)">Dispose</a></strong>(boolean&nbsp;disposing)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Content/ContentManager.html#getRootDirectory()">getRootDirectory</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../System/IServiceProvider.html" title="interface in System">IServiceProvider</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Content/ContentManager.html#getServiceProvider()">getServiceProvider</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Content/ContentManager.html#Load(java.lang.String)">Load</a></strong>(java.lang.String&nbsp;assetName)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected &lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Content/ContentManager.html#ReadAsset(java.lang.String, System.Action)">ReadAsset</a></strong>(java.lang.String&nbsp;assetName,
<a href="../../../../System/Action.html" title="class in System">Action</a>&lt;<a href="../../../../System/IDisposable.html" title="interface in System">IDisposable</a>&gt;&nbsp;recordDisposableObject)</code>
<div class="block">Low-level worker method that reads asset data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Content/ContentManager.html#setRootDirectory(java.lang.String)">setRootDirectory</a></strong>(java.lang.String&nbsp;value)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Content/ContentManager.html#Unload()">Unload</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ContentManager(System.IServiceProvider)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ContentManager</h4>
<pre>public&nbsp;ContentManager(<a href="../../../../System/IServiceProvider.html" title="interface in System">IServiceProvider</a>&nbsp;serviceProvider)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>serviceProvider</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code></dd></dl>
</li>
</ul>
<a name="ContentManager(System.IServiceProvider, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ContentManager</h4>
<pre>public&nbsp;ContentManager(<a href="../../../../System/IServiceProvider.html" title="interface in System">IServiceProvider</a>&nbsp;serviceProvider,
java.lang.String&nbsp;rootDirectory)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>serviceProvider</code> - </dd><dd><code>rootDirectory</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRootDirectory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootDirectory</h4>
<pre>public&nbsp;java.lang.String&nbsp;getRootDirectory()</pre>
</li>
</ul>
<a name="setRootDirectory(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRootDirectory</h4>
<pre>public&nbsp;void&nbsp;setRootDirectory(java.lang.String&nbsp;value)</pre>
</li>
</ul>
<a name="getServiceProvider()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServiceProvider</h4>
<pre>public&nbsp;<a href="../../../../System/IServiceProvider.html" title="interface in System">IServiceProvider</a>&nbsp;getServiceProvider()</pre>
</li>
</ul>
<a name="Dispose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Dispose</h4>
<pre>public&nbsp;void&nbsp;Dispose()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../System/IDisposable.html#Dispose()">IDisposable</a></code></strong></div>
<div class="block">Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../System/IDisposable.html#Dispose()">Dispose</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../System/IDisposable.html" title="interface in System">IDisposable</a></code></dd>
</dl>
</li>
</ul>
<a name="Dispose(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Dispose</h4>
<pre>protected&nbsp;void&nbsp;Dispose(boolean&nbsp;disposing)</pre>
</li>
</ul>
<a name="Load(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Load</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;Load(java.lang.String&nbsp;assetName)</pre>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - </dd><dt><span class="strong">Parameters:</span></dt><dd><code>assetName</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code></dd>
<dd><code><a href="../../../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code></dd></dl>
</li>
</ul>
<a name="ReadAsset(java.lang.String, System.Action)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReadAsset</h4>
<pre>protected&nbsp;&lt;T&gt;&nbsp;T&nbsp;ReadAsset(java.lang.String&nbsp;assetName,
<a href="../../../../System/Action.html" title="class in System">Action</a>&lt;<a href="../../../../System/IDisposable.html" title="interface in System">IDisposable</a>&gt;&nbsp;recordDisposableObject)</pre>
<div class="block">Low-level worker method that reads asset data.</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - </dd><dt><span class="strong">Parameters:</span></dt><dd><code>assetName</code> - The name of the asset to be loaded from disk.</dd><dd><code>recordDisposableObject</code> - Delegate function for handling the disposition of assets. If recordDisposableObject is null,
the default lifespan tracking and management is used, so unloading or disposing of the content
manager frees everything that has been loaded through it. If recordDisposableObject specifies
a valid delegate, that delegate is used instead of the default lifespan tracking and is called
every time the loader encounters a type that implements IDisposable. You must use your own code
to unload assets loaded in this fashion, since ContentManager's Unload method will not be aware
of them.</dd></dl>
</li>
</ul>
<a name="Unload()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Unload</h4>
<pre>public&nbsp;void&nbsp;Unload()</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ContentManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../Microsoft/Xna/Framework/Content/ContentLoadException.html" title="class in Microsoft.Xna.Framework.Content"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../Microsoft/Xna/Framework/Content/ContentReader.html" title="class in Microsoft.Xna.Framework.Content"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Content/ContentManager.html" target="_top">Frames</a></li>
<li><a href="ContentManager.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink