https://github.com/moaxcp/gif-builder

A java dsl for building animated gif files
https://github.com/moaxcp/gif-builder

gif gif-animation gif-creator

Last synced: 27 days ago
JSON representation

A java dsl for building animated gif files

• Host: GitHub
• URL: https://github.com/moaxcp/gif-builder
• Owner: moaxcp
• License: mit
• Created: 2019-06-08T03:05:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-05-26T01:45:50.000Z (over 2 years ago)
• Last Synced: 2023-07-26T22:02:34.965Z (over 1 year ago)
• Topics: gif, gif-animation, gif-creator
• Language: Java
• Homepage:
• Size: 80.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gif-builder

A java dsl for building gifs using [gifencoder](https://github.com/square/gifencoder).

![Maven Central](https://img.shields.io/maven-central/v/com.github.moaxcp/gif-builder)

[![javadoc](https://javadoc.io/badge2/com.github.moaxcp/gif-builder/javadoc.svg)](https://javadoc.io/doc/com.github.moaxcp/gif-builder)

# DSL

The dsl starts with static methods from `GifMethods`. Start with a `GifSpec.Builder`.

```

gif("image.gif");

```

Various options can be added including loop and the defaults for delay and disposal method. Delay is in milliseconds although this will be converted to deciseconds (standard for GIF).

Note: interlace and transparency is not supported by gifencoder and so are not supported here.

```

gif("image.gif")

    .defaultDelay(100)

    .defaultDisposalMethod(RESTORE_TO_BACKGROUND);

```

Once defaults are set images can be added. This uses the `ImageSpec`.

```

gif("image.gif")

    .defaultDelay(100)

    .defaultDisposalMethod(RESTORE_TO_BACKGROUND)

    .addImages(image(image1))

    .addImages(image(image2));

```

Images are BufferedImages.

An `ImageSpec` can contain other options for the gif sequence: delay, disposalMethod, leftPosition, topPosition.

Once the images are added to the `GifSpec` the specification can be built.

```

gif("image.gif")

    .defaultDelay(100)

    .defaultDisposalMethod(RESTORE_TO_BACKGROUND)

    .addImages(image(image1))

    .addImages(image(image2))

    .build();

```

The image can then be created.

```

gif("image.gif")

    .defaultDelay(100)

    .defaultDisposalMethod(RESTORE_TO_BACKGROUND)

    .addImages(image(image1))

    .addImages(image(image2))

    .build()

    .create();

```

# Conventions

* GIF size will match largest image

* If image is smaller than size it will be centered with a background

* Background of smaller image is guessed from pixel 1,1

# Example

Animate a moving square

```java

public class Main {

  private static int count = 1;

  public static void main(String... args) throws IOException {

    gif("gif.gif")

        .addImages(image(incrementImage()))

        .addImages(image(incrementImage()))

        .addImages(image(incrementImage()))

        .addImages(image(incrementImage()))

        .addImages(image(incrementImage()))

        .build()

        .create();

  }

  public static BufferedImage incrementImage() throws IOException {

    var image = new BufferedImage(600, 600, BufferedImage.TYPE_3BYTE_BGR);

    var graphics = image.getGraphics();

    graphics.setColor(Color.WHITE);

    graphics.drawRect(10 * count, 10 * count, 50, 50);

    graphics.dispose();

    ImageIO.write(image, "png", new File("image" + count + ".png"));

    count++;

    return image;

  }

}

```

[![example.gif](example.gif)](example.gif)

# Versions

## 0.2.0

Parent directories are now created before writing the gif file.

## 0.1.0

Initial implementation