Video Functions

Creation / Destruction

function	args	returns	description
[load_image]	path, order, desw, desh	vid	image loading
[load_image_asynch]	path, handler	vid	asynchronous image loading
[delete_image]	vid		removing / freeing resources
[pop_video_context]			mass- deallocation / cleanup
[push_video_context]			save/hide current pipeline
[random_surface]	desw, desh	vid	high-frequency (poor) noise
[fill_surface]	visw, vish, r, g, b storw, storh	vid	generate solid color texture
[render_text]	fmtstr, vspace, tspace	vid, linehtbl	render format string to image
[expire_image]	vid, time		timed cleanup call
[raw_surface]	vid, w, h, bpp, tbl	vid	convert a table of numeric values into a video object
[persist_image]	vid	irreversible transform allowing VID to survive push/pop operations

Measurements / Statistics

function	args	returns	description
[text_dimensions]	fmtstr, vspace, tspace	maxw, maxh	estimate [render_text] output
[image_storage_properties]	vid	proptbl	measure resource use
[image_surface_resolve_properties]	vid, time	proptbl	derive world- transform state
[image_surface_properties]	vid, time	proptbl	transform state in object space
[image_surface_initial_properties]	vid	proptbl	dimensions after load
[max_current_image_order]	vid	proptbl	finding topmost object
[current_context_usage]	vid	proptbl	measure VID namespace usage
[image_borderscan]	vid	x1,x2,y1,y2	find coordinates for border around transparent image center
[image_screen_coordinates]	vid	x, y, x2, y2	resolve coordinates and transform to screen space

Visibility

function	args	returns	description
[show_image]	vid		set visibility to 1.0
[hide_image]	vid		set visibility to 0.0
[blend_image]	vid, opa, time		set specific (0..1 range) opacity
[order_image]	vid, order		change draw order
[image_clip_on]	vid		toggle clipping for hierarchical objects
[image_clip_off]	vid		toggle clipping for hierarchical objects
[force_image_blend]	vid, blendmode		use alpha- channel in 1.0 visibility

Transformations

function	args	returns	description
[move_image]	vid, x, y, time		reposition
[rotate_image]	vid, deg, time		reorient
[scale_image]	vid, sfw, sfh, time		setting relative scale
[resize_image]	vid, wpx, hpx, time		setting absolute dimensions
[instant_image_transform]	vid		apply all queued transformations
[reset_image_transform]	vid		remove all queued transformations
[transfer_image_transform]	srcvid, dstvid		move transformation queue between VIDs
[copy_image_transform]	srcvid, dstvid		create a duplicate transformation queue
[image_origo_offset]	vid, xv, yv, zv		shift the rotation origo from center of the object to an arbitrary point (world-space)
[image_transform_cycle]	srcvid, 1 or 0		change how completed transformations are managed
[copy_surface_properties]	srcvid, dstvid	instantly copy current surface properties (position, dimensions etc.) to from src to dst

Texturing

function	args	returns	description
[image_set_txcos]	vid, tbl(8f)		override default 2D quad texture coordinates
[image_get_txcos]	vid	tbl(8f)	retrieve current 2D quad texture coordinates
[image_set_txcos_default]	vid, mirror	replace current 2D quad texture coordinates with the default (optionally flip y if mirror is set
[image_scale_txcos]	vid, f_s, f_t		apply a specific multiplier to current texture coordinates
[switch_default_scalemode]	mode_v, mode_h, vid		(global state) change image loading transformations
[switch_default_texmode]	mode		(global state) change image upload behavior
[switch_default_texfilter]	mode		(global state) change the active texture filtering mode
[switch_default_imageproc]	mode		(global state) change image postprocess transformations
[image_texfilter]	vid, mode		switch texfilter operation for a single VID

Hierarchy Management

function	args	returns	description
[instance_image]	vid	newvid	create a linked clone of an image
[link_image]	src, parent	bool	link coordinate and transformation spaces
[image_children]	vid	vidary	find all children associated with a VID
[image_parent]	vid	parent	find image parent

Framesets

function	args	returns	description
[image_framesetsize]	vid, ncells, mode		force increment the number of allowed frames
[image_framecyclemode]	vid, cyclerate		automatically switch between active frames
[set_image_as_frame]	contvid, framevid, slot, detach		link an image to a specific frameset
[image_active_frame]	contvid, slot		change the current active frame

Masking

function	args	returns	description
[image_mask_toggle]	vid, mask		invert a specific mask flag
[image_mask_set]	vid, mask		force-set a specific mask flag
[image_mask_clear]	vid, mask		force-clear a specific mask flag
[image_mask_clearall]	rvid		eset mask options to default

Miscellaneous

function	args	returns	description
[image_pushasynch]	vid		block until all asynch operations on the vid are completed
[valid_vid]	vid	bool	determine if a VID is valid or not
[define_rendertarget]	vid, vidary, detachopt, scaleopt		render a set of VIDs to an offscreen image
[define_recordtarget]	vid, dstres, fmtstr, vidary, aidary, detach, scale, pollrate		take a subset of AIDs / VIDs and record
[save_screenshot]	dstres		take a screenshot of the current display