| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>Color - Three.js Docs</title>
- <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
- <script src="../scripts/highlight.min.js"></script>
- <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
- <link type="text/css" rel="stylesheet" href="../styles/page.css">
- </head>
- <body>
- <h1 translate="no">Color</h1>
- <section>
- <header>
- <div class="class-description"><p>A Color instance is represented by RGB components in the linear <i>working
- color space</i>, which defaults to <code>LinearSRGBColorSpace</code>. Inputs
- conventionally using <code>SRGBColorSpace</code> (such as hexadecimals and CSS
- strings) are converted to the working color space automatically.</p>
- <p>Source color spaces may be specified explicitly, to ensure correct conversions.</p>
- <pre><code class="language-js">// assumed already LinearSRGBColorSpace; no conversion
- const color = new THREE.Color().setRGB( 0.5, 0.5, 0.5 );
- // converted explicitly from SRGBColorSpace to LinearSRGBColorSpace
- const color = new THREE.Color().setRGB( 0.5, 0.5, 0.5, SRGBColorSpace );
- </code></pre>
- <p>If THREE.ColorManagement is disabled, no conversions occur. For details,
- see <i>Color management</i>. Iterating through a Color instance will yield
- its components (r, g, b) in the corresponding order. A Color can be initialised
- in any of the following ways:</p>
- <pre><code class="language-js">//empty constructor - will default white
- const color1 = new THREE.Color();
- //Hexadecimal color (recommended)
- const color2 = new THREE.Color( 0xff0000 );
- //RGB string
- const color3 = new THREE.Color("rgb(255, 0, 0)");
- const color4 = new THREE.Color("rgb(100%, 0%, 0%)");
- //X11 color name - all 140 color names are supported.
- //Note the lack of CamelCase in the name
- const color5 = new THREE.Color( 'skyblue' );
- //HSL string
- const color6 = new THREE.Color("hsl(0, 100%, 50%)");
- //Separate RGB values between 0 and 1
- const color7 = new THREE.Color( 1, 0, 0 );
- </code></pre></div>
- <h2>Code Example</h2>
- <div translate="no"><pre><code class="language-js">// converted automatically from SRGBColorSpace to LinearSRGBColorSpace
- const color = new THREE.Color().setHex( 0x112233 );
- </code></pre></div>
- </header>
- <article>
- <div class="container-overview">
- <h2>Constructor</h2>
- <h3 class="name name-method" id="Color" translate="no">new <a href="#Color">Color</a><span class="signature">( r : <span class="param-type">number | string | Color</span>, g : <span class="param-type">number</span>, b : <span class="param-type">number</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Constructs a new color.</p>
- <p>Note that standard method of specifying color in three.js is with a hexadecimal triplet,
- and that method is used throughout the rest of the documentation.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>r</code></td>
- <td class="description last"><p>The red component of the color. If <code>g</code> and <code>b</code> are
- not provided, it can be hexadecimal triplet, a CSS-style string or another <code>Color</code> instance.</p></td>
- </tr>
- <tr>
- <td class="name"><code>g</code></td>
- <td class="description last"><p>The green component.</p></td>
- </tr>
- <tr>
- <td class="name"><code>b</code></td>
- <td class="description last"><p>The blue component.</p></td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <h2 class="subsection-title">Properties</h2>
- <div class="member">
- <h3 class="name" id="b" translate="no">.<a href="#b">b</a><span class="type-signature"> : number</span> </h3>
- <div class="description">
- <p>The blue component.<br/>Default is <code>1</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="g" translate="no">.<a href="#g">g</a><span class="type-signature"> : number</span> </h3>
- <div class="description">
- <p>The green component.<br/>Default is <code>1</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="isColor" translate="no">.<a href="#isColor">isColor</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
- <div class="description">
- <p>This flag can be used for type testing.<br/>Default is <code>true</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="r" translate="no">.<a href="#r">r</a><span class="type-signature"> : number</span> </h3>
- <div class="description">
- <p>The red component.<br/>Default is <code>1</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id=".NAMES" translate="no">.<a href="#.NAMES">NAMES</a><span class="type-signature"> : Object</span> </h3>
- <div class="description">
- <p>A dictionary with X11 color names.</p>
- <p>Note that multiple words such as Dark Orange become the string 'darkorange'.</p>
- </div>
- </div>
- <h2 class="subsection-title">Methods</h2>
- <h3 class="name name-method" id="add" translate="no">.<a href="#add">add</a><span class="signature">( color : <span class="param-type">Color</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Adds the RGB values of the given color to the RGB values of this color.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>color</code></td>
- <td class="description last"><p>The color to add.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="addColors" translate="no">.<a href="#addColors">addColors</a><span class="signature">( color1 : <span class="param-type">Color</span>, color2 : <span class="param-type">Color</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Adds the RGB values of the given colors and stores the result in this instance.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>color1</code></td>
- <td class="description last"><p>The first color.</p></td>
- </tr>
- <tr>
- <td class="name"><code>color2</code></td>
- <td class="description last"><p>The second color.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="addScalar" translate="no">.<a href="#addScalar">addScalar</a><span class="signature">( s : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Adds the given scalar value to the RGB values of this color.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>s</code></td>
- <td class="description last"><p>The scalar to add.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="applyMatrix3" translate="no">.<a href="#applyMatrix3">applyMatrix3</a><span class="signature">( m : <span class="param-type">Matrix3</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Transforms this color with the given 3x3 matrix.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>m</code></td>
- <td class="description last"><p>The matrix.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="clone" translate="no">.<a href="#clone">clone</a><span class="signature">()</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Returns a new color with copied values from this instance.</p>
- </div>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A clone of this instance.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="convertLinearToSRGB" translate="no">.<a href="#convertLinearToSRGB">convertLinearToSRGB</a><span class="signature">()</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Converts this color from <code>LinearSRGBColorSpace</code> to <code>SRGBColorSpace</code>.</p>
- </div>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="convertSRGBToLinear" translate="no">.<a href="#convertSRGBToLinear">convertSRGBToLinear</a><span class="signature">()</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Converts this color from <code>SRGBColorSpace</code> to <code>LinearSRGBColorSpace</code>.</p>
- </div>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="copy" translate="no">.<a href="#copy">copy</a><span class="signature">( color : <span class="param-type">Color</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Copies the values of the given color to this instance.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>color</code></td>
- <td class="description last"><p>The color to copy.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="copyLinearToSRGB" translate="no">.<a href="#copyLinearToSRGB">copyLinearToSRGB</a><span class="signature">( color : <span class="param-type">Color</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Copies the given color into this color, and then converts this color from
- <code>LinearSRGBColorSpace</code> to <code>SRGBColorSpace</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>color</code></td>
- <td class="description last"><p>The color to copy/convert.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="copySRGBToLinear" translate="no">.<a href="#copySRGBToLinear">copySRGBToLinear</a><span class="signature">( color : <span class="param-type">Color</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Copies the given color into this color, and then converts this color from
- <code>SRGBColorSpace</code> to <code>LinearSRGBColorSpace</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>color</code></td>
- <td class="description last"><p>The color to copy/convert.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="equals" translate="no">.<a href="#equals">equals</a><span class="signature">( c : <span class="param-type">Color</span> )</span><span class="type-signature"> : boolean</span> </h3>
- <div class="method">
- <div class="description">
- <p>Returns <code>true</code> if this color is equal with the given one.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>c</code></td>
- <td class="description last"><p>The color to test for equality.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> Whether this bounding color is equal with the given one.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="fromArray" translate="no">.<a href="#fromArray">fromArray</a><span class="signature">( array : <span class="param-type">Array.<number></span>, offset : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sets this color's RGB components from the given array.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>array</code></td>
- <td class="description last"><p>An array holding the RGB values.</p></td>
- </tr>
- <tr>
- <td class="name"><code>offset</code></td>
- <td class="description last"><p>The offset into the array.<br/>Default is <code>0</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="fromBufferAttribute" translate="no">.<a href="#fromBufferAttribute">fromBufferAttribute</a><span class="signature">( attribute : <span class="param-type">BufferAttribute</span>, index : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sets the components of this color from the given buffer attribute.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>attribute</code></td>
- <td class="description last"><p>The buffer attribute holding color data.</p></td>
- </tr>
- <tr>
- <td class="name"><code>index</code></td>
- <td class="description last"><p>The index into the attribute.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="getHSL" translate="no">.<a href="#getHSL">getHSL</a><span class="signature">( target : <span class="param-type">Object</span>, colorSpace : <span class="param-type">string</span> )</span><span class="type-signature"> : Object</span> </h3>
- <div class="method">
- <div class="description">
- <p>Converts the colors RGB values into the HSL format and stores them into the
- given target object.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>target</code></td>
- <td class="description last"><p>The target object that is used to store the method's result.</p></td>
- </tr>
- <tr>
- <td class="name"><code>colorSpace</code></td>
- <td class="description last"><p>The color space.<br/>Default is <code>ColorManagement.workingColorSpace</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The HSL representation of this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="getHex" translate="no">.<a href="#getHex">getHex</a><span class="signature">( colorSpace : <span class="param-type">string</span> )</span><span class="type-signature"> : number</span> </h3>
- <div class="method">
- <div class="description">
- <p>Returns the hexadecimal value of this color.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>colorSpace</code></td>
- <td class="description last"><p>The color space.<br/>Default is <code>SRGBColorSpace</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The hexadecimal value.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="getHexString" translate="no">.<a href="#getHexString">getHexString</a><span class="signature">( colorSpace : <span class="param-type">string</span> )</span><span class="type-signature"> : string</span> </h3>
- <div class="method">
- <div class="description">
- <p>Returns the hexadecimal value of this color as a string (for example, 'FFFFFF').</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>colorSpace</code></td>
- <td class="description last"><p>The color space.<br/>Default is <code>SRGBColorSpace</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The hexadecimal value as a string.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="getRGB" translate="no">.<a href="#getRGB">getRGB</a><span class="signature">( target : <span class="param-type">Color</span>, colorSpace : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Returns the RGB values of this color and stores them into the given target object.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>target</code></td>
- <td class="description last"><p>The target color that is used to store the method's result.</p></td>
- </tr>
- <tr>
- <td class="name"><code>colorSpace</code></td>
- <td class="description last"><p>The color space.<br/>Default is <code>ColorManagement.workingColorSpace</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The RGB representation of this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="getStyle" translate="no">.<a href="#getStyle">getStyle</a><span class="signature">( colorSpace : <span class="param-type">string</span> )</span><span class="type-signature"> : string</span> </h3>
- <div class="method">
- <div class="description">
- <p>Returns the value of this color as a CSS style string. Example: <code>rgb(255,0,0)</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>colorSpace</code></td>
- <td class="description last"><p>The color space.<br/>Default is <code>SRGBColorSpace</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The CSS representation of this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="lerp" translate="no">.<a href="#lerp">lerp</a><span class="signature">( color : <span class="param-type">Color</span>, alpha : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Linearly interpolates this color's RGB values toward the RGB values of the
- given color. The alpha argument can be thought of as the ratio between
- the two colors, where <code>0.0</code> is this color and <code>1.0</code> is the first argument.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>color</code></td>
- <td class="description last"><p>The color to converge on.</p></td>
- </tr>
- <tr>
- <td class="name"><code>alpha</code></td>
- <td class="description last"><p>The interpolation factor in the closed interval <code>[0,1]</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="lerpColors" translate="no">.<a href="#lerpColors">lerpColors</a><span class="signature">( color1 : <span class="param-type">Color</span>, color2 : <span class="param-type">Color</span>, alpha : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Linearly interpolates between the given colors and stores the result in this instance.
- The alpha argument can be thought of as the ratio between the two colors, where <code>0.0</code>
- is the first and <code>1.0</code> is the second color.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>color1</code></td>
- <td class="description last"><p>The first color.</p></td>
- </tr>
- <tr>
- <td class="name"><code>color2</code></td>
- <td class="description last"><p>The second color.</p></td>
- </tr>
- <tr>
- <td class="name"><code>alpha</code></td>
- <td class="description last"><p>The interpolation factor in the closed interval <code>[0,1]</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="lerpHSL" translate="no">.<a href="#lerpHSL">lerpHSL</a><span class="signature">( color : <span class="param-type">Color</span>, alpha : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Linearly interpolates this color's HSL values toward the HSL values of the
- given color. It differs from <a href="Color.html#lerp">Color#lerp</a> by not interpolating straight
- from one color to the other, but instead going through all the hues in between
- those two colors. The alpha argument can be thought of as the ratio between
- the two colors, where 0.0 is this color and 1.0 is the first argument.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>color</code></td>
- <td class="description last"><p>The color to converge on.</p></td>
- </tr>
- <tr>
- <td class="name"><code>alpha</code></td>
- <td class="description last"><p>The interpolation factor in the closed interval <code>[0,1]</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="multiply" translate="no">.<a href="#multiply">multiply</a><span class="signature">( color : <span class="param-type">Color</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Multiplies the RGB values of the given color with the RGB values of this color.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>color</code></td>
- <td class="description last"><p>The color to multiply.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="multiplyScalar" translate="no">.<a href="#multiplyScalar">multiplyScalar</a><span class="signature">( s : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Multiplies the given scalar value with the RGB values of this color.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>s</code></td>
- <td class="description last"><p>The scalar to multiply.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="offsetHSL" translate="no">.<a href="#offsetHSL">offsetHSL</a><span class="signature">( h : <span class="param-type">number</span>, s : <span class="param-type">number</span>, l : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Adds the given HSL values to this color's values.
- Internally, this converts the color's RGB values to HSL, adds HSL
- and then converts the color back to RGB.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>h</code></td>
- <td class="description last"><p>Hue value between <code>0.0</code> and <code>1.0</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>s</code></td>
- <td class="description last"><p>Saturation value between <code>0.0</code> and <code>1.0</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>l</code></td>
- <td class="description last"><p>Lightness value between <code>0.0</code> and <code>1.0</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="set" translate="no">.<a href="#set">set</a><span class="signature">( r : <span class="param-type">number | string | Color</span>, g : <span class="param-type">number</span>, b : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sets the colors's components from the given values.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>r</code></td>
- <td class="description last"><p>The red component of the color. If <code>g</code> and <code>b</code> are
- not provided, it can be hexadecimal triplet, a CSS-style string or another <code>Color</code> instance.</p></td>
- </tr>
- <tr>
- <td class="name"><code>g</code></td>
- <td class="description last"><p>The green component.</p></td>
- </tr>
- <tr>
- <td class="name"><code>b</code></td>
- <td class="description last"><p>The blue component.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="setColorName" translate="no">.<a href="#setColorName">setColorName</a><span class="signature">( style : <span class="param-type">string</span>, colorSpace : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sets this color from a color name. Faster than <a href="Color.html#setStyle">Color#setStyle</a> if
- you don't need the other CSS-style formats.</p>
- <p>For convenience, the list of names is exposed in <code>Color.NAMES</code> as a hash.</p>
- <pre><code class="language-js">Color.NAMES.aliceblue // returns 0xF0F8FF
- </code></pre>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>style</code></td>
- <td class="description last"><p>The color name.</p></td>
- </tr>
- <tr>
- <td class="name"><code>colorSpace</code></td>
- <td class="description last"><p>The color space.<br/>Default is <code>SRGBColorSpace</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="setFromVector3" translate="no">.<a href="#setFromVector3">setFromVector3</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sets the color's RGB components from the given 3D vector.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>v</code></td>
- <td class="description last"><p>The vector to set.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="setHSL" translate="no">.<a href="#setHSL">setHSL</a><span class="signature">( h : <span class="param-type">number</span>, s : <span class="param-type">number</span>, l : <span class="param-type">number</span>, colorSpace : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sets this color from RGB values.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>h</code></td>
- <td class="description last"><p>Hue value between <code>0.0</code> and <code>1.0</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>s</code></td>
- <td class="description last"><p>Saturation value between <code>0.0</code> and <code>1.0</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>l</code></td>
- <td class="description last"><p>Lightness value between <code>0.0</code> and <code>1.0</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>colorSpace</code></td>
- <td class="description last"><p>The color space.<br/>Default is <code>ColorManagement.workingColorSpace</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="setHex" translate="no">.<a href="#setHex">setHex</a><span class="signature">( hex : <span class="param-type">number</span>, colorSpace : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sets this color from a hexadecimal value.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>hex</code></td>
- <td class="description last"><p>The hexadecimal value.</p></td>
- </tr>
- <tr>
- <td class="name"><code>colorSpace</code></td>
- <td class="description last"><p>The color space.<br/>Default is <code>SRGBColorSpace</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="setRGB" translate="no">.<a href="#setRGB">setRGB</a><span class="signature">( r : <span class="param-type">number</span>, g : <span class="param-type">number</span>, b : <span class="param-type">number</span>, colorSpace : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sets this color from RGB values.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>r</code></td>
- <td class="description last"><p>Red channel value between <code>0.0</code> and <code>1.0</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>g</code></td>
- <td class="description last"><p>Green channel value between <code>0.0</code> and <code>1.0</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>b</code></td>
- <td class="description last"><p>Blue channel value between <code>0.0</code> and <code>1.0</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>colorSpace</code></td>
- <td class="description last"><p>The color space.<br/>Default is <code>ColorManagement.workingColorSpace</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="setScalar" translate="no">.<a href="#setScalar">setScalar</a><span class="signature">( scalar : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sets the colors's components to the given scalar value.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>scalar</code></td>
- <td class="description last"><p>The scalar value.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="setStyle" translate="no">.<a href="#setStyle">setStyle</a><span class="signature">( style : <span class="param-type">string</span>, colorSpace : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sets this color from a CSS-style string. For example, <code>rgb(250, 0,0)</code>,
- <code>rgb(100%, 0%, 0%)</code>, <code>hsl(0, 100%, 50%)</code>, <code>#ff0000</code>, <code>#f00</code>, or <code>red</code> ( or
- any <a href="https://en.wikipedia.org/wiki/X11_color_names#Color_name_chart">X11 color name</a> -
- all 140 color names are supported).</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>style</code></td>
- <td class="description last"><p>Color as a CSS-style string.</p></td>
- </tr>
- <tr>
- <td class="name"><code>colorSpace</code></td>
- <td class="description last"><p>The color space.<br/>Default is <code>SRGBColorSpace</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="sub" translate="no">.<a href="#sub">sub</a><span class="signature">( color : <span class="param-type">Color</span> )</span><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Subtracts the RGB values of the given color from the RGB values of this color.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>color</code></td>
- <td class="description last"><p>The color to subtract.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this color.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="toArray" translate="no">.<a href="#toArray">toArray</a><span class="signature">( array : <span class="param-type">Array.<number></span>, offset : <span class="param-type">number</span> )</span><span class="type-signature"> : Array.<number></span> </h3>
- <div class="method">
- <div class="description">
- <p>Writes the RGB components of this color to the given array. If no array is provided,
- the method returns a new instance.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>array</code></td>
- <td class="description last"><p>The target array holding the color components.<br/>Default is <code>[]</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>offset</code></td>
- <td class="description last"><p>Index of the first element in the array.<br/>Default is <code>0</code>.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The color components.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="toJSON" translate="no">.<a href="#toJSON">toJSON</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
- <div class="method">
- <div class="description">
- <p>This methods defines the serialization result of this class. Returns the color
- as a hexadecimal value.</p>
- </div>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The hexadecimal value.</dt>
- </dl>
- </div>
- <h2 class="subsection-title">Source</h2>
- <p>
- <a href="https://github.com/mrdoob/three.js/blob/master/src/math/Color.js" target="_blank" rel="noopener" translate="no">src/math/Color.js</a>
- </p>
- </article>
- </section>
- <script src="../scripts/linenumber.js"></script>
- <script src="../scripts/page.js"></script>
- </body>
- </html>
|