📦 arcan

246 pages · page 1 of 2

A

accept_target(3)accept a pending target request for a new segment✨
add_3dmesh(3)Load/build a mesh and attach to a model.✨
alloc_surface(3)Create an empty, non-visible surface with a preset storage.✨
appl_arguments(3)Retrieve the (arguments) used with the appl- entrypoint✨
arcan(1)Scriptable Multimedia Engine✨
arcan-wayland(1)protocol bridge for Wayland support in Arcan✨
arcan_api_overview(3)Scripting Overview✨
arcan_db(1)Database Support tool for Arcan✨
arcantarget_hint(3)Send a hint state through a frameserver tied to an arcan instance✨
attrtag_model(3)Set 3d model rendering-specific flags✨
audio_buffer_size(3)Change the default audio buffering size✨
audio_gain(3)Retrieve and/or update the audio gain for a specific audio object.✨
audio_listener(3)Bind the current device listener to a positioner video object✨
audio_outputs(3)Returns a list of possible device names for audio_reconfigure✨
audio_position(3)Bind an audio source to a positioner video object✨
audio_reconfigure(3)Control audio device output parameters✨

B

benchmark_data(3)Retrieve gathered benchmarking values.✨
benchmark_enable(3)Toggle the gathering of benchmark data on / off.✨
benchmark_timestamp(3)Sample a timekeeping source.✨
benchmark_tracedata(3)Add a datapoint to the ongoing tracebuffer✨
blend_image(3)Change image opacity.✨
bond_target(3)Setup a state transfer pipe between two targets.✨
build_3dbox(3)Generate a 3D cube model✨
build_3dplane(3)Build a model comprised of a tesselated plane.✨
build_cylinder(3)Generate a full or half cylinder model✨
build_pointcloud(3)Create a 3D object that is comprised of a cloud of points.✨
build_shader(3)using✨
build_sphere(3)Generate a 3D sphere or hemisphere model✨

C

camtag_model(3)Define a camera for the 3D processing of a rendertarget✨
capture_audio(3)Setup an audio device capture stream✨
center_image(3)move a video object relative to an external reference object✨
close_rawresource(3)Close the context-global output file.✨
color_surface(3)Create a vobj with a single- color storage✨
controller_leds(3)Query or rescan for LED controllers✨
copy_image_transform(3)Duplicate the transform chain of one VID and transfer it to another.✨
copy_surface_properties(3)Copy key surface properties from one VID to another.✨
crop_image(3)Crop image to specific dimensions✨
current_context_usage(3)Return how many cells the current context has, and how many of those cells that are currently unused.✨
cursor_position(3)Retrieve the position of the mouse cursor.✨
cursor_setstorage(3)Use the storage defined by one video object as an accelerated mouse cursor.✨

D

decode_modifiers(3)Convert a modifier-bitmap to a textual representation.✨
define_arcantarget(3)Create a rendertarget bound subsegment for drawing to another arcan instance✨
define_calctarget(3)Create a rendertarget with a periodic readback into a Lua callback✨
define_feedtarget(3)Create a direct copy association between two frameservers.✨
define_linktarget(3)Create a linked offscreen rendering pipe✨
define_nulltarget(3)Push an output subsegment into a target frameserver✨
define_recordtarget(3)Create a rendertarget with a periodic readback✨
define_rendertarget(3)Create an offscreen rendering pipe✨
delete_audio(3)Remove the audio source✨
delete_image(3)Delete a video object and associated resources.✨
delete_shader(3)Deallocate the resources tied to a shid✨

E

expire_image(3)Schedule the image for deletion✨

F

fill_surface(3)Allocate a new video object and fill with a single colour.✨
finalize_3dmodel(3)Mark a 3D model as finalized✨
focus_target(3)Specify a frameserver the scheduler should try and bias✨
force_image_blend(3)Control image blend behaviour✨
forward3d_model(3)Push the model along its view vector.✨
frameserver_debugstall(3)change the global delay before a frameserver executes✨

G

get_key(3)Retrieve a key/value pair from the database.✨
get_keys(3)Retrieve all keys associated with a target or target/config✨
glob_resource(3)Search the different datastores for resources matching a pattern.✨

H

hide_image(3)Alias for show_image(vid, 0.0, *time)✨

I

