package stk

You can search for identifiers within the package.

in-package search v0.2.0

SDL-based GUI toolkit

Install

dune-project

Dependency

zoggy.frama.io Readme Edit opam file Versions (5)

Authors

Z

Zoggy <zoggy@bat8.org>

Maintainers

Z

zoggy@bat8.org

Sources

ocaml-stk-0.3.0.tar.bz2

md5=bf3724827aa00f2b5072a9f5e5e9293f

sha512=c7804040165317533b1bbaa6a23374a0bce5ba6976a2f48b49c90aa43c510b03134a1b2c353485365f4dd0cee8cb72d7fbe7558ee52e758db886771e262262d8

doc/stk/Stk/G/index.html

Module `Stk.G`Source

Geometry.

This module is used to represent and compute widget coordinates.

Sourcetype t = {

x : int;
y : int;
w : int;
(*
width
*)
h : int;
(*
height
*)

}

A geometry is rectangle. x and y are coordinates of top-left corner.

Sourceval to_string : t -> string

Sourceval pp : Format.formatter -> t -> unit

Sourceval create : x:int -> y:int -> w:int -> h:int -> t

Convenient function to create a t.

Sourceval seg_inter : int -> int -> int -> int -> (int * int) option

seg_inter x1 w1 x2 w2 returns the intersection segment (left..right) between segments (x1..(x1+w1)) and (x2..(x2+w2)), if any.

Sourceval inter : t -> t -> t option

Intersection between two rectangles, if any.

Sourceval union : t -> t -> t

Union of two rectangles, i.e. returns the rectangle containing both.

Sourceval zero : t

Zero geometry, all fields set to 0.

Sourceval is_zero : t -> bool

Sourceval inside : x:int -> y:int -> t -> bool

inside ~x ~y g returns true is point (x, y) is inside g.

Sourceval translate : ?x:int -> ?y:int -> t -> t

translate ~x ~y g returns a new geometry, adding x (resp. y) to g.x (resp. g.y) if specified.

Sourceval enlarge : ?w:int -> ?h:int -> t -> t

enlarge ~w ~h g returns a new geometry whose width (resp. height) is increased by 2 * w (resp. 2 * h). g.x (resp. g.y) is translated by -w (resp. -h) so that the final geometry remains centered with report to the original one.

Sourceval to_rect : t -> Tsdl.Sdl.rect

to_rect g creates a Tsdl.Sdl.rect from g.

Sourceval of_rect : Tsdl.Sdl.rect -> t

of_rect r creates a geometry t from a Tsdl.Sdl.rect.

Sourceval has_intersect : t -> t -> bool

has_intersect g1 g2 returns true if intersection g1 g2 <> None.

Sourceval remove_border : t -> int Props.trbl -> t

remove_border g borders returns a new geometry by removing borders from g. It is ensured that the returned geometry has non-negative width and height.