backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/Microsoft/Xna/Framework/Graphics/Effect.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

422 lines
18 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:32 CEST 2013 -->
<title>Effect</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="Effect";
}
//-->
</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/Effect.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/Graphics/DynamicVertexBuffer.html" title="class in Microsoft.Xna.Framework.Graphics"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../Microsoft/Xna/Framework/Graphics/EffectAnnotation.html" title="class in Microsoft.Xna.Framework.Graphics"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Graphics/Effect.html" target="_top">Frames</a></li>
<li><a href="Effect.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.Graphics</div>
<h2 title="Class Effect" class="title">Class Effect</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html" title="class in Microsoft.Xna.Framework.Graphics">Microsoft.Xna.Framework.Graphics.GraphicsResource</a></li>
<li>
<ul class="inheritance">
<li>Microsoft.Xna.Framework.Graphics.Effect</li>
</ul>
</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../Microsoft/Xna/Framework/Graphics/DualTextureEffect.html" title="class in Microsoft.Xna.Framework.Graphics">DualTextureEffect</a>, <a href="../../../../Microsoft/Xna/Framework/Graphics/EffectMaterial.html" title="class in Microsoft.Xna.Framework.Graphics">EffectMaterial</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Effect</span>
extends <a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html" title="class in Microsoft.Xna.Framework.Graphics">GraphicsResource</a></pre>
<div class="block">Used to set and query effects, and to choose techniques.</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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Graphics/EffectTechnique.html" title="class in Microsoft.Xna.Framework.Graphics">EffectTechnique</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html#CurrentTechnique">CurrentTechnique</a></strong></code>
<div class="block">Gets or sets the active technique.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_Microsoft.Xna.Framework.Graphics.GraphicsResource">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;Microsoft.Xna.Framework.Graphics.<a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html" title="class in Microsoft.Xna.Framework.Graphics">GraphicsResource</a></h3>
<code><a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#_parent">_parent</a>, <a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#Disposing">Disposing</a>, <a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#Name">Name</a>, <a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#Tag">Tag</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html#Effect(Microsoft.Xna.Framework.Graphics.Effect)">Effect</a></strong>(<a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html" title="class in Microsoft.Xna.Framework.Graphics">Effect</a>&nbsp;cloneSource)</code>
<div class="block">Creates an instance of this object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html#Effect(Microsoft.Xna.Framework.Graphics.GraphicsDevice, byte[])">Effect</a></strong>(<a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsDevice.html" title="class in Microsoft.Xna.Framework.Graphics">GraphicsDevice</a>&nbsp;graphicsDevice,
byte[]&nbsp;byteCode)</code>
<div class="block">Creates an instance of this object.</div>
</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><a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html" title="class in Microsoft.Xna.Framework.Graphics">Effect</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html#Clone()">Clone</a></strong>()</code>
<div class="block">Copies data from an existing object to this object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html#Dispose(boolean)">Dispose</a></strong>(boolean&nbsp;disposing)</code>
<div class="block">Releases the unmanaged resources used by the Effect and optionally releases the managed resources.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Graphics/EffectParameterCollection.html" title="class in Microsoft.Xna.Framework.Graphics">EffectParameterCollection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html#getParameters()">getParameters</a></strong>()</code>
<div class="block">Gets a collection of parameters used for this effect.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Graphics/EffectTechniqueCollection.html" title="class in Microsoft.Xna.Framework.Graphics">EffectTechniqueCollection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html#getTechniques()">getTechniques</a></strong>()</code>
<div class="block">Gets a collection of techniques that are defined for this effect.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html#OnApply()">OnApply</a></strong>()</code>
<div class="block">Applies the effect state just prior to rendering the effect.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_Microsoft.Xna.Framework.Graphics.GraphicsResource">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;Microsoft.Xna.Framework.Graphics.<a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html" title="class in Microsoft.Xna.Framework.Graphics">GraphicsResource</a></h3>
<code><a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#Dispose()">Dispose</a>, <a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#finalize()">finalize</a>, <a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#getGraphicsDevice()">getGraphicsDevice</a>, <a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#IsDisposed()">IsDisposed</a>, <a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#raise_disposing(java.lang.Object, System.EventArgs)">raise_disposing</a>, <a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#toString()">toString</a></code></li>
</ul>
<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, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CurrentTechnique">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CurrentTechnique</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Graphics/EffectTechnique.html" title="class in Microsoft.Xna.Framework.Graphics">EffectTechnique</a> CurrentTechnique</pre>
<div class="block">Gets or sets the active technique.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Effect(Microsoft.Xna.Framework.Graphics.Effect)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Effect</h4>
<pre>protected&nbsp;Effect(<a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html" title="class in Microsoft.Xna.Framework.Graphics">Effect</a>&nbsp;cloneSource)</pre>
<div class="block">Creates an instance of this object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cloneSource</code> - An object to copy.</dd></dl>
</li>
</ul>
<a name="Effect(Microsoft.Xna.Framework.Graphics.GraphicsDevice, byte[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Effect</h4>
<pre>public&nbsp;Effect(<a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsDevice.html" title="class in Microsoft.Xna.Framework.Graphics">GraphicsDevice</a>&nbsp;graphicsDevice,
byte[]&nbsp;byteCode)</pre>
<div class="block">Creates an instance of this object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>graphicsDevice</code> - The device.</dd><dd><code>byteCode</code> - The effect 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="getParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameters</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Graphics/EffectParameterCollection.html" title="class in Microsoft.Xna.Framework.Graphics">EffectParameterCollection</a>&nbsp;getParameters()</pre>
<div class="block">Gets a collection of parameters used for this effect.</div>
</li>
</ul>
<a name="getTechniques()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTechniques</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Graphics/EffectTechniqueCollection.html" title="class in Microsoft.Xna.Framework.Graphics">EffectTechniqueCollection</a>&nbsp;getTechniques()</pre>
<div class="block">Gets a collection of techniques that are defined for this effect.</div>
</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>
<div class="block">Releases the unmanaged resources used by the Effect and optionally releases the managed resources.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html#Dispose(boolean)">Dispose</a></code>&nbsp;in class&nbsp;<code><a href="../../../../Microsoft/Xna/Framework/Graphics/GraphicsResource.html" title="class in Microsoft.Xna.Framework.Graphics">GraphicsResource</a></code></dd>
</dl>
</li>
</ul>
<a name="OnApply()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OnApply</h4>
<pre>protected&nbsp;void&nbsp;OnApply()</pre>
<div class="block">Applies the effect state just prior to rendering the effect.</div>
</li>
</ul>
<a name="Clone()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Clone</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Graphics/Effect.html" title="class in Microsoft.Xna.Framework.Graphics">Effect</a>&nbsp;Clone()</pre>
<div class="block">Copies data from an existing object to this object.</div>
</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/Effect.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/Graphics/DynamicVertexBuffer.html" title="class in Microsoft.Xna.Framework.Graphics"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../Microsoft/Xna/Framework/Graphics/EffectAnnotation.html" title="class in Microsoft.Xna.Framework.Graphics"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Graphics/Effect.html" target="_top">Frames</a></li>
<li><a href="Effect.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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