image_access_storage(3)Access the underlying backing store of a textured video object.✨
image_active_frame(3)Set the active (displayed) frame for an object with an allocated frameset.✨
image_children(3)List the objects in a context that has the specified object as a direct parent✨
image_clip_off(3)Disable clipping for the specified object✨
image_clip_on(3)Control clipping for a video object.✨
image_color(3)Change color_surface and rendertarget clear-color✨
image_framecyclemode(3)Enable/Disable time-triggered active frameset frame cycling.✨
image_framesetsize(3)Allocate slots for multi-frame objects.✨
image_get_txcos(3)Get the active texture settings for the specified object.✨
image_hit(3)Test if the visible region of a specific object covers a specific point in screen space.✨
image_inherit_order(3)Changes the specific object order value to be expressed as relative to its parent.✨
image_loaded(3)Query the status of an asynchronous video object source.✨
image_mask_clear(3)Clear a status flag on the specified object✨
image_mask_clearall(3)Set the status of all user-modifiable flags to their off state.✨
image_mask_set(3)Set a status flag on the specified object✨
image_mask_toggle(3)Invert a status flag on the specified object✨
image_matchstorage(3)test if two vids share the same underlying storage✨
image_metadata(3)Set / update image contents metadata✨
image_mipmap(3)Forcetoggle image mipmap storage✨
image_origo_offset(3)Shift the current object rotation and anchoring offset✨
image_parent(3)Return a reference to the parent object.✨
image_pushasynch(3)Blocks on an asynchronous load operation until it has completed.✨
image_resize_storage(3)resize the dimensions of the image backing store✨
image_scale_txcos(3)Multiply the current set of texture coordinates uniformly✨
image_screen_coordinates(3)Lookup screen space coordinates for the specified object.✨
image_set_txcos(3)Override the default texture coordinates for an object.✨
image_set_txcos_default(3)Revert to the default set of texture mapping coordinates.✨
image_shader(3)Set the active shader for an object.✨
image_sharestorage(3)Setup two VIDs to use the same texture store.✨
image_state(3)Get a string representing the internal subtype of a video object.✨
image_storage_properties(3)Retrieve a table describing the current storage state for the specified object.✨
image_storage_slice(3)✨
image_surface_initial(3)Retrieve a table describing the initial storage state for the specified object.✨
image_surface_initial_properties(3)Retrieve a table describing the initial storage state for the specified object.✨
image_surface_properties(3)Retrieve the current properties of the specified object.✨
image_surface_resolve(3)Retrieve current image properties in world- space.✨
image_surface_resolve_properties(3)Retrieve current image properties in world-space.✨
image_tesselation(3)alter the tesselation level of a vid✨
image_texfilter(3)Switch object video filtering mode.✨
image_tracetag(3)Set or retrieve a tracing tag for the specified video object.✨
image_transform_cycle(3)Toggle transform cycles ON/OFF.✨
input_capabilities(3)query platform layer or target for input capabilities✨
input_remap_translation(3)Reset or modify platform level keyboard translation✨
input_samplebase(3)Change coordinate system origo for a device✨
input_target(3)Forwards the specified event table to a target frameserver.✨
inputanalog_filter(3)Change filtering / sampling options for a single analog input source.✨
inputanalog_query(3)Query analog devices for filtering details.✨
inputanalog_toggle(3)Switch all analog device processing on/off.✨
instant_image_transform(3)Immediately perform all pending transformations.✨

K

kbd_repeat(3)Change keyboard repeat period✨

L

launch_avfeed(3)Launch a customized frameserver✨
launch_decode(3)Launch a video decoding frameserver✨
launch_target(3)Setup and launch an external program.✨
led_intensity(3)Change the intensity of a specifid LED light.✨
link_image(3)Reassign the property-space to be relative another object✨
list_audio_inputs(3)Retrieve a list of available audio input devices.✨
list_namespaces(3)Get the current list of user defined namespaces✨
list_target_tags(3)retrieve a list of tags used by tagets✨
list_targets(3)List all available targets by their shortname.✨
load_asample(3)Preload an audio sample for later/repeated playback.✨
load_image(3)synchronously load supported images✨
load_image_asynch(3)asynchronously load an image from a resource✨

M

map_video_display(3)Specify virtual object to output mapping.✨
match_keys(3)Return target:value for keys that match the specified pattern✨
max_current_image_order(3)Find the highest ordervalue in use in the current context.✨
mesh_shader(3)Change the active shader for a submesh of a model✨
message_target(3)send a utf-8 coded text message to a frameserver✨
move3d_model(3)Set new world-space coordinates for the specified model.✨
move_cursor(3)Set an absolute position for the mouse cursor.✨
move_image(3)Set new world-space coordinates for the specified video object.✨

N

