Index of values

add s u is s with u added.

add_op r o adds render operation o on r.

attachements fb is fb's attachements.

attrs p is the attributes of p.

blend e is e's blend state.

blend_alpha is blend_default with the blend field to true.

blend_default is the default blend state: blend_default.blend is false., blend_default.blend_rgb is blend_default_eq., blend_default.blend_a is blend_default_eq., blend_default.blenc_cst is Gg.Color.void.

blend_default_eq is `Add (Src_a, One_minus_src_a).

blit filter r src sbox dst dbox blits between the buffers bufs src and dfb.

bool n v is a boolean uniform named n with value v.

buf is t's buffer if any.

buf a is a's buffer.

clear r fb clears the framebuffer fb using clears fb.

clears fb is fb's clears.

clear_default is the default clears: clears_default.clear_color is Some Color.void, clears_default.clear_depth is Some 1., clears_default.clear_stencil is None.

color is "color".

compiler_parser_default parses the following patterns into `Loc: msg:int:int:msg, int:int:msg Otherwise returns `Unparsed.

compiler_parser_raw s is always `Unparsed.

cout p is the count of p as specified at primitive creation.

count_now p is the number of vertices in the vertex stream.

cpu b st is the CPU buffer of b (if any).

cpu_autorelease buf is true if the CPU buffer is set to None once uploaded to the GPU.

cpu_buffer is like Lit.Buf.cpu but returns a Gg.buffer value.

cpu_count b is the number of scalars in the CPU buffer of b.

cpu_exists b is true if the CPU buffer of b exists.

create () is a new wireframe effect, the optional parameters can be used to preset the uniforms.

creates size b creates a renderer with backend b.

create mutisample size fmt is an image with size size and sample format fmt.

create attachements is a framebuffer with attachements attachments.

