psd

README

go-psd

go-psd is a library for parsing Photoshop PSD files.

Documentation

Index

• Constants
• Variables
• func Encode(w io.Writer, psd *PSD) error
• type AdditionalInfo
• type BlendModeKey
  • func (b BlendModeKey) String() string
• type BlendingRanges
• type BlendingRangesData
• type Channel
• type Clipping
  • func (c Clipping) String() string
• type ColorMode
  • func (c ColorMode) Channels() int
  • func (c ColorMode) String() string
• type ColorModeData
• type GlobalLayerMask
• type Header
  • func (h *Header) IsPSB() bool
  • func (h *Header) Rect() image.Rectangle
• type Image
• type ImageResourceBlock
• type Layer
• type Mask
• type PSD
  • func Decode(r io.Reader) (*PSD, error)

Constants

const (
	ColorModeBitmap       = ColorMode(0)
	ColorModeGrayScale    = ColorMode(1)
	ColorModeIndexed      = ColorMode(2)
	ColorModeRGB          = ColorMode(3)
	ColorModeCMYK         = ColorMode(4)
	ColorModeMultichannel = ColorMode(7)
	ColorModeDuotone      = ColorMode(8)
	ColorModeLab          = ColorMode(9)
)

Variables

var (
	ErrHeaderFormat    = errors.New("psd: invalid header format")
	ErrHeaderVersion   = errors.New("psd: invalid header version")
	ErrHeaderChannels  = errors.New("psd: invalid header channels")
	ErrHeaderHeight    = errors.New("psd: invalid header height")
	ErrHeaderWidth     = errors.New("psd: invalid header width")
	ErrHeaderDepth     = errors.New("psd: invalid header depth")
	ErrHeaderColorMode = errors.New("psd: invalid header colorMode")
)

header error

var (
	ErrColorModeData = errors.New("psd: invalid color mode data")
)

var (
	ErrImageResourceBlock = errors.New("psd: invalid image resource block")
)

Functions

func Encode

func Encode(w io.Writer, psd *PSD) error

Types

type AdditionalInfo

type AdditionalInfo struct {
	Key  string
	Data []byte
}

type BlendModeKey

type BlendModeKey string

func (BlendModeKey) String

func (b BlendModeKey) String() string

type BlendingRanges

type BlendingRanges struct {
	CompositeGrayBlend *BlendingRangesData
	Channels           []*BlendingRangesData
}

type BlendingRangesData

type BlendingRangesData struct {
	Source      int
	Destination int
}

type Channel

type Channel struct {
	ID     int
	Length int
}

type Clipping

type Clipping byte

func (Clipping) String

func (c Clipping) String() string

type ColorMode

type ColorMode int

func (ColorMode) Channels

func (c ColorMode) Channels() int

func (ColorMode) String

func (c ColorMode) String() string

type ColorModeData

type ColorModeData struct {
	Data []byte
}

type GlobalLayerMask

type GlobalLayerMask struct {
	OverlayColor    int
	ColorComponents []byte
	Opacity         int
	Kind            int
	Fillers         int
}

type Header

type Header struct {
	Version   int
	Channels  int
	Height    int
	Width     int
	Depth     int
	ColorMode ColorMode
}

func (*Header) IsPSB

func (h *Header) IsPSB() bool

func (*Header) Rect

func (h *Header) Rect() image.Rectangle

type Image

type Image interface {
	image.Image
	Source(rect image.Rectangle, src ...[]byte)
}

type ImageResourceBlock

type ImageResourceBlock struct {
	ID   int
	Name string
	Data []byte
}

type Layer

type Layer struct {
	Index int
	ID    int

	LegacyName string
	Name       string

	Rect  image.Rectangle
	Image image.Image

	Channels     []*Channel
	BlendModeKey BlendModeKey
	Opacity      int
	Clipping     Clipping
	Flags        byte
	Filler       byte

	TransparencyProtected bool
	Visible               bool
	Obsolete              bool
	IrrelevantPixelData   bool

	Mask            *Mask
	BlendingRanges  *BlendingRanges
	AdditionalInfos []*AdditionalInfo
}

type Mask

type Mask struct {
	Rect image.Rectangle

	DefaultColor byte
	Flags        byte

	Padding []byte

	RealFlags         *byte
	RealBackground    *byte
	RectEnclosingMask *image.Rectangle
}

type PSD

type PSD struct {
	Header          *Header
	ColorModeData   *ColorModeData
	ImageResources  []*ImageResourceBlock
	Layers          []*Layer
	GlobalLayerMask *GlobalLayerMask
	AdditionalInfos []*AdditionalInfo
	Image           image.Image
}

func Decode

func Decode(r io.Reader) (*PSD, error)