videocontext
Version:
A WebGL & HTML5 graph based video composition library
1,491 lines (362 loc) • 18.6 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: ProcessingNode</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: ProcessingNode</h1>
<section>
<header>
<h2>ProcessingNode</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="ProcessingNode"><span class="type-signature"></span>new ProcessingNode<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Initialise an instance of a ProcessingNode.</p>
<p>This class is not used directly, but is extended to create CompositingNodes, TransitionNodes, and EffectNodes.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_processingnode.js.html">ProcessingNodes/processingnode.js</a>, <a href="ProcessingNodes_processingnode.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getProperty"><span class="type-signature"></span>getProperty<span class="signature">(name)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the passed processing node property to the passed value.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the processing node parameter to get.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_processingnode.js.html">ProcessingNodes/processingnode.js</a>, <a href="ProcessingNodes_processingnode.js.html#line135">line 135</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>var ctx = new VideoContext();
var monoNode = ctx.effect(VideoContext.DEFINITIONS.MONOCHROME);
console.log(monoNode.getProperty("inputMix")); //Will output [0.4,0.6,0.2], the default value from the effect definition.</code></pre>
<h4 class="name" id="getProperty"><span class="type-signature"></span>getProperty<span class="signature">(name)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the passed processing node property to the passed value.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the processing node parameter to get.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_processingnode.js.html">ProcessingNodes/processingnode.js</a>, <a href="ProcessingNodes_processingnode.js.html#line135">line 135</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>var ctx = new VideoContext();
var monoNode = ctx.effect(VideoContext.DEFINITIONS.MONOCHROME);
console.log(monoNode.getProperty("inputMix")); //Will output [0.4,0.6,0.2], the default value from the effect definition.</code></pre>
<h4 class="name" id="setProperty"><span class="type-signature"></span>setProperty<span class="signature">(name, value)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the passed processing node property to the passed value.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the processing node parameter to modify.</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The value to set it to.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_processingnode.js.html">ProcessingNodes/processingnode.js</a>, <a href="ProcessingNodes_processingnode.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>var ctx = new VideoContext();
var monoNode = ctx.effect(VideoContext.DEFINITIONS.MONOCHROME);
monoNode.setProperty("inputMix", [1.0,0.0,0.0]); //Just use red channel</code></pre>
<h4 class="name" id="setProperty"><span class="type-signature"></span>setProperty<span class="signature">(name, value)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the passed processing node property to the passed value.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the processing node parameter to modify.</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The value to set it to.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_processingnode.js.html">ProcessingNodes/processingnode.js</a>, <a href="ProcessingNodes_processingnode.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>var ctx = new VideoContext();
var monoNode = ctx.effect(VideoContext.DEFINITIONS.MONOCHROME);
monoNode.setProperty("inputMix", [1.0,0.0,0.0]); //Just use red channel</code></pre>
</article>
</section>
<section>
<header>
<h2>ProcessingNode</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="ProcessingNode"><span class="type-signature"></span>new ProcessingNode<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Initialise an instance of a ProcessingNode.</p>
<p>This class is not used directly, but is extended to create CompositingNodes, TransitionNodes, and EffectNodes.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_processingnode.js.html">ProcessingNodes/processingnode.js</a>, <a href="ProcessingNodes_processingnode.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getProperty"><span class="type-signature"></span>getProperty<span class="signature">(name)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the passed processing node property to the passed value.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the processing node parameter to get.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_processingnode.js.html">ProcessingNodes/processingnode.js</a>, <a href="ProcessingNodes_processingnode.js.html#line135">line 135</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>var ctx = new VideoContext();
var monoNode = ctx.effect(VideoContext.DEFINITIONS.MONOCHROME);
console.log(monoNode.getProperty("inputMix")); //Will output [0.4,0.6,0.2], the default value from the effect definition.</code></pre>
<h4 class="name" id="getProperty"><span class="type-signature"></span>getProperty<span class="signature">(name)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the passed processing node property to the passed value.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the processing node parameter to get.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_processingnode.js.html">ProcessingNodes/processingnode.js</a>, <a href="ProcessingNodes_processingnode.js.html#line135">line 135</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>var ctx = new VideoContext();
var monoNode = ctx.effect(VideoContext.DEFINITIONS.MONOCHROME);
console.log(monoNode.getProperty("inputMix")); //Will output [0.4,0.6,0.2], the default value from the effect definition.</code></pre>
<h4 class="name" id="setProperty"><span class="type-signature"></span>setProperty<span class="signature">(name, value)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the passed processing node property to the passed value.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the processing node parameter to modify.</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The value to set it to.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_processingnode.js.html">ProcessingNodes/processingnode.js</a>, <a href="ProcessingNodes_processingnode.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>var ctx = new VideoContext();
var monoNode = ctx.effect(VideoContext.DEFINITIONS.MONOCHROME);
monoNode.setProperty("inputMix", [1.0,0.0,0.0]); //Just use red channel</code></pre>
<h4 class="name" id="setProperty"><span class="type-signature"></span>setProperty<span class="signature">(name, value)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the passed processing node property to the passed value.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the processing node parameter to modify.</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The value to set it to.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_processingnode.js.html">ProcessingNodes/processingnode.js</a>, <a href="ProcessingNodes_processingnode.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>var ctx = new VideoContext();
var monoNode = ctx.effect(VideoContext.DEFINITIONS.MONOCHROME);
monoNode.setProperty("inputMix", [1.0,0.0,0.0]); //Just use red channel</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-VideoContext.html">VideoContext</a></li></ul><h3>Classes</h3><ul><li><a href="CanvasNode.html">CanvasNode</a></li><li><a href="CompositingNode.html">CompositingNode</a></li><li><a href="DestinationNode.html">DestinationNode</a></li><li><a href="EffectNode.html">EffectNode</a></li><li><a href="GraphNode.html">GraphNode</a></li><li><a href="ImageNode.html">ImageNode</a></li><li><a href="module-VideoContext.html">VideoContext</a></li><li><a href="ProcessingNode.html">ProcessingNode</a></li><li><a href="RenderGraph.html">RenderGraph</a></li><li><a href="SourceNode.html">SourceNode</a></li><li><a href="TransitionNode.html">TransitionNode</a></li><li><a href="VideoNode.html">VideoNode</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>