aboutsummaryrefslogtreecommitdiffstats
path: root/docs/layereffect.html
blob: 2d32081f7bab07e97ed96e1975610193eaac1349 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<!DOCTYPE html>  <html> <head>   <title>layereffect.coffee</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="blackwhite.html">                 blackwhite.coffee               </a>                                           <a class="source" href="brightnesscontrast.html">                 brightnesscontrast.coffee               </a>                                           <a class="source" href="colorbalance.html">                 colorbalance.coffee               </a>                                           <a class="source" href="curves.html">                 curves.coffee               </a>                                           <a class="source" href="exposure.html">                 exposure.coffee               </a>                                           <a class="source" href="gradient.html">                 gradient.coffee               </a>                                           <a class="source" href="huesaturation.html">                 huesaturation.coffee               </a>                                           <a class="source" href="invert.html">                 invert.coffee               </a>                                           <a class="source" href="layereffect.html">                 layereffect.coffee               </a>                                           <a class="source" href="levels.html">                 levels.coffee               </a>                                           <a class="source" href="pattern.html">                 pattern.coffee               </a>                                           <a class="source" href="photofilter.html">                 photofilter.coffee               </a>                                           <a class="source" href="posterize.html">                 posterize.coffee               </a>                                           <a class="source" href="selectivecolor.html">                 selectivecolor.coffee               </a>                                           <a class="source" href="solidcolor.html">                 solidcolor.coffee               </a>                                           <a class="source" href="threshold.html">                 threshold.coffee               </a>                                           <a class="source" href="typetool.html">                 typetool.coffee               </a>                                           <a class="source" href="vibrance.html">                 vibrance.coffee               </a>                                           <a class="source" href="log.html">                 log.coffee               </a>                                           <a class="source" href="psd.html">                 psd.coffee               </a>                                           <a class="source" href="psdassert.html">                 psdassert.coffee               </a>                                           <a class="source" href="psdchannelimage.html">                 psdchannelimage.coffee               </a>                                           <a class="source" href="psdcolor.html">                 psdcolor.coffee               </a>                                           <a class="source" href="psddescriptor.html">                 psddescriptor.coffee               </a>                                           <a class="source" href="psdfile.html">                 psdfile.coffee               </a>                                           <a class="source" href="psdheader.html">                 psdheader.coffee               </a>                                           <a class="source" href="psdimage.html">                 psdimage.coffee               </a>                                           <a class="source" href="psdlayer.html">                 psdlayer.coffee               </a>                                           <a class="source" href="psdlayermask.html">                 psdlayermask.coffee               </a>                                           <a class="source" href="psdresource.html">                 psdresource.coffee               </a>                                           <a class="source" href="util.html">                 util.coffee               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               layereffect.coffee             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>               <p>libpsd has effect layer parsing 
see https://github.com/alco/psdump/blob/master/libpsd-0.9</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="k">class</span> <span class="nx">PSDLayerEffect</span>

  <span class="nv">constructor: </span><span class="nf">(@file) -&gt;</span>
  
  <span class="nv">parse: </span><span class="o">-&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>these are common to all effects</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="p">[</span><span class="nx">@version</span><span class="p">]</span> <span class="o">=</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readf</span> <span class="s2">&quot;&gt;i&quot;</span>

  <span class="nv">getSpaceColor: </span><span class="o">-&gt;</span>
    <span class="nx">@file</span><span class="p">.</span><span class="nx">read</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="c1"># 2 bytes for space</span>
    <span class="nx">@file</span><span class="p">.</span><span class="nx">readf</span> <span class="s2">&quot;&gt;HHHH&quot;</span> <span class="c1"># 4 * 2 byte color component - r, g, b, a</span>
   
