https://github.com/snowkit/gifcapture

A threaded Haxe GIF capture recording helper
https://github.com/snowkit/gifcapture

Last synced: 2 months ago
JSON representation

A threaded Haxe GIF capture recording helper

• Host: GitHub
• URL: https://github.com/snowkit/gifcapture
• Owner: snowkit
• License: mit
• Created: 2016-10-13T18:59:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2016-10-23T21:20:58.000Z (over 7 years ago)
• Last Synced: 2024-04-14T14:12:58.299Z (3 months ago)
• Language: Haxe
• Homepage:
• Size: 84 KB
• Stars: 13
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-snowkit - gifcapture

README

        
# gifcapture

A threaded GIF capture recording helper, wrapping the [GIF](https://github.com/snowkit/gif) encoding library into a background thread. Has a max time for fixed length recording, thread safe callbacks for progress and complete state with the gif bytes.

Due to the requirement of threads, this library only works on cpp (maybe neko).

**note** The GIF encoding library this wraps no such requirement.

Created by    

- [Tilman Schmidt](https://github.com/KeyMaster-/) 

- [Sven Bergström](https://github.com/underscorediscovery/)

### Install

`haxelib git gifcapture https://github.com/snowkit/gifcapture.git`

Add as a library dependency to your project.

### Usage

The API is documented with more information and usage.

Create a recorder:

```haxe

capture = new GifCapture(width, height, fps, max_time, GifQuality.High, GifRepeat.Infinite);

    //Listen for progress from the encoder

capture.onprogress = onprogress;

    //Listen for progress completion of the encoder

capture.oncomplete = oncomplete;

```

Start/pause/reset/commit a recording:

Note you can record as much as you like before committing.

```haxe

    // start

recorder.record();

    // stop/pause

recorder.pause();

    // complete

recorder.commit();

```

Add frames, with the haxe.io.UInt8Array of bytes, the delay time for the frame to be shown, and the flippedY flag for whether to flip the frame vertically (common requirement for OpenGL captured bytes).

```haxe

recorder.add_frame(frame_bytes, frame_delay, flippedY);

```

You must call `recorder.update()` to propagate callbacks (frequently, i.e every frame is fine)

```haxe

recorder.update();

```

### Example

See [luxe-gifcapture](https://github.com/underscorediscovery/luxe-gifcapture) `tests/test_luxe/`