vkf_layer Module

public function vkf_cache_clear() bind(C, name="vkf_cache_clear")

Delete the cache's files (converted fonts, compiled shaders; nothing else), and its fonts and shaders directories if left empty (not the cache directory). Returns the number of files removed, or -1 if some couldn't be.

Arguments

Return Value integer(kind=c_int)

public function vkf_cache_directory(buf, buflen) bind(C, name="vkf_cache_directory")

The cache directory (src/vsg/vkf_cache.h: VKFRAMES_CACHE_DIR, or the user's cache directory; created if it doesn't exist) into buf (not null-terminated); returns its length (0: none, or it can't be created), or -1 if buf is too short.

Arguments

Return Value integer(kind=c_int)

public function vkf_compile_node(node) bind(C, name="vkf_compile_node")

Compile a node for the running viewers (to add it to a shown scene). Viewers not yet running compile it with their scene at their first frame. Returns 0 on success.

Arguments

Return Value integer(kind=c_int)

public subroutine vkf_driver_preload() bind(C, name="vkf_driver_preload")

Start loading the Vulkan driver, on a thread of its own, for the first window (see DriverPreload in vkf_layer.cpp): called when a scene is set up, before its window opens.

Arguments

public subroutine vkf_font_delete(font) bind(C, name="vkf_font_delete")

Delete a font handle.

Arguments

public function vkf_font_read(filename, filename_len) bind(C, name="vkf_font_read")

Read a font file (TrueType, ... through vsgXchange's freetype): a font handle, or null on failure. Converting a font takes seconds, so the result is cached and read from there next time.

Arguments

Return Value type(c_ptr)

public subroutine vkf_gui_begin(gui, title, title_len, x, y, pivot_x, pivot_y, follow) bind(C, name="vkf_gui_begin")

Begin a panel: the widgets up to vkf_gui_end are in it.

Arguments

public function vkf_gui_button(gui, label, label_len) bind(C, name="vkf_gui_button")

A button: 1 if it was clicked since the last call for it (in this panel), else 0.

Arguments

Return Value integer(kind=c_int)

public function vkf_gui_checkbox(gui, label, label_len, value) bind(C, name="vkf_gui_checkbox")

A checkbox showing value: 1 (and value set) if the user changed it since the last call for it, else 0.

Arguments

Return Value integer(kind=c_int)

public function vkf_gui_combo(gui, label, label_len, index, items, items_len) bind(C, name="vkf_gui_combo")

A combo box (drop-down menu) of items (newline-separated), showing item index (0-based): 1 (and index set) if the user chose another since the last call for it, else 0.

Arguments

Return Value integer(kind=c_int)

public subroutine vkf_gui_end(gui) bind(C, name="vkf_gui_end")

End the panel begun by vkf_gui_begin.

Arguments

public subroutine vkf_gui_same_line(gui) bind(C, name="vkf_gui_same_line")

Put the next widget on the same line as the last one.

Arguments

public subroutine vkf_gui_separator(gui) bind(C, name="vkf_gui_separator")

A horizontal separator in the current panel.

Arguments

public function vkf_gui_slider(gui, label, label_len, value, low, high, format, format_len) bind(C, name="vkf_gui_slider")

A slider showing value from low to high (as format, printf's; empty: "%.4g"): 1 (and value set) if the user changed it since the last call for it, else 0.

Arguments

Return Value integer(kind=c_int)

public subroutine vkf_gui_text(gui, text, text_len) bind(C, name="vkf_gui_text")

A line of text in the current panel.

Arguments

public subroutine vkf_image_delete(image) bind(C, name="vkf_image_delete")

Delete an image handle.

Arguments

public function vkf_image_read(filename, filename_len) bind(C, name="vkf_image_read")

Read an image file (png, jpg, ...): an image handle, or null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_label_create(font, text, text_len, rgba, position, size, max_size, halign, valign) bind(C, name="vkf_label_create")

A label (a node handle): text at position, facing the screen; null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_label_set_at_infinity(label, on) bind(C, name="vkf_label_set_at_infinity")

Draw a label at infinity (on /= 0: its position a direction, in its parent's axes; at the far plane, behind the scene, as the sky's stars) or at its position (0). Returns 0, or -1 if not a label.

Arguments

Return Value integer(kind=c_int)

public function vkf_label_set_color(label, rgba) bind(C, name="vkf_label_set_color")

Change a label's color. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_label_set_layout(label, position, size, max_size, halign, valign) bind(C, name="vkf_label_set_layout")

Change a label's layout, in place. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_label_set_on_top(label, on) bind(C, name="vkf_label_set_on_top")

Draw a label on top of the scene (at the near plane, as HUD labels: not hidden by what is in front of it) or depth-tested. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_label_set_text(label, text, text_len) bind(C, name="vkf_label_set_text")

Change a label's text, in place: a text longer than the label's capacity (glyphs allocated when it was made) is cut to it, with a warning. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_light_create() bind(C, name="vkf_light_create")

A light (a node handle), initially a directional light along -z (in its node's coordinates) of white diffuse color and no ambient or specular part; null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_light_set(light, ambient, diffuse, specular, position) bind(C, name="vkf_light_set")

Set a light's colors and position, in its node's coordinates. Returns 0 (-1 for a bad handle).

Arguments

Return Value integer(kind=c_int)

public function vkf_line_colors(line, capacity) bind(C, name="vkf_line_colors")

The colors (4 floats per point) of a line made by vkf_line_create_colored (null for others).

Arguments

Return Value type(c_ptr)

public function vkf_line_create(capacity) bind(C, name="vkf_line_create")

A line strip holding up to capacity points (initially none): a node handle, or null on failure. Fortran fills its point and style buffers in place (vkf_line_points, vkf_line_style), then calls vkf_line_points_changed / vkf_line_style_changed. It can be shown in any number of windows.

Arguments

Return Value type(c_ptr)

public function vkf_line_create_colored(capacity) bind(C, name="vkf_line_create_colored")

A line with a color per point (vkf_line_colors), blended along each segment. A node handle, or null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_line_points(line, capacity) bind(C, name="vkf_line_points")

A line's point buffer, 8 floats per point (x, y, z and the distance along the strip from its start, high parts, then their low parts; see shaders/line.vert; markers ignore the distance), to fill in place; valid while the line handle exists. Null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_line_points_changed(line, n) bind(C, name="vkf_line_points_changed")

The first n points of the buffer have been written: draw n points and upload the buffer. Returns 0, or -1 if n exceeds the capacity.

Arguments

Return Value integer(kind=c_int)

public function vkf_line_set_dash_mode(line, mode, length) bind(C, name="vkf_line_set_dash_mode")

A line's dashes: screen 1 screen-locked (a constant length in pixels, following the line on screen), 0 anchored to the line (the default). Returns 0, or -1 if line isn't a line.

Arguments

Return Value integer(kind=c_int)

public function vkf_line_set_highlight(line, values) bind(C, name="vkf_line_set_highlight")

Set a line's highlight (shaders/line.vert) and upload it: values are its color (rgba), (flags: 1 pulse, 2 arrows; arrow spacing (window units), arrow speed (window units per second), band width (window units)), (pulse period (s), 0, 0, 0). Returns 0, or -1 if line isn't a line.

Arguments

Return Value integer(kind=c_int)

public function vkf_line_set_lod(line, center, radius, error, levels) bind(C, name="vkf_line_set_lod")

A line strip's level of detail: the bounding sphere of its points and error(k): how far the points skipped can be from the segments drawn at stride 2^k (k = 1 .. levels). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_line_set_range(line, first, n) bind(C, name="vkf_line_set_range")

Draw only points first .. first+n-1 (no data is uploaded): e.g. for trace mode. (Separate segments: first odd, n even.) Returns 0, or -1 on failure (out of range).

Arguments

Return Value integer(kind=c_int)

public function vkf_line_set_trail(line, values) bind(C, name="vkf_line_set_trail")

Set a line strip's trail (shaders/line.vert) and upload it: values are (the distance at the current time as a high/low pair, the direction (1, -1; 0: no trail), the color flags), (the past's cutoff and fade start, the future's fade start and cutoff: distances from the current time's), the past's color (rgba), the future's, (the past's dash pattern and factor, the future's). Returns 0, or -1 if line isn't a line strip.

Arguments

Return Value integer(kind=c_int)

public function vkf_line_style(line) bind(C, name="vkf_line_style")

A line's style buffer: 8 floats (r, g, b, a, width in window units, 1 for separate segments (pairs of points) or 0 for a strip, the dash pattern (16 bits; 65535 or 0: solid), window units per bit of it). Set the segment flag before drawing points. Null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_line_style_changed(line) bind(C, name="vkf_line_style_changed")

Upload a line's style again after writing it (vkf_line_style). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_marker_create(capacity, image, colored) bind(C, name="vkf_marker_create")

Markers at up to capacity points (initially none): a screen-space quad per point, of the shape and size in the style buffer (shaders/marker.vert); a node handle, or null on failure. The point and style buffers are those of a line (vkf_line_points, vkf_line_style, vkf_line_points_changed, vkf_line_set_range, vkf_line_style_changed); with colored (1), a color per marker (vkf_line_colors), times the style's.

Arguments

Return Value type(c_ptr)

public function vkf_mesh_array(mesh, which) bind(C, name="vkf_mesh_array")

One of the mesh's arrays, to fill in place; valid while the mesh handle exists.

Arguments

Return Value type(c_ptr)

public function vkf_mesh_create(n_vertices, n_indices, rgba, texture, night_texture, flags) bind(C, name="vkf_mesh_create")

Arguments

Return Value type(c_ptr)

public function vkf_mesh_material(mesh) bind(C, name="vkf_mesh_material")

The material of a lit mesh: 19 floats (vsg::PhongMaterial: ambient, diffuse, specular, emissive rgba, shininess, alpha mask, alpha mask cutoff); call vkf_mesh_material_changed after writing them. Null for a mesh without one.

Arguments

Return Value type(c_ptr)

public function vkf_mesh_material_changed(mesh) bind(C, name="vkf_mesh_material_changed")

Upload a mesh's material again after writing it (vkf_mesh_material). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_mesh_set_bound(mesh, x, y, z, radius) bind(C, name="vkf_mesh_set_bound")

A triangle mesh (a node handle), filled from Fortran (vkf_mesh_array, before the first frame); null on failure. A translucent mesh's bounding sphere (its coordinates), for depth sorting and culling. Returns 0, or -1 if it isn't a translucent mesh (vkf_mesh_create's flag 8).

Arguments

Return Value integer(kind=c_int)

public function vkf_mesh_set_twilight(mesh, angle) bind(C, name="vkf_mesh_set_twilight")

A lit mesh's twilight: its diffuse light extended to angle (radians) past the terminator, fading out (0: none). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_mesh_vertices_changed(mesh) bind(C, name="vkf_mesh_vertices_changed")

Upload a mesh's vertices again after rewriting them in place (a mesh created with flag 4). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_model_read(filename, filename_len) bind(C, name="vkf_model_read")

Read a model file (3ds, obj, gltf, ...): a node handle, or null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_node_add_child(parent, child) bind(C, name="vkf_node_add_child")

Add a child to a group node (a transform or a switch); while running, compile the child first (vkf_compile_node). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_node_bound(node, center, radius) bind(C, name="vkf_node_bound")

Bounding sphere of a node in its own coordinates. Returns 0, or -1 if the node is empty.

Arguments

Return Value integer(kind=c_int)

public subroutine vkf_node_delete(node) bind(C, name="vkf_node_delete")

Delete a node handle (a scene or parent that holds the node keeps it).

Arguments

public function vkf_node_remove_child(parent, child) bind(C, name="vkf_node_remove_child")

Remove a child from a group node (a transform or a switch), also while running: its GPU data are released a few frames later. Returns 0, or -1 if it is not a child.

Arguments

Return Value integer(kind=c_int)

public function vkf_ribbon_create(capacity, colored) bind(C, name="vkf_ribbon_create")

A ribbon of up to capacity points (even): a translucent surface through pairs of points, a quad between each pair and the next; a color per point (vkf_line_colors) if colored is not 0. The buffers are a line's. A node handle, or null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_rocky_add_elevation(map, kind, uri, uri_len, encoding) bind(C, name="vkf_rocky_add_elevation")

Add an elevation layer to a map. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_rocky_add_image(map, kind, uri, uri_len) bind(C, name="vkf_rocky_add_image")

Add an image layer to a map. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_rocky_available() bind(C, name="vkf_rocky_available")

1 if vkframes was built with Rocky, else 0.

Arguments

Return Value integer(kind=c_int)

public function vkf_rocky_elevation(uri, uri_len, profile, profile_len, lat, lon, ok) bind(C, name="vkf_rocky_elevation")

The height (meters) of the elevation data in a file (GDAL) at a latitude and longitude on the body of a Rocky profile, sampled directly (no map or window needed; files are kept open for later samples).

Arguments

Return Value real(kind=c_double)

public function vkf_rocky_map_alive(map) bind(C, name="vkf_rocky_map_alive")

1 while a map can be drawn (the viewer it was made for exists), else 0.

Arguments

Return Value integer(kind=c_int)

public function vkf_rocky_map_create(viewer, profile, profile_len, scale) bind(C, name="vkf_rocky_map_create")

A map for the viewer (a node handle: vkf_node_*); null without Rocky or on failure.

Arguments

Return Value type(c_ptr)

public function vkf_rocky_map_radius(map) bind(C, name="vkf_rocky_map_radius")

The equatorial radius of a map's body (meters); 0 without Rocky or on failure.

Arguments

Return Value real(kind=c_double)

public function vkf_rocky_map_settings(map, lighting, background) bind(C, name="vkf_rocky_map_settings")

A map's settings. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_sky_lines_create(capacity) bind(C, name="vkf_sky_lines_create")

Lines on the sky (up to capacity; initially none; e.g. constellations): segments between directions, of the color and width of the style's parameters (vkf_sky_style). A node handle, or null on failure. Fortran fills the buffer as the stars' (vkf_sky_stars: 8 floats per line, its first direction x, y, z, unused, then its second) and calls vkf_sky_stars_changed.

Arguments

Return Value type(c_ptr)

public function vkf_sky_stars(node, capacity) bind(C, name="vkf_sky_stars")

The stars' buffer, 8 floats per star (direction x, y, z, size in window units, then r, g, b, unused), to fill in place; null for a sky texture.

Arguments

Return Value type(c_ptr)

public function vkf_sky_stars_changed(node, n) bind(C, name="vkf_sky_stars_changed")

The first n stars were written: draw them, and upload the buffer. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_sky_style(node) bind(C, name="vkf_sky_style")

The sky's style buffer: 24 floats, the attitude (a column-major 4x4 matrix, sky frame to root frame), then 8 parameters (lines: width in window units, 3 unused, then the color r, g, b, a; unused by stars and the texture); call vkf_sky_style_changed after writing them. Null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_sky_style_changed(node) bind(C, name="vkf_sky_style_changed")

Upload a sky's style again after writing it (vkf_sky_style). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_sky_texture_create(image) bind(C, name="vkf_sky_texture_create")

The sky texture: an image (equirectangular, as a Sphere's texture) on the sky seen from inside; a node handle, or null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_sphere_lod_add(lod, mesh, segments) bind(C, name="vkf_sphere_lod_add")

Add a mesh of segments segments around the equator. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_sphere_lod_create(radius) bind(C, name="vkf_sphere_lod_create")

A sphere's level of detail for a body of radius (its largest semi-axis), centered on the node's origin: a node handle; meshes are added with vkf_sphere_lod_add.

Arguments

Return Value type(c_ptr)

public function vkf_sphere_lod_requested(lod) bind(C, name="vkf_sphere_lod_requested")

The most segments any view wanted since the last call (0 if not drawn).

Arguments

Return Value integer(kind=c_int)

public function vkf_stars_create(capacity) bind(C, name="vkf_stars_create")

Stars (up to capacity; initially none): a node handle, or null on failure. Fortran fills the buffer in place (vkf_sky_stars) and calls vkf_sky_stars_changed.

Arguments

Return Value type(c_ptr)

public function vkf_switch_create() bind(C, name="vkf_switch_create")

A switch node: a group whose children can be hidden and shown together; null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_switch_set(node, visible) bind(C, name="vkf_switch_set")

Show or hide all children of a switch. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_transform_create() bind(C, name="vkf_transform_create")

A transform node (a group whose children are placed by a 4x4 matrix), initially identity; null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_transform_set_matrix(transform, m) bind(C, name="vkf_transform_set_matrix")

Set a transform node's matrix. Returns 0, or -1 on failure (not a transform).

Arguments

Return Value integer(kind=c_int)

public function vkf_version(which, buf, buflen) bind(C, name="vkf_version")

A version string into buf (blank-padded): which = 1 VSG, 2 vsgXchange, 3 Dear ImGui, 4 the Vulkan headers vkframes was built with, 5 the Vulkan loader's instance version. Returns its length, or -1.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_add_node(viewer, node) bind(C, name="vkf_viewer_add_node")

Add a node to the viewer's scene, also while running (it is compiled first). The scene holds a reference: the node handle can be deleted afterwards. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_any() bind(C, name="vkf_viewer_any")

A viewer that exists (the oldest running one, else the oldest), or null.

Arguments

Return Value type(c_ptr)

public function vkf_viewer_capture(viewer, filename, filename_len) bind(C, name="vkf_viewer_capture")

Write the last presented frame to an image file (format from the extension, e.g. .png). Call after vkf_viewer_frame. Returns 0 on success.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_close(viewer) bind(C, name="vkf_viewer_close")

The host is closing the window: the next vkf_viewer_frame returns 0. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_create(width, height, title, title_len, native_window, pixel_ratio, vsync) bind(C, name="vkf_viewer_create")

A viewer with one window, an empty scene and a trackball camera; null on failure. With an existing window (native_window not 0) the host owns that window's events and forwards them (vkf_viewer_mouse, ..., vkf_viewer_resize).

Arguments

Return Value type(c_ptr)

public subroutine vkf_viewer_delete(viewer) bind(C, name="vkf_viewer_delete")

Delete a viewer (its window, GUI and default light; waits for the device to be idle first).

Arguments

public function vkf_viewer_device_info(viewer, which, buf, buflen) bind(C, name="vkf_viewer_device_info")

The viewer's Vulkan device into buf (blank-padded): which = 1 its name, 2 its type, 3 the Vulkan version it supports, 4 its driver's name, 5 its driver's information. Returns the length, or -1.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_events(viewer, events, capacity) bind(C, name="vkf_viewer_events")

The keyboard and mouse events since the last call, oldest first, up to capacity of them. Returns how many were copied (the rest are kept for the next call), or -1 on failure. Each event (a column of events): kind (1 key press, 2 key release, 3 pointer move, 4 button press, 5 button release), key (modified: 'V' with shift), key base, modifiers, button, buttons held (mask), x, y (framebuffer pixels from the top left), and the render area (offset x, y, width, height). Pointer events have key 1 while the mouse is grabbed (vkf_viewer_set_grab). Events taken by a GUI panel are not included.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_frame(viewer) bind(C, name="vkf_viewer_frame")

Render one frame (vkf_viewer_frame_begin, then vkf_viewer_frame_draw). Returns 1 while the viewer is running, 0 once its window has been closed, -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_frame_begin(viewer) bind(C, name="vkf_viewer_frame_begin")

The first part of a frame (compiling the scene on the first call): up to the window's events handled (the trackball has moved the camera), before the scene is drawn (vkf_viewer_frame_draw): a program can still change the scene for this frame in between. Returns 1 while the viewer is running, 0 once its window has been closed, -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_frame_draw(viewer) bind(C, name="vkf_viewer_frame_draw")

The rest of a frame begun by vkf_viewer_frame_begin: the scene's updates, drawn and presented. Returns 1, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_get_look_at(viewer, eye, center, up) bind(C, name="vkf_viewer_get_look_at")

The camera's eye, center and up vectors (view-frame coordinates), as the trackball left them. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_gui(viewer, font, font_len, size) bind(C, name="vkf_viewer_gui")

The viewer's GUI panels (vkf_gui.cpp), made on first use: a handle for the vkf_gui_* functions, valid while the viewer exists; null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_viewer_hud_add(viewer, label) bind(C, name="vkf_viewer_hud_add")

Show a label in the viewer's HUD, on top of the scene, also while running: the label's position is (x, y) from 0 to 1 across the viewport, bottom to top. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_hud_remove(viewer, label) bind(C, name="vkf_viewer_hud_remove")

Remove a label from the viewer's HUD (its GPU data are released a few frames later). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_key(viewer, pressed, symbol, modified_symbol, modifier) bind(C, name="vkf_viewer_key")

A key press or release from the host's window, as VSG key symbols and modifiers (vsg/ui/KeyEvent.h: ASCII for printable keys, X11-style codes otherwise). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_light(viewer) bind(C, name="vkf_viewer_light")

The viewer's default light (a vkf_light_create light in eye coordinates, owned by the viewer); null on failure.

Arguments

Return Value type(c_ptr)

public function vkf_viewer_light_enable(viewer, enabled) bind(C, name="vkf_viewer_light_enable")

Turn the viewer's default light on or off. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_look_at(viewer, eye, center, up) bind(C, name="vkf_viewer_look_at")

Set the camera's eye, center and up vectors (view-frame coordinates); stops the trackball's throw (the camera doesn't keep turning after it). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_mouse(viewer, kind, x, y, mask, button) bind(C, name="vkf_viewer_mouse")

A mouse event from the host's window. Returns 0, or -1 on failure (or an unknown kind).

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_orthographic(viewer, left, right, bottom, top, near_distance, far_distance) bind(C, name="vkf_viewer_orthographic")

Use an orthographic projection with the given view-volume bounds. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_perspective(viewer, fovy, near_distance, far_distance) bind(C, name="vkf_viewer_perspective")

Use a perspective projection. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_pixel_ratio(viewer) bind(C, name="vkf_viewer_pixel_ratio")

Framebuffer pixels per window unit (2 on Retina; a host's window's as given).

Arguments

Return Value real(kind=c_double)

public function vkf_viewer_record_frames(viewer) bind(C, name="vkf_viewer_record_frames")

Frames recorded so far, or -1 if not recording or recording failed.

Arguments

Return Value integer(kind=c_long_long)

public function vkf_viewer_record_start(viewer, ffmpeg, ffmpeg_len, output, output_len, fps) bind(C, name="vkf_viewer_record_start")

Start recording the frames drawn to a video of fps frames per second: piped as raw video to ffmpeg (the program), encoded with output (ffmpeg's output options, then the file, quoted). Returns 0, or -1 if already recording.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_record_stop(viewer) bind(C, name="vkf_viewer_record_stop")

Stop recording: the last frames written and ffmpeg's input closed (it finishes the file). Returns the frames written, or -1 if not recording or on failure.

Arguments

Return Value integer(kind=c_long_long)

public function vkf_viewer_remove_node(viewer, node) bind(C, name="vkf_viewer_remove_node")

Remove a node from the viewer's scene (its GPU data are released a few frames later). Returns 0, or -1 if it is not in the scene.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_resize(viewer, width, height) bind(C, name="vkf_viewer_resize")

The host resized its window: rebuild the swapchain. A window of no width or height (e.g. a collapsed splitter) is not drawn until it has a size again. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_scene_counts(viewer, counts) bind(C, name="vkf_viewer_scene_counts")

The size of the viewer's scene graph into counts: nodes, draw commands, vertices (traverses it all). Returns 0, or -1.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_scroll(viewer, dy) bind(C, name="vkf_viewer_scroll")

A scroll wheel event from the host's window. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_set_background(viewer, rgba) bind(C, name="vkf_viewer_set_background")

Set the background (clear) color. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_set_camera_controls(viewer, zoom_speed, throw) bind(C, name="vkf_viewer_set_camera_controls")

The trackball's sensitivity: zoom_speed scales each scroll step's zoom and a right drag's; throw (1) keeps the camera moving after a drag released while moving. Returns 0, or -1.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_set_grab(viewer, armed) bind(C, name="vkf_viewer_set_grab")

Whether a left button press takes the mouse from the trackball (armed 1: a handle is under the cursor), until the button is released: those events are given with key 1 (vkf_viewer_events). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_set_pixel_ratio(viewer, ratio) bind(C, name="vkf_viewer_set_pixel_ratio")

A host's window now has ratio framebuffer pixels per window unit. (Qt's devicePixelRatio changed: moved to a screen of another scale, or the display's scaling changed.) Sizes in window units (line widths, markers, labels) are scaled by it; the host also resizes (vkf_viewer_resize) to the new framebuffer size. Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_set_view_transform(viewer, m) bind(C, name="vkf_viewer_set_view_transform")

Set the transform from world (scene root) to view-frame coordinates, applied after the trackball's eye/center/up (see ViewLookAt). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_size(viewer, width, height) bind(C, name="vkf_viewer_size")

The swapchain's size (framebuffer pixels): a VSG window's size as it is resized (a host's window has the size it gives, vkf_viewer_resize). Returns 0, or -1 on failure.

Arguments

Return Value integer(kind=c_int)

public function vkf_viewer_stats(viewer, stats, n) bind(C, name="vkf_viewer_stats")

The viewer's last frame drawn, into stats(1:n) (n at most 9): frames drawn, milliseconds waiting for a swapchain image, recording and submitting, presenting, the GPU's time (-1: not measured), the framebuffer's width and height, the device memory in use and its budget (bytes; -1: unknown). Returns 0, or -1.

Arguments

Return Value integer(kind=c_int)

public function vkf_vulkan_device_name(buf, buflen) bind(C, name="vkf_vulkan_device_name")

Name of the first Vulkan physical device, into buf; returns its length, or -1 on failure. Needs no window, so it checks that the Vulkan loader finds a driver (MoltenVK on macOS).

Arguments

Return Value integer(kind=c_int)