package giflib

  1. Overview
  2. Docs
On This Page
  1. GIF image

Module Giflib.ImageSource

GIF image

Represents a single image within the GIF file.

Sourcetype t
Sourceval v : ?offset:(int * int) -> ?transparent:int option -> ?delay_time:int option -> (int * int) -> ColorTable.t -> Bytes.t -> int -> bool -> t

v ?offset ?transparent ?delay_time dim palette compressed_image_data lzw_code_size interlaced Create an image record for use inside a GIF.t.

Sourceval of_pixels : ?offset:(int * int) -> ?transparent:int option -> ?delay_time:int option -> (int * int) -> ColorTable.t -> int array -> t

of_pixels ?offset ?transparency ?delay_time dimensions palette pixels Creates a new image record from a set of pixel data and a palette.

Sourceval dimensions : t -> int * int

The dimensions of the image. Note that this might be smaller than the dimensions of the GIF overall, as animated GIFs can have partial update frames.

Sourceval offset : t -> int * int

The offset of this image within the overall GIF dimensions

Sourceval palette : t -> ColorTable.t

The palette of RGB colour entries within the image

Sourceval pixels : t -> int array

The pixels in the palette space of the image

Sourceval rgb_pixels : t -> (int * int * int) array

The pixels in RGB space of the image

Sourceval transparent : t -> int option

If specified, the palette entry that should be treated as transparent for this image and not rendered on screen.

Sourceval delay_time : t -> int option

If specified, the time in 1/100ths of a second that should be delayed after this frame is rendered.

Sourceval compressed_image_data : t -> Bytes.t

Get the raw compressed image data. Use `pixels` or `rgb_pixels` to get the uncompressed data.