Index of values


(>>) [Vg]
x >> f is f x, associates to left.

A
add_xml_data [Vg.Vgr.Private]
add_xml_data b s adds s to b, escapes '<', '>', '&' and '"' (but not single quotes) and maps illegal XML unicode characters to the replacement character U+FFFD.
append [Vg.P]
append p' p appends p' to p.
axial [Vg.I]
axial stops pt pt' is an image with an axial color gradient varying between pt and pt' according to color stops stops.

B
blend [Vg.I]
blend src dst is src blended over dst using source over destination alpha blending.

C
ccurve [Vg.P]
ccurve c c' pt p is p with a cubic bézier curve from p's last point to pt with control points c and c'.
circle [Vg.P]
circle c r p is p with a circle subpath of center c and radius r.
close [Vg.P]
close p is p with a straight line from p's last point to p's current subpath starting point, this ends the subpath.
compare [Vg.I]
compare i i' is Pervasives.compare i i'.
compare [Vg.P]
compare p p' is Pervasives.compare p p'.
compare [Vg.Font]
compare font font' is Pervasives.compare font font'
compare_f [Vg.I]
compare_f cmp i i' is like Vg.I.compare but uses cmp to compare floating point values.
compare_f [Vg.P]
compare_f cmp p p' is like Vg.P.compare but uses cmp to compare floating point values.
compare_f [Vg.Font]
compare_f cmp font font' is like Vg.Font.compare but uses cmp to compare floating point values.
const [Vg.I]
const c is an image of color c.
create [Vg.Vgr]
create limit warn target dst is a renderer using target to render images to dst.
create_target [Vg.Vgr.Private]
create_target t makes an end-user render target from t.
css_font [Vg.Vgr.Private.Font]
css_font unit font is a CSS font property for the font with size expressed in unit.
css_slant [Vg.Vgr.Private.Font]
css_slant font is font's slant as a CSS font-style value.
css_weight [Vg.Vgr.Private.Font]
css_weight font is font's weigth as CSS font-weight value.
cut [Vg.I]
cut area p i is i with the area outside [a, p] cut out, i.e.
cut_glyphs [Vg.I]
WARNING.

D
dst [Vg.Vgr.Manual]
dst r s j l provides r with l bytes to write, starting at j in s.
dst_rem [Vg.Vgr.Manual]
dst_rem r is the remaining number of non-written, free bytes in the last buffer provided with Vg.Vgr.Manual.dst.

E
earc [Vg.P]
earc large cw a r pt p is p with an elliptical arc from p's last point to pt.
earc_params [Vg.Vgr.Private.P]
earc_params p large cw angle r p' is Some (c, m, a, a') with c the center of the ellipse, m a transform matrix mapping the unit circle to the ellipse, a and a' the angle on the unit circle corresponding to the first and last point of the arc.
ellipse [Vg.P]
ellipse c r p is p with an axis-aligned (unless angle is specified) ellipse subpath of center c and radii r.
empty [Vg.P]
empty is the empty path.
equal [Vg.I]
equal i i' is i = i'.
equal [Vg.P]
equal p p' is p = p'.
equal [Vg.Font]
equal font font' is font = font'.
equal_f [Vg.I]
equal eq i i' is like Vg.I.equal but uses eq to test floating point values.
equal_f [Vg.P]
equal_f eq p p' is like Vg.P.equal but uses eq to test floating point values.
equal_f [Vg.Font]
equal_f eq font font' is like Vg.Font.equal but uses eq to test floating point values.

F
flush [Vg.Vgr.Private]
flush k r flushes the renderer r.
fold [Vg.P]
fold ~rev f acc p, applies f to each subpath and subpath segments with an accumulator.
font [Vgr_pdf]
font is the default font resolver.

I
inv_tr_to_m3 [Vg.Vgr.Private.Data]
inv_tr_to_m3 tr is the matrix inverse of tr.
is_empty [Vg.P]
is_empty p is true iff p is empty.
is_void [Vg.I]
is_void i is i == void.

L
last_pt [Vg.P]
last_pt p is the last point of p's last subpath.
limit [Vg.Vgr.Private]
limit r is r's render limit.
line [Vg.P]
line pt p is p with a straight line from p's last point to pt.

M
miter_limit [Vg.Vgr.Private.P]
miter_limit o is the miter limit corresponding to o.miter_angle.
move [Vg.I]
move v i is i translated by v.