create tr proj viewport is a view such that: tr, defines the location and orientation of the view. It is the transform that maps world coordinates to view coordinates. Defaults to M4.id, i.e. we are at the origin looking at down the z-axis. It defines the builtin uniform value Lit.Uniform.world_to_view., proj, defines the viewing volume. It is the transform that maps view coordinates to clip space. Defaults to Lit.View.persp(`H Float.pi_div_4) 1.5 1. 100.. It defines the builtin uniform value Lit.Uniform.view_to_clip., viewport a rectangular area in normalized screen coordinates of the renderer's viewport; default is Box2.unit. It defines the builtin uniform values Lit.Uniform.viewport_o and Lit.Uniform.viewport_size.

create raster depth blend uniforms prog is an effect that uses the GPU program prog.

create uset shaders is the program made up of shaders, a list in which each shader_kind should appear at most once.

wrap_s, wrap_t, wrap_r, wrapping behaviour, if applicable, along s, t and r dimensions. Defaults to `Repeat., mipmaps, if true generates mipmaps. Defaults to false., min_filter, if applicable, minification filter. Defaults to `Nearest_mipmap_linear., mag_filter, if applicable, magnification filter. Defaults to `Nearest., buf_autorelease, doesn't keep a reference on buf once texture has been uploaded to gpu. Defaults to true for `D1 to `D3 but false on `Buffer.

create name tr first count index kind attrs is a primitive such that: tr is a is a transform that is right-multiplied to the render operation matrix (e.g. for normalizing disparate model coordinate scales); TODO defaults to id., name is an optional client name for identifiying the primitive; auto generated by default., first is the scalar index of the first vertex index in index, ignored if index is unspecified; defaults to 0., count is the number of vertices that are part of the vertex stream. count must be specified if index is unspecified. In that case count attribute elements in each attribute are read to define the vertex stream., index if specified must be a buffer of unsigned integers used to index the attribute elements to specify the vertex stream. If count is specified then always count indices will be read from index starting at first. If count is unspecified then all indices starting at first until the end of buffer will be read (hence the primitive's size may change dynamically)., kind the kind of primitive to render., attrs, the primitive's attributes.

create normalize stride first name dim buf is an attribute such that: normalize, if true, scalars stored as integer and signed integer are respectively mapped to floating point ranges [0;1] and [-1;1] on access on the GPU; defaults to false., stride is the number of scalars from attribute element to attribute element, defaults to dim., first is the scalar index of the first attribute element in buf; defaults to 0., name is the name of the attribute. This name will be used to bind the attribute to the corresponding input variable in the vertex shader, dim is the dimension of the data (from 1 to 4)., buf is the buffer holding the attribute elements.

create cpu_autorelease usage init is a buffer value such that: init is the buffer initialisation, see Lit.Buf.init., usage, hint specifiying the buffer usage, see Lit.Buf.usage (defaults to `Static_draw)., cpu_autorelease, if true (default) the CPU buffer is automatically released by setting it to None once it is uploaded to the GPU buffer.

cube tr name dups s is cube tr name dups (Box3.v_mid P3.o (Size3.v s s s)).

cuboid tr dups box is an axis-aligned cuboid bounded by box.

default is the default framebuffer with Lit.Fbuf.clears_default clears.

depth e is e's depth state.

depth_default is the default depth state: depth_default.depth_test is Some `Less., depth_default.depth_write is true., depth_default.depth_offset is (0., 0.)

dim a is a's dimension.

empty is the empty set of uniforms.

fbuf r is the framebuffer on which render ops are performed.

fill_color is the triangle's fill color, default to Color.white.

find s u is the value of u in s (if any).

find p n is the attribute named n of p (if any).

find s n is the value of a uniform named n (if any).

first p is first scalar index read from index.

first a is a's first attribute element scalar index.

float n v is a float uniform named n with value v.

fold f acc s folds f over the uniforms of s starting with acc.

fold f acc p folds f over the attributes of p starting with acc.

find s u is the value of u in s.

get p n is the attribute named n of p.

get_cpu b st is cpu b st but raises if there's no cpu buffer.

get_cpu_buffer is like Lit.Buf.get_cpu but returns a Gg.buffer value

find s u is the value of u in s.

get_uniform e u is the value of uniform u in e.

gl_renderer r is the OpenGL renderer of r.

gl_vendor r is the OpenGL renderer vendor of r.

gl_version r is the OpenGL version number of r.

gl_version r is the shading language version number of r.

gpu_count b is the number of scalars in the GPU buffer of b.

gpu_exists b is true if the GPU buffer of b exists.

gpu_map r access b st maps the GPU buffer of b with access access.

gpu_unmap r b unmaps the buffer b.

gpu_upload b is true if the CPU scalars will uploaded to the GPU next time the renderer uses the buffer.

index p is the index of p (if any).

init_of_raster r is a texture init value derived from raster.

insert ~loc:(`Loc (f, l)) src is the insert made of src located in file f at line l.

int n v is a integer uniform named n with value v.

is_empty s is true if s is empty.

is_multisample fb is true if fb is a multisample framebuffer.

is_value_builtin u is true if u has its value defined by the renderer.

iter p f iterates f over the attributes of p.

kind t is t's texture kind.

kind p is the kind of p.

lang s is the shading language for shader s.

loc s is the location of shader s.

look up at ~from:pos () in layman terms this is the transform which has the effect of putting you at position pos looking at the point at and with your head tilted to match the up direction.

m2 n v is a 2x2 matrix uniform named n with value v.

m3 n v is a 3x3 matrix uniform named n with value v.

m4 n v is a 4x4 matrix uniform named n with value v.

min_filter t is t's magnification filter.

mem p n is true there is an attribute with name n in p.

mem_named s n is true if s has a uniform named n.

min_filter t is t's minification filter.

mipmaps t is true if mipmaps are generated for texture.

model_to_clip is the model to clip space transform matrix, defaults to the `Model_to_clip built-in.

multisample b is b's multisample value.

multisample t is t's multisample parameters.

name p is the program name.

name u is the name of uniform u.

name p is the name of p.

name a is a's name.

ndc_of_surface view pt is the normalized device coordinates of the normalized surface coordinates pt in view.

ndc_of_viewport view pt is the normalized device coordinates in view of the normalized viewport coordinates pt in view.

nil is a stub texture that can be used for example to initialize texture uniforms.

nop is a render no-op, it has no effect on the renderer.

normal is "normal".

normalize a is a's normalization behaviour.

of_formatter ppf is a log that outputs on ppf.

op count uniforms tr e p is a render op.

persp fov aspect near far is a perspective projection matrix such that: fov is the field of view angle in radians along a given axis., aspect is the ratio between the horizontal field of view and the vertical field of view., near and far are positive distances to the near and far clip planes.

pp ppf u prints an unspecified representation of u on ppf.

pp ppf t is a textual represenation of t on ppf.

pp ppf p prints an unspecified representation of p on ppf.

pp ppf a prints an unspecified representation of a on ppf.

pp ppf b prints an unspecified representation of b on ppf.

pp_compiler_msg ppf m prints an unspecified representation of m on ppf.

pp_gl_synopsis ppf r prints a short two lines summary of the OpenGL implementation r is dealing with.

pp_gl_version ppf v prints an unspecified representation of v on ppf.

pp_init ppf init prints a textual representation of init on ppf.

pp_kind ppf k prints a textual representation of k on ppf

pp_kind ppf kind prints an unspecified representation of kind on ppf.

pp_loc ppf loc prints an unspecified representation of loc on ppf.

pp_mag_filter ppf m prints a textual representation of m on ppf

pp_mag_filter ppf m prints a textual representation of m on ppf

pp_msg ppf m prints an unspecified representation of m on ppf.

pp_sample_format ppf sf prints a textual representation of sp on ppf.

pp_set ppf set prints an unspecified representation of s on ppf.

pp_shader_stage ppf stage prints an unspecified representatino of stage on ppf.

pp_status ppf s prints a textual representation of s on ppf.

pp_usage ppf usage prints an uspecified representation of usage on ppf.

pp_wrap ppf w prints a textual representation of w on ppf

prog e is e's GPU program.

raster e is e's raster state.

raster_default is the default raster state: raster_default.raster_face_cull is None., raster_default.raster_multisample is true.

read r fb read box buf asynchronously reads the contents of framebuffer fb according to read in the rectangle box specified in integral screen coordinates and stores the result in the GPU buffer of buf, starting at index first (defaults to 0) and using w_stride pixels (defaults to (Box2.w box)) to move from line to line.

rect tr name tex d2 segs box is an axis-aligned Oxy 2D plane bounded by b.

release r releases GPU resources associated to the renderer.

rename a name is like a except the name is changed to name.

render clear r renders the added operations.

sample_format b is b's sample format.

sample_format t is t's sample format.

scalar_type b is the scalar type of b.

set_buf t b sets t's buffer to b.

set_clears fb clears sets fb's clears to clears.

set_cpu b ba sets the CPU buffer of b to ba.

set_cpu_autorelease b bool sets the autorelease behaviour to bool.

set_cpu_buffer is like Lit.Buf.set_cpu but uses a Gg.buffer value.

set_fbuf r fbuf sets the framebuffer to fbuf.

Needs to be called if you change the underlying buffer and want buffer changes to be picked up.

set_gpu_upload b u if u is true sets b to upload its CPU buffer to the GPU buffer next time the renderer sees the buffer.

TODO add the rest

set_uniform e u v sets the value of uniform u to v in e.

shader ~loc:(`Loc (f, l)) ~inserts stage src is the shader for stage stage made by pre-concatening the inserts inserts to src located in file f at line l.

shader_stages r is the list of shader stages supported by the renderer.

shaders p is the shaders of p.

size2 b is b's size.

size2 t is t's width and height.

size3 t is t's width and height in samples.

source ?lang s is the source of shader s as will be given to the GPU.

sphere tr name level r is a sphere of radius r centered on the origin obtained by subdividing an octahedron (level = 0).

stage s is the shader stage of s.

status r fb is fb's status.

stride a is a's attribute element scalar stride.

surface_of_ndc view pt is the normalized surface coordinates of the normalized device coordinates pt in view.

surface_of_viewport view pt is the normalized surface coordinates of the normalized viewport coordinates pt in view.

sync_cpu_to_gpu r b uploads the CPU buffer of b to the GPU buffer.

gpu_to_cpu r b reads back b's GPU buffer into b's CPU buffer.

tex n v is a sampler uniform named n with value v.

tex is "tex".

texn n is (Printf.sprintf "tex%d" n)

tr p is pre-transform matrix of p.

uniforms e the uniforms that are used with e's program.

uniforms p are the default uniforms of p.

usage b is the usage of b.

v is Lit.Uniform.set_value.

v2 n v is a 2D vector uniform named n with value v.

v3 n v is a 3D vector uniform named n with value v.

v4 n v is a 4D vector uniform named n with value v.

value u is the value of uniform u.

vertex is "vertex".

in surface coordinates.

viewport_of_ndc view pt is the normalized viewport coordinates in view of the normalized device coordinates pt in view.

viewport_of_surface view pt is the normalized viewport coordinates in view of the normalized surface coordinates pt.

TODO

in surface coordinates.

wire_color is the wireframe color, defaults to Color.black.

wire_only, if true only the wireframe is shown, defaults to false.

wire_width is the wire width (TODO in which space), default to 1.

with_normals prim is prim with a Lit.Attr.normal attribute added or replaced.

wrap_r t is t's texturing wrapping mode in the r dimension.

wrap_s t is t's texturing wrapping mode in the s dimension.

wrap_t t is t's texturing wrapping mode in the t dimension.