net_discover(3)Probe or monitor for compatible hosts or clients on the network✨
net_listen(3)Setup a network frameserver in listening mode✨
net_open(3)Make an outbound connection to a data source.✨
new_3dmodel(3)Allocate a VID and 3D Model container.✨
nudge_cursor(3)Move the mouse cursor relative to its current position.✨
nudge_image(3)Set new coordinates for the specified object based on current position.✨
null_surface(3)Create a minimalistic video object.✨

O

open_nonblock(3)Open a file in read or write mode for non-blocking I/O.✨
open_rawresource(3)Open a private or shared resource for reading/writing✨
order_image(3)Alter the drawing order of the specified image.✨
orient3d_model(3)Set the base orientation for the specified model.✨

P

pacify_target(3)Sever frameserver connection from a video object✨
persist_image(3)Flag the video object as video context persistant.✨
pick_items(3)Pick a number of objects based on a screen-space coordinate.✨
play_audio(3)Play an audio sample✨
pop_video_context(3)Deallocate the current video context.✨
push_video_context(3)Store the current video context and make it unreachable.✨

R

random_surface(3)Generate a pseudo-random image surface.✨
raw_surface(3)Create a new surface using a table as input.✨
read_rawresource(3)Read a line from the globally shared raw resource handle.✨
recordtarget_gain(3)Switch mixing weights and stereo panning for audio sources in a recordtarget.✨
relink_image(3)Reassign and translate the property-space to be relative another object✨
render_text(3)Convert a format string to a new video object.✨
rendertarget_attach(3)Modify the attachment statement of a video object✨
rendertarget_bind(3)Rebind the association between encode segment and rendertarget✨
rendertarget_detach(3)Remove any secondary specific-object attachments from a rendertarget✨
rendertarget_forceupdate(3)Manually perform an out-of-loop update of a rendertarget✨
rendertarget_id(3)Assign a numeric identifier to a rendertarget✨
rendertarget_metrics(3)Retrieve statistics about the state of a rendertarget pipeline✨
rendertarget_noclear(3)Enable / Disable clearing a rendertarget before a renderpass.✨
rendertarget_range(3)Limit the order- range of objects to render✨
rendertarget_reconfigure(3)Change the output density or processing flags of a rendertarget✨
rendertarget_vids(3)Get an indexed table of vids in a rendertarget✨
resample_image(3)scale an image to new dimensions using a shader✨
reset_image_transform(3)Drop all ongoing transformations.✨
reset_target(3)Request that a target resets to a known starting state.✨
resize_cursor(3)Set the drawing size of the mouse cursor.✨
resize_image(3)Change object dimensions based on absolute pixel values.✨
resize_video_canvas(3)Resize the virtual canvas drawing area✨
resource(3)Check if the requested resource path exists.✨
restore_target(3)Request that the target frameserver session restores from a previously made snapshot.✨
resume_target(3)Request that the targetid resumes from a previously paused state.✨
rotate3d_model(3)Set the current rotation for the specified model.✨
rotate_image(3)Rotate the image around its own center.✨

S

save_screenshot(3)Store a copy of the current display to a file.✨
scale3d_model(3)Apply or schedule a scale transform on a 3D model✨
scale_3dvertices(3)Statically scale the vertex values of the specified model.✨
scale_image(3)Set the current scale-factor for the specified image.✨
set_context_attachment(3)change the active attachment point for the current context✨
set_image_as_frame(3)Specify the contents of a multi-frame object.✨
set_led(3)Change the active state of a single LED.✨
set_led_rgb(3)Set the specific R,G,B values for an individual LED on a specific controller.✨
shader_ugroup(3)Allocate a uniform group inside a shader✨
shader_uniform(3)Set values for a uniform values in a specific shader.✨
show_image(3)Change image opacity to 1.0✨
shutdown(3)Queue a shutdown event.✨
snapshot_target(3)Request that a frameserver serializes its internal state into the specified resource.✨
step3d_model(3)Move forwards and sidewards✨
stepframe_target(3)Request that the target generate / consume a video frame.✨
store_key(3)Store one or several key-value pairs in the database.✨
storepop_video_context(3)Render the current video context to an object, then pop the context.✨
storepush_video_context(3)Render the current video context to an object, then push the context.✨
strafe3d_model(3)Move the specified model sideways in relation to its current viewing angle.✨
subsystem_reset(3)Reset/rebuild a specific subsystem✨
suspend_target(3)Request that the target suspend execution, awaiting a resume or terminate call.✨
switch_default_blendmode(3)Change the blend operation set as default on all new objects.✨
switch_default_imageproc(3)Set the default image post-processing mode.✨
switch_default_scalemode(3)Change the default scale-mode for newly loaded images.✨