---
title: PSD.rb
category: Ruby libraries
intro: |
  [PSD.rb](https://github.com/layervault/psd.rb) parses Photoshop documents in Ruby.
---

### Opening

```ruby
psd = PSD.new(file, parse_layer_images: true)
psd.parse!
```

### Traversing

```ruby
# Gets the root node.
# A #<Node> can be a Group or a Layer.
node = psd.tree
```

```ruby
node.root
node.descendants
node.ancestors
node.siblings
node.subtree
```

```ruby
node.descendant_groups
node.descendant_layers
```

### Layer info

```ruby
node.name   #=> "Layer 2"
```

```ruby
node.top    #=> 3
node.left   #=> 3
node.bottom
node.right
```

```ruby
# Note: these are interchanged (?)
node.width
node.height
```

```ruby
node.visible?
node.hidden?
```

```ruby
node.layer?
node.group?
```

```ruby
node.blending_mode  #=> "normal"
node.opacity        #=> 0..255
node.fill_opacity   #=> 0..255
```

### Layer text

```ruby
node.text                  #=> (Hash)
node.text[:value]          #=> "Text here"
node.text[:font][:name]    #=> "Arial"
node.text[:font][:sizes]   #=> [6.9]
node.text[:font][:colors]  #=> [[255,255,255,255]]
node.text[:font][:css]     #=> "font-family: ...;"
node.text[:left]           #=> 3
node.text[:top]
node.text[:right]
node.text[:bottom]
node.text[:transform]      #=> (Hash)
```

### Layer effects

```ruby
fx = node.info[:object_effects]
```

```ruby
fx.data['Scl ']   # ?
fx.data['GrFl']   # Gradient fill
```

### Layer mask

```ruby
node.mask["mask_size"] == 0    # No mask
node.mask["mask_size"] == 20   # Has mask
node.mask["top"]
node.mask["left"]
node.mask["bottom"]
node.mask["right"]
```

### Reference

 * [layervault/psd.rb](https://github.com/layervault/psd.rb) _(github.com)_