Struct psd::Psd

pub struct Psd { /* private fields */ }

Represents the contents of a PSD file

PSB Support

We do not currently support PSB since the original authors didn’t need it, but adding support should be trivial. If you’d like to support PSB please open an issue.

Implementations

impl Psd

pub fn from_bytes(bytes: &[u8]) -> Result<Psd, PsdError>

Create a Psd from a byte slice.

You’ll typically get these bytes from a PSD file.

Example

let psd_bytes = include_bytes!("./my-psd-file.psd");

let psd = Psd::from_bytes(psd_bytes);

impl Psd

pub fn width(&self) -> u32

The width of the PSD file

pub fn height(&self) -> u32

The height of the PSD file

pub fn depth(&self) -> PsdDepth

The number of bits per channel

pub fn color_mode(&self) -> ColorMode

The color mode of the file

impl Psd

pub fn layers(&self) -> &Vec<PsdLayer>

Get all of the layers in the PSD

pub fn layer_by_name(&self, name: &str) -> Option<&PsdLayer>

Get a layer by name

pub fn layer_by_idx(&self, idx: usize) -> &PsdLayer

Get a layer by index.

index 0 is the bottom layer, index 1 is the layer above that, etc

pub fn groups(&self) -> &HashMap<u32, PsdGroup>

Get all of the groups in the PSD, in the order that they appear in the PSD file.

pub fn group_ids_in_order(&self) -> &Vec<u32>

Get the group ID’s in the order that they appear in Photoshop. (i.e. from the bottom of layers view to the top of the layers view).

pub fn get_group_sub_layers(&self, id: &u32) -> Option<&[PsdLayer]>

Returns sub layers of group by group id

pub fn flatten_layers_rgba(
    &self,
    filter: &dyn Fn((usize, &PsdLayer)) -> bool
) -> Result<Vec<u8>, PsdError>

Given a filter, combine all layers in the PSD that pass the filter into a vector of RGBA pixels.

We’ll start from the top most layer and iterate through the pixels.

If the pixel is transparent, recursively blend it with the pixels below it until we hit an opaque pixel or we hit the bottom of the stack.

TODO: Take the layer’s blend mode into account when blending layers. Right now we just use ONE_MINUS_SRC_ALPHA blending regardless of the layer.

impl Psd

pub fn rgba(&self) -> Vec<u8>

Get the RGBA pixels for the PSD [ R,G,B,A, R,G,B,A, R,G,B,A, …]

pub fn compression(&self) -> &PsdChannelCompression

Get the compression level for the flattened image data

impl Psd

pub fn resources(&self) -> &Vec<ImageResource>

Resources from the image resources section of the PSD file

Trait Implementations

impl Debug for Psd

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.