<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (1.8.0_191) on Wed Oct 31 14:02:13 UTC 2018 --> <title>Bloom (JavaFX 8)</title> <meta name="date" content="2018-10-31"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="Bloom (JavaFX 8)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <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/Bloom.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-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage">JavaFX 8</div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../javafx/scene/effect/BlendMode.html" title="enum in javafx.scene.effect"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/effect/BlurType.html" title="enum in javafx.scene.effect"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?javafx/scene/effect/Bloom.html" target="_top">Frames</a></li> <li><a href="Bloom.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: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </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">javafx.scene.effect</div> <h2 title="Class Bloom" class="title">Class Bloom</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../javafx/scene/effect/Effect.html" title="class in javafx.scene.effect">javafx.scene.effect.Effect</a></li> <li> <ul class="inheritance"> <li>javafx.scene.effect.Bloom</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">Bloom</span> extends <a href="../../../javafx/scene/effect/Effect.html" title="class in javafx.scene.effect">Effect</a></pre> <div class="block">A high-level effect that makes brighter portions of the input image appear to glow, based on a configurable threshold. <p> Example: <pre><code> Bloom bloom = new Bloom(); bloom.setThreshold(0.1); Rectangle rect = new Rectangle(); rect.setX(10); rect.setY(10); rect.setWidth(160); rect.setHeight(80); rect.setFill(Color.DARKSLATEBLUE); Text text = new Text(); text.setText("Bloom!"); text.setFill(Color.ALICEBLUE); text.setFont(Font.font(null, FontWeight.BOLD, 40)); text.setX(25); text.setY(65); text.setEffect(bloom); </pre></code> <p> The code above produces the following: </p> <p> <img src="doc-files/bloom.png"/> </p></div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 2.0</dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== PROPERTY SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="property.summary"> <!-- --> </a> <h3>Property Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Property Summary table, listing properties, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Type</th> <th class="colLast" scope="col">Property and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/beans/property/ObjectProperty.html" title="class in javafx.beans.property">ObjectProperty</a><<a href="../../../javafx/scene/effect/Effect.html" title="class in javafx.scene.effect">Effect</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/effect/Bloom.html#inputProperty">input</a></span></code> <div class="block">The input for this <code>Effect</code>.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../javafx/beans/property/DoubleProperty.html" title="class in javafx.beans.property">DoubleProperty</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/effect/Bloom.html#thresholdProperty">threshold</a></span></code> <div class="block">The threshold value controls the minimum luminosity value of the pixels that will be made to glow.</div> </td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/effect/Bloom.html#Bloom--">Bloom</a></span>()</code> <div class="block">Creates a new instance of Bloom with default parameters.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/effect/Bloom.html#Bloom-double-">Bloom</a></span>(double threshold)</code> <div class="block">Creates a new instance of Bloom with the specified threshold.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/scene/effect/Effect.html" title="class in javafx.scene.effect">Effect</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/effect/Bloom.html#getInput--">getInput</a></span>()</code> <div class="block">Gets the value of the property input.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>double</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/effect/Bloom.html#getThreshold--">getThreshold</a></span>()</code> <div class="block">Gets the value of the property threshold.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../../javafx/beans/property/ObjectProperty.html" title="class in javafx.beans.property">ObjectProperty</a><<a href="../../../javafx/scene/effect/Effect.html" title="class in javafx.scene.effect">Effect</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/effect/Bloom.html#inputProperty--">inputProperty</a></span>()</code> <div class="block">The input for this <code>Effect</code>.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/effect/Bloom.html#setInput-javafx.scene.effect.Effect-">setInput</a></span>(<a href="../../../javafx/scene/effect/Effect.html" title="class in javafx.scene.effect">Effect</a> value)</code> <div class="block">Sets the value of the property input.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/effect/Bloom.html#setThreshold-double-">setThreshold</a></span>(double value)</code> <div class="block">Sets the value of the property threshold.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="../../../javafx/beans/property/DoubleProperty.html" title="class in javafx.beans.property">DoubleProperty</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/effect/Bloom.html#thresholdProperty--">thresholdProperty</a></span>()</code> <div class="block">The threshold value controls the minimum luminosity value of the pixels that will be made to glow.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class 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"> <!-- ============ PROPERTY DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="property.detail"> <!-- --> </a> <h3>Property Detail</h3> <a name="inputProperty"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>input</h4> <pre>public final <a href="../../../javafx/beans/property/ObjectProperty.html" title="class in javafx.beans.property">ObjectProperty</a><<a href="../../../javafx/scene/effect/Effect.html" title="class in javafx.scene.effect">Effect</a>> inputProperty</pre> <div class="block">The input for this <code>Effect</code>. If set to <code>null</code>, or left unspecified, a graphical image of the <code>Node</code> to which the <code>Effect</code> is attached will be used as the input.</div> <dl> <dt><span class="simpleTagLabel">Default value:</span></dt> <dd>null</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../javafx/scene/effect/Bloom.html#getInput--"><code>getInput()</code></a>, <a href="../../../javafx/scene/effect/Bloom.html#setInput-javafx.scene.effect.Effect-"><code>setInput(Effect)</code></a></dd> </dl> </li> </ul> <a name="thresholdProperty"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>threshold</h4> <pre>public final <a href="../../../javafx/beans/property/DoubleProperty.html" title="class in javafx.beans.property">DoubleProperty</a> thresholdProperty</pre> <div class="block">The threshold value controls the minimum luminosity value of the pixels that will be made to glow. <pre> Min: 0.0 Max: 1.0 Default: 0.3 Identity: n/a </pre></div> <dl> <dt><span class="simpleTagLabel">Default value:</span></dt> <dd>0.3</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../javafx/scene/effect/Bloom.html#getThreshold--"><code>getThreshold()</code></a>, <a href="../../../javafx/scene/effect/Bloom.html#setThreshold-double-"><code>setThreshold(double)</code></a></dd> </dl> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="Bloom--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>Bloom</h4> <pre>public Bloom()</pre> <div class="block">Creates a new instance of Bloom with default parameters.</div> </li> </ul> <a name="Bloom-double-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Bloom</h4> <pre>public Bloom(double threshold)</pre> <div class="block">Creates a new instance of Bloom with the specified threshold.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>threshold</code> - the threshold value for the bloom effect</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 2.1</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="setInput-javafx.scene.effect.Effect-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setInput</h4> <pre>public final void setInput(<a href="../../../javafx/scene/effect/Effect.html" title="class in javafx.scene.effect">Effect</a> value)</pre> <div class="block">Sets the value of the property input.</div> <dl> <dt><span class="simpleTagLabel">Property description:</span></dt> <dd>The input for this <code>Effect</code>. If set to <code>null</code>, or left unspecified, a graphical image of the <code>Node</code> to which the <code>Effect</code> is attached will be used as the input.</dd> <dt><span class="simpleTagLabel">Default value:</span></dt> <dd>null</dd> </dl> </li> </ul> <a name="getInput--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getInput</h4> <pre>public final <a href="../../../javafx/scene/effect/Effect.html" title="class in javafx.scene.effect">Effect</a> getInput()</pre> <div class="block">Gets the value of the property input.</div> <dl> <dt><span class="simpleTagLabel">Property description:</span></dt> <dd>The input for this <code>Effect</code>. If set to <code>null</code>, or left unspecified, a graphical image of the <code>Node</code> to which the <code>Effect</code> is attached will be used as the input.</dd> <dt><span class="simpleTagLabel">Default value:</span></dt> <dd>null</dd> </dl> </li> </ul> <a name="inputProperty--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>inputProperty</h4> <pre>public final <a href="../../../javafx/beans/property/ObjectProperty.html" title="class in javafx.beans.property">ObjectProperty</a><<a href="../../../javafx/scene/effect/Effect.html" title="class in javafx.scene.effect">Effect</a>> inputProperty()</pre> <div class="block">The input for this <code>Effect</code>. If set to <code>null</code>, or left unspecified, a graphical image of the <code>Node</code> to which the <code>Effect</code> is attached will be used as the input.</div> <dl> <dt><span class="simpleTagLabel">Default value:</span></dt> <dd>null</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../javafx/scene/effect/Bloom.html#getInput--"><code>getInput()</code></a>, <a href="../../../javafx/scene/effect/Bloom.html#setInput-javafx.scene.effect.Effect-"><code>setInput(Effect)</code></a></dd> </dl> </li> </ul> <a name="setThreshold-double-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setThreshold</h4> <pre>public final void setThreshold(double value)</pre> <div class="block">Sets the value of the property threshold.</div> <dl> <dt><span class="simpleTagLabel">Property description:</span></dt> <dd>The threshold value controls the minimum luminosity value of the pixels that will be made to glow. <pre> Min: 0.0 Max: 1.0 Default: 0.3 Identity: n/a </pre></dd> <dt><span class="simpleTagLabel">Default value:</span></dt> <dd>0.3</dd> </dl> </li> </ul> <a name="getThreshold--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getThreshold</h4> <pre>public final double getThreshold()</pre> <div class="block">Gets the value of the property threshold.</div> <dl> <dt><span class="simpleTagLabel">Property description:</span></dt> <dd>The threshold value controls the minimum luminosity value of the pixels that will be made to glow. <pre> Min: 0.0 Max: 1.0 Default: 0.3 Identity: n/a </pre></dd> <dt><span class="simpleTagLabel">Default value:</span></dt> <dd>0.3</dd> </dl> </li> </ul> <a name="thresholdProperty--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>thresholdProperty</h4> <pre>public final <a href="../../../javafx/beans/property/DoubleProperty.html" title="class in javafx.beans.property">DoubleProperty</a> thresholdProperty()</pre> <div class="block">The threshold value controls the minimum luminosity value of the pixels that will be made to glow. <pre> Min: 0.0 Max: 1.0 Default: 0.3 Identity: n/a </pre></div> <dl> <dt><span class="simpleTagLabel">Default value:</span></dt> <dd>0.3</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../javafx/scene/effect/Bloom.html#getThreshold--"><code>getThreshold()</code></a>, <a href="../../../javafx/scene/effect/Bloom.html#setThreshold-double-"><code>setThreshold(double)</code></a></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> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <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/Bloom.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-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage">JavaFX 8</div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../javafx/scene/effect/BlendMode.html" title="enum in javafx.scene.effect"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/effect/BlurType.html" title="enum in javafx.scene.effect"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?javafx/scene/effect/Bloom.html" target="_top">Frames</a></li> <li><a href="Bloom.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: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small><font size="-1"><a href="http://bugreport.java.com/bugreport/" target="_blank">Submit a bug or feature</a><br>For further API reference and developer documentation, see <a href="https://docs.oracle.com/javase/8/docs/index.html" target="_blank">Java SE Documentation</a>. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> <a href="https://docs.oracle.com/javase/8/docs/legal/cpyr.html" target="_blank">Copyright</a> © 2008, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to <a href="http://download.oracle.com/otndocs/jcp/java_se-8-mrel-spec/license.html" target="_blank">license terms</a>. Also see the <a target="_blank" href="http://www.oracle.com/technetwork/java/redist-137594.html" target="_blank">documentation redistribution policy</a>.</font></small></p> </body> </html>