<span class="k">class</span> <span class="nx">PSDLayerEffectCommonStateInfo</span> <span class="k">extends</span> <span class="nx">PSDLayerEffect</span>

  <span class="nv">parse: </span><span class="o">-&gt;</span> 
    <span class="k">super</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <p>always true</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@visible = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readBoolean</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <p>unused</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nx">@file</span><span class="p">.</span><span class="nx">read</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>

    <span class="p">{</span><span class="nv">visible: </span><span class="nx">@visible</span><span class="p">}</span></pre></div>             </td>           </tr>                               <tr id="section-5">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-5">&#182;</a>               </div>               <p>Based on https://github.com/alco/psdump/blob/master/libpsd-0.9/src/drop_shadow.c</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="k">class</span> <span class="nx">PSDDropDownLayerEffect</span> <span class="k">extends</span> <span class="nx">PSDLayerEffect</span>

  <span class="nv">constructor: </span><span class="nf">(file, @inner = false) -&gt;</span> 
    <span class="k">super</span><span class="p">(</span><span class="nx">file</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <p>defaults </p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@blendMode = </span><span class="s2">&quot;mul&quot;</span>
    <span class="vi">@color = @nativeColor = </span><span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">]</span>
    <span class="vi">@opacity = </span><span class="mi">191</span>
    <span class="vi">@angle = </span><span class="mi">120</span>
    <span class="vi">@useGlobalLight = </span><span class="kc">true</span>
    <span class="vi">@distance = </span><span class="mi">5</span></pre></div>             </td>           </tr>                               <tr id="section-7">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-7">&#182;</a>               </div>               <p>v2</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@spread = </span><span class="mi">0</span>
    <span class="vi">@size = </span><span class="mi">5</span>
    <span class="vi">@antiAliased = </span><span class="kc">false</span>
    <span class="vi">@knocksOut = </span><span class="kc">false</span>

  <span class="nv">parse: </span><span class="o">-&gt;</span>
    <span class="k">super</span><span class="p">()</span>

    <span class="p">[</span>
      <span class="nx">@blur</span><span class="p">,</span>      <span class="c1"># This seems to be wrong in the specification! - see libpsd</span>
      <span class="nx">@intensity</span><span class="p">,</span>
      <span class="nx">@angle</span><span class="p">,</span>
      <span class="nx">@distance</span>
    <span class="p">]</span> <span class="o">=</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readf</span> <span class="s2">&quot;&gt;hiii&quot;</span>


    <span class="nx">@file</span><span class="p">.</span><span class="nx">read</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="c1"># extra 2 bytes for space. The spec doesn&#39;t mention this!</span>

    <span class="vi">@color = </span><span class="nx">@getSpaceColor</span><span class="p">()</span>

    <span class="p">[</span> 
      <span class="nx">@signature</span><span class="p">,</span>
      <span class="nx">@blendMode</span>
    <span class="p">]</span> <span class="o">=</span>  <span class="nx">@file</span><span class="p">.</span><span class="nx">readf</span> <span class="s2">&quot;&gt;4s4s&quot;</span>

    <span class="vi">@enabled = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readBoolean</span><span class="p">()</span>
    <span class="vi">@useAngleInAllFX = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readBoolean</span><span class="p">()</span>
    
    <span class="p">[</span><span class="nx">@opacity</span><span class="p">]</span> <span class="o">=</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> 
    
    <span class="vi">@nativeColor = </span><span class="nx">@getSpaceColor</span><span class="p">()</span> <span class="k">if</span> <span class="nx">@version</span> <span class="o">==</span> <span class="mi">2</span>

    <span class="nv">data = </span><span class="p">{}</span>
    <span class="k">for</span> <span class="nx">own</span> <span class="nx">key</span><span class="p">,</span> <span class="nx">val</span> <span class="k">of</span> <span class="err">@</span>
      <span class="k">continue</span> <span class="k">if</span> <span class="nx">key</span> <span class="o">is</span> <span class="s2">&quot;file&quot;</span>
      <span class="nx">data</span><span class="p">[</span><span class="nx">key</span><span class="p">]</span> <span class="o">=</span> <span class="nx">val</span>

    <span class="nx">data</span>

</pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html>