d2dc6

Documentation

Overview

Package d2dc6 contains the logic for loading and processing DC6 files.

Index

• type DC6
  • func Load(data []byte) (*DC6, error)
  • func (d *DC6) Clone() *DC6
  • func (d *DC6) DecodeFrame(frameIndex int) []byte
• type DC6Frame
• type DC6FrameHeader
• type DC6Header

Types

type DC6

type DC6 struct {
	Version            int32
	Flags              uint32
	Encoding           uint32
	Termination        []byte // 4 bytes
	Directions         uint32
	FramesPerDirection uint32
	FramePointers      []uint32    // size is Directions*FramesPerDirection
	Frames             []*DC6Frame // size is Directions*FramesPerDirection
}

DC6 represents a DC6 file.

func Load

func Load(data []byte) (*DC6, error)

Load uses restruct to read the binary dc6 data into structs then parses image data from the frame data.

func (*DC6) Clone

func (d *DC6) Clone() *DC6

Clone creates a copy of the DC6

func (*DC6) DecodeFrame

func (d *DC6) DecodeFrame(frameIndex int) []byte

DecodeFrame decodes the given frame to an indexed color texture

type DC6Frame

type DC6Frame struct {
	Flipped    uint32
	Width      uint32
	Height     uint32
	OffsetX    int32
	OffsetY    int32
	Unknown    uint32
	NextBlock  uint32
	Length     uint32
	FrameData  []byte // size is the value of Length
	Terminator []byte // 3 bytes
}

DC6Frame represents a single frame in a DC6.

type DC6FrameHeader

type DC6FrameHeader struct {
	Flipped   int32  `struct:"int32"`
	Width     int32  `struct:"int32"`
	Height    int32  `struct:"int32"`
	OffsetX   int32  `struct:"int32"`
	OffsetY   int32  `struct:"int32"`
	Unknown   uint32 `struct:"uint32"`
	NextBlock uint32 `struct:"uint32"`
	Length    uint32 `struct:"uint32"`
}

DC6FrameHeader represents the header of a frame in a DC6.

type DC6Header

type DC6Header struct {
	Version            int32  `struct:"int32"`
	Flags              uint32 `struct:"uint32"`
	Encoding           uint32 `struct:"uint32"`
	Termination        []byte `struct:"[4]byte"`
	Directions         int32  `struct:"int32"`
	FramesPerDirection int32  `struct:"int32"`
}

DC6Header represents the file header of a DC6 file.