/usr/lib/ocaml/camlimages/image_intf.mli is in libcamlimages-ocaml-dev 1:4.2.0-1.1build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 | (***********************************************************************)
(* *)
(* Objective Caml *)
(* *)
(* FraníÐis Pessaux, projet Cristal, INRIA Rocquencourt *)
(* Pierre Weis, projet Cristal, INRIA Rocquencourt *)
(* Jun Furuse, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 1999-2004, *)
(* Institut National de Recherche en Informatique et en Automatique. *)
(* Distributed only by permission. *)
(* *)
(***********************************************************************)
(* $Id: image_intf.mli,v 1.2 2009/07/04 03:39:28 furuse Exp $ *)
(** Color to bytes encoder/decoder module type *)
module type ENCODE =
sig
type t
val bytes_per_pixel : int
val get : bytes -> int -> t
val set : bytes -> int -> t -> unit
val make : t -> bytes
end;;
(** Low level image module type *)
module type RAWIMAGE = sig
module Encode : ENCODE
type elt
and bitmap
and t = { width : int; height : int; bitmap : bitmap; }
val width : t -> int
val height : t -> int
val dump : t -> bytes
val create_with : int -> int -> bytes -> t
val create_with_scanlines : int -> int -> bytes array -> t
val create : int -> int -> t
val make : int -> int -> elt -> t
val unsafe_access : t -> int -> int -> bytes * int
val get_strip : t -> int -> int -> int -> bytes
val set_strip : t -> int -> int -> int -> bytes -> unit
val get_scanline : t -> int -> bytes
val get_scanline_ptr : t -> (int -> (bytes * int) * int) option
val set_scanline : t -> int -> bytes -> unit
val unsafe_get : t -> int -> int -> elt
val unsafe_set : t -> int -> int -> elt -> unit
val get : t -> int -> int -> elt
val set : t -> int -> int -> elt -> unit
val destroy : t -> unit
val copy : t -> t
val sub : t -> int -> int -> int -> int -> t
val blit : t -> int -> int -> t -> int -> int -> int -> int -> unit
val map : (elt -> elt -> elt) ->
t -> int -> int -> t -> int -> int -> int -> int -> unit
val blocks : t -> int * int
val dump_block : t -> int -> int -> Bitmap.Block.t
end;;
(** low image container module type *)
module type CONTAINER = sig
type container
type rawimage
val rawimage : container -> rawimage
val create_default : int -> int -> rawimage -> container
val create_duplicate : container -> int -> int -> rawimage -> container
end;;
module type IMAGE = sig
type t
type elt
(** Image creation *)
val create : int -> int -> t
(** [create w h] creates an image with a size [w]x[h]. The content is
the image is not initialized. *)
val make : int -> int -> elt -> t
(** [make w h c] creates an image with a size [w]x[h]. The content is
the image is initialized to the color [c]. *)
val destroy : t -> unit
(** [destroy t] explicitly frees the image content of [t].
If you do not use bitmap swap files, you do not need to call
this function, since GC will free unreachable image data automatically.
Read bitmap.mli for more details. *)
(** Pixel access *)
val get : t -> int -> int -> elt
(** [get t x y] gets image pixel of [t] at [x],[y]. If [x],[y] is
outside of the image size, Images.Out_of_image exception is raised. *)
val set : t -> int -> int -> elt -> unit
(** [set t x y c] sets image pixel of [t] at [x],[y] by the color [c].
If [x],[y] is outside of the image size, Images.Out_of_image exception
is raised. *)
val unsafe_get : t -> int -> int -> elt
val unsafe_set : t -> int -> int -> elt -> unit
(** Unsafe versions of [get] and [set]. It does not perform any image
boundary check. If the coordinates are out of the given image,
the result is undefined. Use carefully. *)
(** Image copy *)
val copy : t -> t
(** [copy t] duplicates the image [t]. *)
val sub : t -> int -> int -> int -> int -> t
(** [sub t x y w h] duplicates a subimage of [t] of size [w]x[h],
whose origin (0,0) is at (x,y) of [t]. *)
val blit : t -> int -> int -> t -> int -> int -> int -> int -> unit
(** [blit src x y dst x' y' w h] copies rectangular area of [src] at
[x],[y] with size [w]x[h], to an image [dst]. The origin of
the subimage comes at [x'],[y'] of [dst]. *)
val map : (elt -> elt -> elt) ->
t -> int -> int -> t -> int -> int -> int -> int -> unit
(** [map f src x y dst x' y' w h] maps pixels of the rectangular area
of [src] at [x],[y] with size [w]x[h], to an image [dst],
using color conversion function [f]. The origin of the subimage
comes at [x'],[y'] of [dst]. *)
(** functions for internal use *)
val dump : t -> bytes
val unsafe_access : t -> int -> int -> bytes * int
val get_strip : t -> int -> int -> int -> bytes
val set_strip : t -> int -> int -> int -> bytes -> unit
val get_scanline : t -> int -> bytes
val get_scanline_ptr : t -> (int -> (bytes * int) * int) option
val set_scanline : t -> int -> bytes -> unit
val blocks : t -> int * int
val dump_block : t -> int -> int -> Bitmap.Block.t
end;;
module type CONTAINER_INDEXED = sig
type container
type rawimage
type mapelt
val rawimage : container -> rawimage
val create_default : int -> int -> rawimage -> container
val create_duplicate : container -> int -> int -> rawimage -> container
val colormap : container -> mapelt Color.map
end;;
module type IMAGEINDEXED = sig
include IMAGE
type mapelt
(** Pixel access *)
val get_color : t -> int -> int -> mapelt
(** [get_color x y] returns image pixel color value of [t] at [x],[y].
If [x],[y] is outside of the image size, Images.Out_of_image exception
is raised. *)
val unsafe_get_color : t -> int -> int -> mapelt
end;;
|