aseprite

type Ase struct {
	ColorDepth ColorDepth

	// Canvas size (width and height)
	Size image.Point

	// Pixel aspect ratio (width:height)
	PixelRatio image.Point

	// Timeline frame durations
	Durations []time.Duration

	// Layers. Layer indices increase from bottom to top in Aseprite UI.
	Layers []*Layer

	// HasLayersUUID indicates whether each layer in the file contains a Universally Unique Identifier.
	HasLayersUUID bool

	// Aseprite slices. https://www.aseprite.org/api/slice#slice
	Slices []Slice

	// Timeline animation tags
	Tags []*Tag

	// Tilesets used in Tilemap layers
	Tilesets []*Tileset

	// Palette of file
	Palette color.Palette

	// Palette index for used as transparent color in each layer. (only for indexed images)
	TransparentIndex uint8

	ColorProfile ColorProfile
}

type BlendMode uint16

type Cel struct {

	// LayerIndex is the raw index of the layer this cel belongs to.
	LayerIndex int

	// ZIndex defines the display order override.
	// 0 = default, +N = show N layers forward, -N = show N layers back.
	ZIndex int

	// Cel position
	Pos image.Point

	// Cel Width and Cel Height. Pixel unit for Image layers.
	//
	// Number of tiles for Tilemap layers.
	Size image.Point

	// Cel image
	Image image.Image

	// Cel opacity. (0-255)
	Opacity uint8

	// Tiles contains the ID and flip flags for each tile in a tilemap layer.
	// This is nil for regular image layers.
	Tiles []Tile

	// Type specifies if this cel is a Raw Image, Linked Cel, Compressed Image, or Tilemap.
	Type CelType

	// UserData contains extra information like text and color associated with the cel.
	UserData
	// contains filtered or unexported fields
}

type CelType uint16

type ColorDepth uint16

type ColorProfile struct {
	Type  uint16  // 0: No color profile, 1: Use sRGB, 2: Use embedded ICC profile
	Flags uint16  // Bit 1: Use special fixed gamma
	Gamma float64 // Fixed gamma value converted from 16.16 fixed-point
	ICC   []byte  // Embedded ICC profile data (only populated if Type == 2)
}

type FlipBitMask uint8

type Layer struct {

	// Layer name.
	Name string

	// Layer's universally unique identifier.
	//
	// This field is uuid.Nil (all zeros) if Ase.HasLayersUUID is false.
	UUID uuid.UUID

	// Layer type
	Type LayerType

	// Layer flags
	Flags uint16

	// Blending mode of this layer.
	BlendMode BlendMode

	// Layer opacity. (0-255)
	Opacity uint8

	// Index matches the frame number
	Cels []*Cel

	// The child level is used to show the relationship of this layer with the last one read.
	//
	// https://github.com/aseprite/aseprite/blob/main/docs/ase-file-specs.md#note1
	ChildLevel uint16

	// Index for Ase.Tilesets[]
	TilesetIndex uint32

	UserData
	// contains filtered or unexported fields
}

type LayerType uint16

type LoopDirection uint8

type Slice struct {
	UserData
	Name   string
	Frames []SliceFrame
}

type SliceFrame struct {

	// The bounds of the slice in the canvas
	Bounds image.Rectangle

	// 9-slices internal rectangle (relative to slice bounds)
	Rect9Slices image.Rectangle

	// A pivot to specify the central/base location. (relative to slice bounds)
	Pivot image.Point
}

type Tag struct {
	Name string

	// Frame index where this tag starts.
	Start int

	// Frame index where this tag ends.
	End int

	// Play this animation section N times, 0 means infinite.
	Repeat uint16

	LoopDirection LoopDirection

	UserData
}

type Tile struct {
	ID  uint32      // Tile index
	XYD FlipBitMask // XYD bitmask flags
}

type Tileset struct {

	// Tileset name
	Name string

	// Tileset ID
	ID uint32

	// Tile width/height
	TileSize image.Point

	NumTiles int

	// Tileset image containing all tiles vertically (Present if Flags & 2 is set)
	Image image.Image

	// Tileset flags
	//
	// 1 - Include link to external file
	//
	// 2 - Include tiles inside this file
	//
	// 4 - Tilemaps using this tileset use tile ID=0 as empty tile
	//     (this is the new format). In rare cases this bit is off,
	//     and the empty tile will be equal to 0xffffffff (used in
	//     internal versions of Aseprite)
	//
	// 8 - Aseprite will try to match modified tiles with their X
	//     flipped version automatically in Auto mode when using
	//     this tileset.
	//
	// 16 - Same for Y flips
	//
	// 32 - Same for D(iagonal) flips
	Flags uint32

	// External file data (Present if Flags & 1 is set)
	ExternalFileID    uint32
	ExternalTilesetID uint32

	// Index to show in the UI (usually 1)
	BaseIndex int
}

type UserData struct {
	Color color.NRGBA
	Text  string
}