O
o [Vg.P]
o holds a default set of values.
of_data [Vg.Vgr.Private.I]
of_data d is the image from the internal representation d.
of_data [Vg.Vgr.Private.P]
of_data d is the path from the internal representation d.
of_image [Vg.Vgr.Private.Data]
of_image i is the internal representation of i.
of_path [Vg.Vgr.Private.Data]
of_path p is the internal representation of p.
otf_font [Vgr_pdf]
otf_font bytes is an OpenType font from the OpenType byte serialization bytes.

P
partial [Vg.Vgr.Private]
partial k r suspends the renderer r and returns `Partial.
pp [Vg.I]
pp ppf i prints a textual representation of i on ppf.
pp [Vg.P]
pp ppf p prints a textual representation of p on ppf.
pp [Vg.Font]
pp ppf font is a textual representation of font on ppf.
pp_area [Vg.P]
pp_area ppf a prints a textual representation of a on ppf
pp_f [Vg.I]
pp_f pp_float ppf i prints i like Vg.I.pp but uses pp_float to print floating point values.
pp_f [Vg.P]
pp_f pp_float ppf p prints p like Vg.P.pp but uses pp_float to print floating point values.
pp_outline [Vg.P]
pp_outline ppf o prints a textual representation of o on ppf.
pp_warning [Vg.Vgr]
pp_warning ppf w prints a textual representation of w on ppf.

Q
qcurve [Vg.P]
qcurve c pt p is p with a quadratic bézier curve from p's last point to pt with control point c.

R
radial [Vg.I]
radial stops ~f c r is an image with a color gradient varying according to color stops stops on circles whose center are on the segment from f to c and radius vary, respectively, from 0 to r.
rect [Vg.P]
rect r p is p with an axis-aligned rectangle subpath r.
render [Vg.Vgr]
render r v is: `Partial iff r has a `Manual destination and needs more output storage or if r has a limit. In the first case the client must use Vg.Vgr.Manual.dst to provide a new buffer. In both cases the client should then call Vg.Vgr.render with `Await until `Ok is returned., `Ok when the encoder is ready to encode a new `Image (if the renderer supports it) or `End. For `Manual destinations, encoding `End always returns `Partial the client should as usual use Vg.Vgr.Manual.dst and continue with `Await until `Ok is returned at which point Vg.Vgr.Manual.dst_rem r is guaranteed to be the size of the last provided buffer (i.e.
renderer [Vg.Vgr.Private]
renderer r is r's internal representation.
renderer_dst [Vg.Vgr]
render_dst r is r's destination.
renderer_limit [Vg.Vgr]
renderer_limit r is r's limit.
rot [Vg.I]
rot a i is i rotated by a.
rrect [Vg.P]
rrect r cr p is p with an axis-aligned rectangle subpath r with round corners of radii cr.

S
scale [Vg.I]
scale s i is i scaled by s.
screen_resolution [Vgr_htmlc]
screen_resolution is the screen resolution in pixels per meters.
stored_target [Vgr_cairo]
stored_target fmt is a fmt render target for rendering to the stored destination given to Vg.Vgr.create.
sub [Vg.P]
sub pt p is p with a new subpath starting at pt.

T
target [Vgr_cairo]
target ctx is a render target for rendering to the Cairo context ctx.
target [Vgr_svg]
target xml_decl xmp () is an SVG render target for rendering to the stored destination given to Vg.Vgr.create.
target [Vgr_pdf]
target font xmp () is a PDF render target for rendering to the stored destination given to Vg.Vgr.create.
target [Vgr_htmlc]
target resize resolution c is a render target for rendering to the canvas element c.
to_string [Vg.I]
to_string i is a textual representation of i.
to_string [Vg.P]
to_string p is a textual representation of p.
to_string [Vg.Font]
to_string font is a textual representation of font.
tr [Vg.I]
tr m i is the affine transform in homogenous 2D space of each point of i by m (see Gg.P2.tr).
tr [Vg.P]
tr m p is the affine transform in homogenous 2D space of the path p by m.
tr_to_m3 [Vg.Vgr.Private.Data]
tr_to_m3 tr is the matrix of tr.

V
void [Vg.I]
void is const Gg.Color.void, an invisible black image.

W
warn [Vg.Vgr.Private]
warn r w reports the warning w on r.
writeb [Vg.Vgr.Private]
writeb b k r writes the byte b and kontinues.
writebuf [Vg.Vgr.Private]
writebuf buf j l k r write l bytes from buf starting at j and kontinues.
writes [Vg.Vgr.Private]
writes s j l k r writes l bytes from s starting at j and kontinues.

X
xmp [Vg.Vgr]
xmp title authors creator_tool subject description create_date is an XML XMP metadata packet.