MayaFlux Namespace Reference

Main namespace for the Maya Flux audio engine. More...

Namespaces
namespace	Buffers
namespace	Config
	Globlal configuration for MayaFlux.
namespace	Core
namespace	Host
namespace	internal
namespace	IO
namespace	Journal
namespace	Kakshya
namespace	Kinesis
namespace	Kriya
namespace	Memory
namespace	Nexus
namespace	Nodes
	Contains the node-based computational processing system components.
namespace	Parallel
namespace	Platform
namespace	Portal
namespace	Reflect
namespace	Registry
namespace	ShaderCompat
namespace	Transitive
namespace	Vruta
namespace	Yantra

Classes
struct	CreationContext
class	Creator
struct	DomainSpec
	Thin domain wrapper that adds subscript channel-binding syntax. More...
class	Evolve
	Sets a system going from a config: state that persists, a rule that advances it every cycle, and rendering attached. More...
class	MeshGroupHandle
class	Mint
	Turns a structural config into a registered and rendered object. More...
struct	StructureConfig
	API-side playground for a complete visible structure. More...

Concepts
concept	GridCellData
	Cell types a relaxation grid can be seeded with from a host callable.

Typedefs
using	ViewportPresetConfig = Kinesis::NavigationConfig
	Alias for backwards compatibility; prefer Kinesis::NavigationConfig in new code.

Enumerations
enum	Domain : uint64_t {   AUDIO = (static_cast<uint64_t>(Nodes::ProcessingToken::AUDIO_RATE) << 32) | (static_cast<uint64_t>(Buffers::ProcessingToken::AUDIO_BACKEND) << 16) | (static_cast<uint64_t>(Vruta::ProcessingToken::SAMPLE_ACCURATE)) , AUDIO_PARALLEL = (static_cast<uint64_t>(Nodes::ProcessingToken::AUDIO_RATE) << 32) | (static_cast<uint64_t>(Buffers::ProcessingToken::AUDIO_PARALLEL) << 16) | (static_cast<uint64_t>(Vruta::ProcessingToken::SAMPLE_ACCURATE)) , GRAPHICS = (static_cast<uint64_t>(Nodes::ProcessingToken::VISUAL_RATE) << 32) | (static_cast<uint64_t>(Buffers::ProcessingToken::GRAPHICS_BACKEND) << 16) | (static_cast<uint64_t>(Vruta::ProcessingToken::FRAME_ACCURATE)) , GRAPHICS_ADAPTIVE = (static_cast<uint64_t>(Nodes::ProcessingToken::VISUAL_RATE) << 32) | (static_cast<uint64_t>(Buffers::ProcessingToken::GRAPHICS_BACKEND) << 16) | (static_cast<uint64_t>(Vruta::ProcessingToken::MULTI_RATE)) ,   CUSTOM_ON_DEMAND = (static_cast<uint64_t>(Nodes::ProcessingToken::CUSTOM_RATE) << 32) | (static_cast<uint64_t>(Buffers::ProcessingToken::SAMPLE_RATE | Buffers::ProcessingToken::CPU_PROCESS | Buffers::ProcessingToken::SEQUENTIAL) << 16) | (static_cast<uint64_t>(Vruta::ProcessingToken::ON_DEMAND)) , CUSTOM_FLEXIBLE = (static_cast<uint64_t>(Nodes::ProcessingToken::CUSTOM_RATE) << 32) | (static_cast<uint64_t>(Buffers::ProcessingToken::FRAME_RATE | Buffers::ProcessingToken::GPU_PROCESS | Buffers::ProcessingToken::PARALLEL) << 16) | (static_cast<uint64_t>(Vruta::ProcessingToken::CUSTOM)) , AUDIO_VISUAL_SYNC = (static_cast<uint64_t>(Nodes::ProcessingToken::AUDIO_RATE) << 32) | (static_cast<uint64_t>(Buffers::ProcessingToken::SAMPLE_RATE | Buffers::ProcessingToken::CPU_PROCESS | Buffers::ProcessingToken::SEQUENTIAL) << 16) | (static_cast<uint64_t>(Vruta::ProcessingToken::FRAME_ACCURATE)) , AUDIO_GPU = (static_cast<uint64_t>(Nodes::ProcessingToken::AUDIO_RATE) << 32) | (static_cast<uint64_t>(Buffers::ProcessingToken::SAMPLE_RATE | Buffers::ProcessingToken::GPU_PROCESS | Buffers::ProcessingToken::PARALLEL) << 16) | (static_cast<uint64_t>(Vruta::ProcessingToken::MULTI_RATE)) ,   WINDOWING , INPUT_EVENTS }
	Unified domain enum combining all three ProcessingToken subsystems. More...
enum class	ViewportPresetMode : uint8_t { Fly , Orbit , PanZoom2D , Screenspace }
	Selects which navigation controller bind_viewport_preset installs. More...

Functions
void	add_processor (const std::shared_ptr< Buffers::BufferProcessor > &processor, Buffers::ProcessingToken token, uint32_t channel)
	Adds a processor to all buffers in a specific channel.
void	add_processor (const std::shared_ptr< Buffers::BufferProcessor > &processor, Buffers::ProcessingToken token=Buffers::ProcessingToken::AUDIO_BACKEND)
	Adds a processor to all buffers in a processing domain.
void	add_processor (const std::shared_ptr< Buffers::BufferProcessor > &processor, const std::shared_ptr< Buffers::Buffer > &buffer, Buffers::ProcessingToken token=Buffers::ProcessingToken::AUDIO_BACKEND)
	Adds a processor to a specific buffer.
float	aspect_ratio (const std::shared_ptr< Core::Window > &window)
	Get window aspect ratio from window state.
float	aspect_ratio (uint32_t window_width, uint32_t window_height)
	Get window aspect ratio (width/height)
template<typename F >
std::shared_ptr< Buffers::BufferProcessor >	attach_quick_process (F &&processor, const std::shared_ptr< Buffers::AudioBuffer > &buffer)
template<typename F >
std::shared_ptr< Buffers::BufferProcessor >	attach_quick_process (F &&processor, const std::shared_ptr< Buffers::VKBuffer > &buffer)
template<typename F >
std::shared_ptr< Buffers::BufferProcessor >	attach_quick_process (F &&processor, std::initializer_list< unsigned int > channels={ 0 })
	Attaches a processing function to one or more channels.
void	Await ()
	Blocks launcher until Ctrl-C is pressed (optional convenience function)
void	bind_fly_preset (const std::shared_ptr< Core::Window > &window, const std::shared_ptr< Buffers::RenderProcessor > &processor, const ViewportPresetConfig &config={}, const Kinesis::FlyKeyMap &key_map={}, const std::string &name="default")
	Bind the fly navigation controller to a window and render processor.
void	bind_fly_preset (const std::shared_ptr< Core::Window > &window, const ViewportPresetConfig &config={}, const Kinesis::FlyKeyMap &key_map={}, const std::string &name="default")
	Bind the fly navigation controller to all RenderProcessors currently registered against a window.
Core::InputBinding	bind_hid (uint16_t vid, uint16_t pid)
	Create binding for HID device by vendor/product ID.
Core::InputBinding	bind_hid (uint32_t device_id=0)
	Create binding for HID device.
Core::InputBinding	bind_midi (uint32_t device_id=0, std::optional< uint8_t > channel={})
	Create binding for MIDI device.
Core::InputBinding	bind_midi_cc (std::optional< uint8_t > cc_number={}, std::optional< uint8_t > channel={}, uint32_t device_id=0)
	Create binding for MIDI Control Change messages.
Core::InputBinding	bind_midi_note_off (std::optional< uint8_t > channel={}, uint32_t device_id=0)
	Create binding for MIDI Note Off messages.
Core::InputBinding	bind_midi_note_on (std::optional< uint8_t > channel={}, uint32_t device_id=0)
	Create binding for MIDI Note On messages.
Core::InputBinding	bind_midi_pitch_bend (std::optional< uint8_t > channel={}, uint32_t device_id=0)
	Create binding for MIDI Pitch Bend messages.
void	bind_orbit_preset (const std::shared_ptr< Core::Window > &window, const Kinesis::OrbitConfig &config={}, const Kinesis::OrbitKeyMap &key_map={}, const std::string &name="default")
	Bind the orbit navigation controller to all RenderProcessors currently registered against a window.
void	bind_orbit_preset (const std::shared_ptr< Core::Window > &window, const std::shared_ptr< Buffers::RenderProcessor > &processor, const Kinesis::OrbitConfig &config={}, const Kinesis::OrbitKeyMap &key_map={}, const std::string &name="default")
	Bind the orbit navigation controller to a window and render processor.
Core::InputBinding	bind_osc (const std::string &pattern="")
	Create binding for OSC messages.
void	bind_pan_zoom_preset (const std::shared_ptr< Core::Window > &window, const Kinesis::PanZoom2DConfig &config={}, const Kinesis::PanZoom2DKeyMap &key_map={}, const std::string &name="default")
	Bind the 2D pan/zoom controller to all RenderProcessors currently registered against a window.
void	bind_pan_zoom_preset (const std::shared_ptr< Core::Window > &window, const std::shared_ptr< Buffers::RenderProcessor > &processor, const Kinesis::PanZoom2DConfig &config={}, const Kinesis::PanZoom2DKeyMap &key_map={}, const std::string &name="default")
	Bind the 2D pan/zoom controller to a window and render processor.
void	bind_screenspace_preset (const std::shared_ptr< Core::Window > &window, const Kinesis::NavigationConfig &config={}, const Kinesis::ScreenspaceKeyMap &key_map={}, const std::string &name="default")
	Bind the screenspace navigation controller to all RenderProcessors currently registered against a window.
void	bind_screenspace_preset (const std::shared_ptr< Core::Window > &window, const std::shared_ptr< Buffers::RenderProcessor > &processor, const Kinesis::NavigationConfig &config={}, const Kinesis::ScreenspaceKeyMap &key_map={}, const std::string &name="default")
	Bind the screenspace navigation controller to a window and render processor.
Core::InputBinding	bind_serial (uint32_t device_id=0)
	Create binding for Serial device.
Core::InputBinding	bind_tablet (uint32_t device_id=0)
	Create binding for a tablet tool.
void	bind_viewport_preset (const std::shared_ptr< Core::Window > &window, const std::shared_ptr< Buffers::RenderProcessor > &processor, ViewportPresetMode mode=ViewportPresetMode::Fly, const std::string &name="default")
	Bind a navigation preset to a window and render processor using default settings.
void	bind_viewport_preset (const std::shared_ptr< Core::Window > &window, ViewportPresetMode mode=ViewportPresetMode::Fly, const std::string &name="default")
	Bind a navigation preset to all RenderProcessors currently registered against a window using default settings.
bool	cancel_event_handler (const std::string &name)
	Cancel an event handler by name.
bool	cancel_task (const std::string &name)
	Cancels a scheduled task.
std::shared_ptr< Kakshya::SoundFileContainer >	choose_audio ()
	Present a native open-file dialog filtered to audio formats and load the chosen file via IOManager::load_audio().
std::shared_ptr< Kakshya::DynamicSoundStream >	choose_audio_bounded (uint64_t max_frames=0, bool truncate=false)
	Present a native open-file dialog filtered to audio formats and load the chosen file via IOManager::load_audio_bounded().
std::shared_ptr< Kakshya::CameraContainer >	choose_camera (bool choose_mode=true)
	Let the user pick a camera, and optionally a capture mode, then open it via IOManager::open_camera().
std::shared_ptr< Kakshya::CompositeContainer >	choose_composite ()
	Choose a CSV or TSV file and load it as a CompositeContainer.
std::shared_ptr< Kakshya::CompositeContainer >	choose_composite (const Kakshya::CompositeLayout &layout, size_t batch_size=1)
	Choose a CSV or TSV file and load it with an exact field layout.
std::shared_ptr< Buffers::TextureBuffer >	choose_image (int desired_channels=4, std::optional< Kakshya::Region > region=std::nullopt)
	Present a native open-file dialog filtered to image formats and load the chosen file via IOManager::load_image().
std::vector< std::shared_ptr< Buffers::MeshBuffer > >	choose_mesh ()
	Present a native open-file dialog filtered to 3D model formats and load the chosen file via IOManager::load_mesh().
std::shared_ptr< Nodes::Network::MeshNetwork >	choose_mesh_network (IO::TextureResolver resolver=nullptr)
	Present a native open-file dialog filtered to 3D model formats and load the chosen file as a MeshNetwork via IOManager::load_mesh_network().
IO::VideoLoadResult	choose_video (const IO::VideoLoadConfig &config)
	Present a native open-file dialog filtered to video formats and load the chosen file via IOManager::load_video(path, config).
std::shared_ptr< Buffers::VolumeGridBuffer >	choose_volume ()
	Present a native open-file dialog filtered to volume formats and load the chosen file via IOManager::load_volume().
std::vector< std::shared_ptr< Buffers::AudioBuffer > >	clone_buffer_to_channels (const std::shared_ptr< Buffers::AudioBuffer > &buffer, const std::vector< uint32_t > &channels)
	Clones a buffer to multiple channels.
std::vector< std::shared_ptr< Buffers::AudioBuffer > >	clone_buffer_to_channels (const std::shared_ptr< Buffers::AudioBuffer > &buffer, const std::vector< uint32_t > &channels, const Buffers::ProcessingToken &token)
Domain	compose_domain (Nodes::ProcessingToken node_token, Buffers::ProcessingToken buffer_token, Vruta::ProcessingToken task_token)
	Composes individual ProcessingTokens into a unified Domain.
void	connect_node_to_buffer (const std::shared_ptr< Nodes::Node > &node, const std::shared_ptr< Buffers::AudioBuffer > &buffer, float mix=0.5F, bool clear_before=true)
	Connects a node to a specific buffer.
void	connect_node_to_channel (const std::shared_ptr< Nodes::Node > &node, uint32_t channel_index=0, float mix=0.5F, bool clear_before=false)
	Connects a node to a specific output channel.
template<typename BufferType , typename... Args> requires std::derived_from<BufferType, Buffers::VKBuffer>
auto	create_buffer (Args &&... args) -> std::shared_ptr< BufferType >
	creates a new graphics buffer of the specified type and registers it
template<typename BufferType , typename... Args> requires std::derived_from<BufferType, Buffers::AudioBuffer>
auto	create_buffer (uint32_t channel, uint32_t buffer_size, Args &&... args) -> std::shared_ptr< BufferType >
	creates a new buffer of the specified type and registers it
std::shared_ptr< Kriya::BufferPipeline >	create_buffer_pipeline ()
	Creates a new buffer pipeline instance.
std::shared_ptr< Kriya::BufferPipeline >	create_buffer_pipeline (std::shared_ptr< IO::IOManager > io_manager)
	Creates a buffer pipeline that can reach an IOManager.
Kriya::ChimeraBuilder	create_chimera (const Kakshya::VideoStreamSpec &spec, Portal::Graphics::RenderConfig render, std::optional< Portal::Graphics::FitMode > fit=Portal::Graphics::FitMode::STRETCH)
	Begin a Chimera over an array buffer made and drawn here.
Kriya::ChimeraBuilder	create_chimera (std::shared_ptr< Buffers::TextureArrayBuffer > buffer)
	Begin assembling the layers of a TextureArrayBuffer from what feeds each.
template<typename ContainerType , typename... Args> requires std::derived_from<ContainerType, Kakshya::SignalSourceContainer>
auto	create_container (Args &&... args) -> std::shared_ptr< ContainerType >
	creates a new container of the specified type
Domain	create_custom_domain (Nodes::ProcessingToken node_token, Buffers::ProcessingToken buffer_token, Vruta::ProcessingToken task_token)
	Creates a custom domain from individual tokens with validation.
std::shared_ptr< Buffers::AudioBuffer >	create_input_listener_buffer (uint32_t channel=0, bool add_to_output=false)
	Creates a new AudioBuffer for input listening.
template<typename NodeType , typename... Args> requires std::derived_from<NodeType, Nodes::Node>
auto	create_node (Args &&... args) -> std::shared_ptr< NodeType >
template<typename NodeNetworkType , typename... Args> requires std::derived_from<NodeNetworkType, Nodes::Network::NodeNetwork>
auto	create_node_network (Args &&... args) -> std::shared_ptr< NodeNetworkType >
	Creates a new node network.
std::shared_ptr< Buffers::BufferProcessingChain >	create_processing_chain ()
	Creates a new processing chain for the default engine.
template<typename ProcessorType , typename... Args> requires std::derived_from<ProcessorType, Buffers::BufferProcessor>
auto	create_processor (const std::shared_ptr< Buffers::AudioBuffer > buffer, Args &&... args) -> std::shared_ptr< ProcessorType >
	Creates a new processor and adds it to a buffer.
template<typename ProcessorType , typename... Args> requires std::derived_from<ProcessorType, Buffers::BufferProcessor>
auto	create_processor (const std::shared_ptr< Buffers::VKBuffer > buffer, Args &&... args) -> std::shared_ptr< ProcessorType >
std::shared_ptr< Kakshya::DynamicSoundStream >	create_ring (double seconds, uint32_t channels=1)
	Make a circular stream that keeps the most recent seconds of a signal.
std::shared_ptr< Kriya::SamplingPipeline >	create_sampler (const std::string &filepath, uint32_t num_samples=48000 *5, bool truncate=true, uint32_t channel=0, uint64_t max_dur_ms=0)
	Construct a built SamplingPipeline from an audio file.
std::shared_ptr< Kriya::SamplingPipeline >	create_sampler (uint32_t num_samples=48000 *5, bool truncate=true, uint32_t channel=0, uint64_t max_dur_ms=0)
	Construct a built SamplingPipeline from a file picked in a dialog.
std::shared_ptr< Kriya::SamplingPipeline >	create_sampler_from_stream (std::shared_ptr< Kakshya::DynamicSoundStream > stream, uint32_t channel=0, uint64_t max_dur_ms=0)
	Construct a built SamplingPipeline from an existing DynamicSoundStream.
std::vector< std::shared_ptr< Kriya::SamplingPipeline > >	create_samplers (const std::string &filepath, uint32_t num_samples=48000 *5, bool truncate=true, uint64_t max_dur_ms=0, uint32_t max_channels=0)
	Construct one built SamplingPipeline per channel from an audio file.
std::vector< std::shared_ptr< Kriya::SamplingPipeline > >	create_samplers (uint32_t num_samples=48000 *5, bool truncate=true, uint64_t max_dur_ms=0, uint32_t max_channels=0)
	Construct one built SamplingPipeline per channel from a file picked in a dialog.
Kriya::TapSetBuilder	create_tap_set (const std::string &filepath, uint32_t num_samples=48000 *5, bool truncate=true)
	Begin describing several taps that read one audio file.
Kriya::TapSetBuilder	create_tap_set (uint32_t num_samples=48000 *5, bool truncate=true)
	Begin describing several taps that read a file picked in a dialog.
Kriya::TapSetBuilder	create_tap_set_from_stream (std::shared_ptr< Kakshya::DynamicSoundStream > stream)
	Begin describing several taps that read an existing DynamicSoundStream.
std::shared_ptr< Buffers::TextureArrayBuffer >	create_texture_array (const Kakshya::VideoStreamSpec &spec, const Portal::Graphics::RenderConfig &render, std::optional< Portal::Graphics::FitMode > fit=Portal::Graphics::FitMode::STRETCH, uint32_t mode=0)
	Make a layered texture buffer that draws to a window.
std::shared_ptr< Yantra::Vision::VisionWorkflow >	create_vision_workflow ()
	A vision workflow running on the engine's managers.
std::shared_ptr< Core::Window >	create_window (const Core::WindowCreateInfo &create_info)
	Create a new window with specified parameters.
Core::SubsystemTokens	decompose_domain (Domain domain)
	Decomposes a Domain enum into its constituent ProcessingTokens.
void	detach_from_audio_input (const std::shared_ptr< Buffers::AudioBuffer > &buffer, uint32_t channel=0)
	Stops reading audio data from the default input source.
std::string	domain_to_string (Domain domain)
	Gets a human-readable string representation of a domain.
void	End ()
	Stops and cleans up the default engine.
template<typename T >
bool	expose_live (const char *key, const std::shared_ptr< T > &obj) noexcept
	Exposes an existing shared_ptr-managed object to the live arena under key.
template<typename T >
bool	expose_live (const char *key, T *ptr) noexcept
	Exposes an existing raw pointer to the live arena under key.
template<typename T >
bool	expose_live_indexed (std::string_view prefix, const std::shared_ptr< T > &obj) noexcept
	Exposes obj under the first free key of the form "prefix_N".
std::optional< Core::InputDeviceInfo >	find_hid_device (uint16_t vendor_id, uint16_t product_id)
	Find a HID device by vendor and product ID.
std::vector< Core::InputDeviceInfo >	get_all_input_devices ()
	Get a list of connected MIDI devices.
std::shared_ptr< Buffers::VideoContainerBuffer >	get_associated_buffer (const std::shared_ptr< Kakshya::VideoStreamContainer > &container)
	The buffer a video or camera container was hooked to.
std::vector< std::shared_ptr< Buffers::SoundContainerBuffer > >	get_associated_buffers (const std::shared_ptr< Kakshya::SoundFileContainer > &container)
	The per-channel buffers an audio container was hooked to.
std::vector< std::shared_ptr< Buffers::SoundContainerBuffer > >	get_associated_buffers (const std::shared_ptr< Kakshya::VideoFileContainer > &container)
	The audio buffers of a video file's extracted sound track.
Nodes::RootNode &	get_audio_channel_root (uint32_t channel=0)
	Gets the root node for a specific channel.
double	get_brownian_motion (double start, double end)
	Generates a Brownian motion value.
std::shared_ptr< Buffers::BufferManager >	get_buffer_manager ()
	Gets the buffer manager from the default engine.
MAYAFLUX_API Buffers::ProcessingToken	get_buffer_token (Domain domain)
	Extracts buffer processing token from domain.
Core::Engine &	get_context ()
	Gets the default engine instance.
std::shared_ptr< Vruta::EventManager >	get_event_manager ()
	Gets the event manager from the default engine.
double	get_exponential_random (double start=0, double end=1)
	Generates an exponential random number.
double	get_gaussian_random (double start=0, double end=1)
	Generates a gaussian (normal) random number.
std::vector< Core::InputDeviceInfo >	get_hid_devices ()
	Get a list of connected HID devices.
Core::InputManager &	get_input_manager ()
	Gets a handle to default input manager.
const Core::InputSubsystem &	get_input_subsystem ()
	Gets the input subsystem.
std::shared_ptr< IO::IOManager >	get_io_manager ()
	Retrieves the global IOManager instance for file loading and buffer management.
float *	get_line_value (const std::string &name)
	Gets a pointer to a task's current value.
std::vector< Core::InputDeviceInfo >	get_midi_devices ()
	Get a list of connected MIDI devices.
std::shared_ptr< Nodes::NodeGraphManager >	get_node_graph_manager ()
	Gets the node graph manager from the default engine.
MAYAFLUX_API Nodes::ProcessingToken	get_node_token (Domain domain)
	Extracts node processing token from domain.
double	get_poisson_random (double start=0, double end=1)
	Generates a poisson random number.
Kinesis::Stochastic::Stochastic &	get_random_engine ()
	Get reference to the default random engine.
Buffers::RootAudioBuffer &	get_root_audio_buffer (uint32_t channel)
	Gets the audio buffer for a specific channel.
std::shared_ptr< Vruta::TaskScheduler >	get_scheduler ()
	Gets the task scheduler from the default engine.
std::vector< Core::InputDeviceInfo >	get_tablet_devices ()
	Get a list of connected tablet tools.
MAYAFLUX_API Vruta::ProcessingToken	get_task_token (Domain domain)
	Extracts task processing token from domain.
double	get_uniform_random (double start=0, double end=1)
	Generates a uniform random number.
Core::WindowManager &	get_window_manager ()
	Gets a handle to default window manager.
void	Init ()
	Initializes the default engine with default settings.
void	Init (Core::GlobalStreamInfo stream_info, Core::GlobalGraphicsConfig graphics_config, Core::GlobalInputConfig input_config, Core::GlobalNetworkConfig network_config)
	Initializes the default engine with specified stream and graphics info.
void	Init (uint32_t sample_rate, uint32_t buffer_size=512, uint32_t num_out_channels=2, uint32_t num_in_channels=0)
	Initializes the default engine with specified parameters.
bool	is_audio (const fs::path &filepath)
MAYAFLUX_API bool	is_audio (const std::filesystem::path &filepath)
	Checks if the given file is an audio file based on its extension.
bool	is_composite (const fs::path &filepath)
MAYAFLUX_API bool	is_composite (const std::filesystem::path &filepath)
	Check whether an existing file has a supported Composite format.
bool	is_configured ()
	Checks if the default engine has currently accepted all configurations and initialized all managers.
bool	is_domain_valid (Domain domain)
	Checks if a domain is valid (all constituent tokens are compatible)
bool	is_engine_configured ()
	Checks if the default engine has currently accepted all configurations and initialized all managers.
bool	is_image (const fs::path &filepath)
MAYAFLUX_API bool	is_image (const std::filesystem::path &filepath)
	Checks if the given file is an image file based on its extension.
bool	is_in_bounds (double window_x, double window_y, const std::shared_ptr< Core::Window > &window)
	Check if a point in window coordinates is inside the window bounds.
bool	is_in_bounds (double window_x, double window_y, uint32_t window_width, uint32_t window_height)
	Check if a point in window coordinates is inside the window bounds.
bool	is_initialized ()
	Checks if the default engine has been initialized.
MAYAFLUX_API void	live_arena_dump () noexcept
	Dumps all live arena entries to stderr.
template<typename T >
std::shared_ptr< T >	live_cast (const char *key) noexcept
	Retrieves a live-arena object by key as a shared_ptr<T>.
MAYAFLUX_API void *	live_cast_impl (const char *key) noexcept
	Internal implementation for live_cast.
template<typename T , typename... Args>
std::shared_ptr< T >	make_live (const char *key, Args &&... args)
	Constructs a T in-place inside the live arena and registers it under key.
template<typename T , typename... Args>
T &	make_persistent (Args &&... args)
	Construct a T in place, retain it for process lifetime, and return a direct reference.
template<typename T >
std::decay_t< T > &	make_persistent (T &&val)
	Store a value in the persistent store and return a reference to it.
template<typename T , typename... Args>
std::shared_ptr< T >	make_persistent_shared (Args &&... args)
	Construct a T in place, retain it for process lifetime, and return a shared handle.
glm::vec3	normalize_coords (double window_x, double window_y, const std::shared_ptr< Core::Window > &window)
	Convert window pixel coordinates to NDC using window state.
glm::vec3	normalize_coords (double window_x, double window_y, uint32_t window_width, uint32_t window_height)
	Convert window pixel coordinates to normalized device coordinates (NDC)
glm::vec3	normalize_coords_aspect (double window_x, double window_y, const std::shared_ptr< Core::Window > &window)
	Normalize coordinates preserving aspect ratio using window state.
glm::vec3	normalize_coords_aspect (double window_x, double window_y, uint32_t window_width, uint32_t window_height)
	Normalize coordinates preserving aspect ratio (useful for circular/square shapes)
glm::uvec2	normalized_size_to_pixels (const glm::vec2 &ndc_size, const std::shared_ptr< Core::Window > &window)
	Convert an NDC-space size to integer pixel dimensions using window state.
glm::uvec2	normalized_size_to_pixels (const glm::vec2 &ndc_size, uint32_t window_width, uint32_t window_height)
	Convert an NDC-space size (extent) to integer pixel dimensions.
glm::uvec2	normalized_size_to_pixels (const Kinesis::AABB2D &region, const std::shared_ptr< Core::Window > &window)
	Convert an NDC AABB's extent to integer pixel dimensions using window state.
glm::uvec2	normalized_size_to_pixels (const Kinesis::AABB2D &region, uint32_t window_width, uint32_t window_height)
	Convert an NDC AABB's extent to integer pixel dimensions.
void	on_any_key (const std::shared_ptr< Core::Window > &window, std::function< void(IO::Keys)> callback, std::string name="")
	Schedule a handler for any key press.
void	on_key_pressed (const std::shared_ptr< Core::Window > &window, IO::Keys key, std::function< void()> callback, std::string name="")
	Schedule a key press handler.
void	on_key_released (const std::shared_ptr< Core::Window > &window, IO::Keys key, std::function< void()> callback, std::string name="")
	Schedule a key release handler.
void	on_mouse_drag (const std::shared_ptr< Core::Window > &window, IO::MouseButtons button, std::function< void(double, double)> callback, std::string name="")
	Schedule a mouse drag handler.
void	on_mouse_move (const std::shared_ptr< Core::Window > &window, std::function< void(double, double)> callback, std::string name="")
	Schedule a mouse movement handler.
void	on_mouse_pressed (const std::shared_ptr< Core::Window > &window, IO::MouseButtons button, std::function< void(double, double)> callback, std::string name="")
	Schedule a mouse button press handler.
void	on_mouse_released (const std::shared_ptr< Core::Window > &window, IO::MouseButtons button, std::function< void(double, double)> callback, std::string name="")
	Schedule a mouse button release handler.
std::shared_ptr< Vruta::NetworkSource >	on_network_message (const Core::EndpointInfo &info, std::function< void(const Core::NetworkMessage &)> callback, std::string name="")
	Schedule an on_message handler, constructing the NetworkSource from config.
void	on_network_message (std::shared_ptr< Vruta::NetworkSource > source, std::function< void(const Core::NetworkMessage &)> callback, std::string name="")
	Schedule an on_message handler with an existing NetworkSource.
std::shared_ptr< Vruta::NetworkSource >	on_network_message_from (const Core::EndpointInfo &info, std::string sender_address, std::function< void(const Core::NetworkMessage &)> callback, std::string name="")
	Schedule an on_message_from handler, constructing the NetworkSource from config.
void	on_network_message_from (std::shared_ptr< Vruta::NetworkSource > source, std::string sender_address, std::function< void(const Core::NetworkMessage &)> callback, std::string name="")
	Schedule an on_message_from handler with an existing NetworkSource.
std::shared_ptr< Vruta::NetworkSource >	on_network_message_matching (const Core::EndpointInfo &info, std::function< bool(const Core::NetworkMessage &)> predicate, std::function< void(const Core::NetworkMessage &)> callback, std::string name="")
	Schedule an on_message_matching handler, constructing the NetworkSource from config.
void	on_network_message_matching (std::shared_ptr< Vruta::NetworkSource > source, std::function< bool(const Core::NetworkMessage &)> predicate, std::function< void(const Core::NetworkMessage &)> callback, std::string name="")
	Schedule an on_message_matching handler with an existing NetworkSource.
void	on_scroll (const std::shared_ptr< Core::Window > &window, std::function< void(double, double)> callback, std::string name="")
	Schedule a mouse scroll handler.
std::shared_ptr< Nodes::Node >	operator* (const std::shared_ptr< Nodes::Node > &lhs, const std::shared_ptr< Nodes::Node > &rhs)
	Combines two nodes in parallel (multiplication)
std::shared_ptr< Nodes::Node >	operator+ (const std::shared_ptr< Nodes::Node > &lhs, const std::shared_ptr< Nodes::Node > &rhs)
	Combines two nodes in parallel (addition)
std::shared_ptr< Nodes::Node >	operator>> (const std::shared_ptr< Nodes::Node > &lhs, const std::shared_ptr< Nodes::Node > &rhs)
	Connects two nodes in series (pipeline operator)
std::shared_ptr< Buffers::Buffer >	operator| (const TemporalWrapper< Buffers::Buffer > &wrapper, const CreationContext &ctx)
std::shared_ptr< Nodes::Network::NodeNetwork >	operator| (const TemporalWrapper< Nodes::Network::NodeNetwork > &wrapper, const CreationContext &ctx)
std::shared_ptr< Nodes::Node >	operator| (const TemporalWrapper< Nodes::Node > &wrapper, const CreationContext &ctx)
std::shared_ptr< Kakshya::SoundFileContainer >	operator| (std::shared_ptr< Kakshya::SoundFileContainer > obj, const CreationContext &ctx)
template<typename T > requires std::is_base_of_v<Nodes::Node, T>
std::shared_ptr< T >	operator| (std::shared_ptr< T > obj, const CreationContext &ctx)
template<typename T > requires std::is_base_of_v<Nodes::Network::NodeNetwork, T>
std::shared_ptr< T >	operator| (std::shared_ptr< T > obj, const CreationContext &ctx)
template<typename T > requires std::is_base_of_v<Buffers::Buffer, T>
std::shared_ptr< T >	operator| (std::shared_ptr< T > obj, const CreationContext &ctx)
template<typename T > requires std::is_base_of_v<Kakshya::VideoStreamContainer, T>
std::shared_ptr< T >	operator| (std::shared_ptr< T > obj, const CreationContext &ctx)
	Hook a video or camera container to a buffer in the Graphics domain.
void	Pause ()
	Pauses audio processing on the default engine.
std::vector< std::shared_ptr< Buffers::SoundContainerBuffer > >	prepare_audio_buffers (const std::shared_ptr< Kakshya::SoundFileContainer > &container)
	Constructs and initializes per-channel SoundContainerBuffers without registering them.
void	read_from_audio_input (const std::shared_ptr< Buffers::AudioBuffer > &buffer, uint32_t channel=0)
	Reads audio data from the default input source into a buffer.
std::shared_ptr< Kriya::BufferPipeline >	record_into (const std::shared_ptr< Kakshya::DynamicSoundStream > &stream, const std::shared_ptr< Buffers::AudioBuffer > &buffer, uint32_t channel=0)
	Record a live buffer into one channel of a stream.
std::shared_ptr< Kriya::BufferPipeline >	record_into (const std::shared_ptr< Kakshya::DynamicSoundStream > &stream, Kriya::CaptureBuilder source, uint32_t channel=0)
	Record a signal into one channel of a stream, a block at a time.
std::vector< std::shared_ptr< Kriya::BufferPipeline > >	record_into (const std::shared_ptr< Kakshya::DynamicSoundStream > &stream, std::vector< Kriya::CaptureBuilder > sources)
	Record several sources into consecutive channels of a stream.
void	register_audio_buffer (const std::shared_ptr< Buffers::AudioBuffer > &buffer, uint32_t channel=0)
	Registers an AudioBuffer with the default engine's buffer manager.
void	register_audio_node (const std::shared_ptr< Nodes::Node > &node, const std::vector< uint32_t > &channels)
	Adds a node to the root node of specified channels.
void	register_audio_node (const std::shared_ptr< Nodes::Node > &node, uint32_t channel=0)
	Adds a node to the root node of a specific channel.
void	register_buffer (const std::shared_ptr< Buffers::Buffer > &buffer, const CreationContext &ctx)
void	register_container (const std::shared_ptr< Kakshya::SoundFileContainer > &container, const Domain &domain)
void	register_container (const std::shared_ptr< Kakshya::VideoStreamContainer > &container, const Domain &domain)
void	register_graphics_buffer (const std::shared_ptr< Buffers::VKBuffer > &buffer, Buffers::ProcessingToken token=Buffers::ProcessingToken::GRAPHICS_BACKEND)
	Registers a VKBuffer with the default engine's buffer manager.
void	register_input_node (const std::shared_ptr< Nodes::Input::InputNode > &node, const Core::InputBinding &binding)
	Register an input node with specified binding.
void	register_network (const std::shared_ptr< Nodes::Network::NodeNetwork > &network, const CreationContext &ctx)
void	register_node (const std::shared_ptr< Nodes::Node > &node, const CreationContext &ctx)
void	register_node (const std::shared_ptr< Nodes::Node > &node, const Nodes::ProcessingToken &token, uint32_t channel)
void	register_node_network (const std::shared_ptr< Nodes::Network::NodeNetwork > &network, const Nodes::ProcessingToken &token=Nodes::ProcessingToken::AUDIO_RATE)
	Registers a node network with the default engine's node graph manager.
void	remove_processor (const std::shared_ptr< Buffers::BufferProcessor > &processor, Buffers::ProcessingToken token=Buffers::ProcessingToken::AUDIO_BACKEND)
	Removes a processor from all buffers in a processing domain.
void	remove_processor (const std::shared_ptr< Buffers::BufferProcessor > &processor, const std::shared_ptr< Buffers::Buffer > &buffer)
	Removes a processor from a specific buffer.
void	remove_processor (const std::shared_ptr< Buffers::BufferProcessor > &processor, uint32_t channel, Buffers::ProcessingToken token=Buffers::ProcessingToken::AUDIO_BACKEND)
	Removes a processor from all buffers in a specific channel.
void	remove_supplied_buffer_from_channel (const std::shared_ptr< Buffers::AudioBuffer > &buffer, const uint32_t channel)
	Removes a supplied buffer from multiple channels.
void	remove_supplied_buffer_from_channels (const std::shared_ptr< Buffers::AudioBuffer > &buffer, const std::vector< uint32_t > &channels)
	Removes a supplied buffer from multiple channels.
bool	restart_task (const std::string &name)
	Restarts a scheduled task.
void	Resume ()
	Resumes audio processing on the default engine.
void	route_buffer (const std::shared_ptr< Buffers::AudioBuffer > &buffer, uint32_t target_channel, double seconds_to_fade=1.0, const Buffers::ProcessingToken &token=Buffers::ProcessingToken::AUDIO_BACKEND)
	Routes a buffer from its current channel to a target channel with fade.
void	route_buffer (const std::shared_ptr< Buffers::AudioBuffer > &buffer, uint32_t target_channel, uint32_t num_blocks, const Buffers::ProcessingToken &token=Buffers::ProcessingToken::AUDIO_BACKEND)
	Routes a buffer from its current channel to a target channel with fade.
void	route_network (const std::shared_ptr< Nodes::Network::NodeNetwork > &network, const std::vector< uint32_t > &channels, double seconds_to_fade=1.F, const Nodes::ProcessingToken &token=Nodes::ProcessingToken::AUDIO_RATE)
	@breif Moves the network from its current channel(s) to the specified channel(s) with an optional fade time
void	route_network (const std::shared_ptr< Nodes::Network::NodeNetwork > &network, const std::vector< uint32_t > &channels, uint32_t num_samples, const Nodes::ProcessingToken &token=Nodes::ProcessingToken::AUDIO_RATE)
	@breif Moves the node from its current channel(s) to the specified channel(s) with an optional fade time
void	route_node (const std::shared_ptr< Nodes::Node > &node, const std::vector< uint32_t > &channels, double seconds_to_fade=1.F, const Nodes::ProcessingToken &token=Nodes::ProcessingToken::AUDIO_RATE)
	@breif Moves the node from its current channel(s) to the specified channel(s) with an optional fade time
void	route_node (const std::shared_ptr< Nodes::Node > &node, const std::vector< uint32_t > &channels, uint32_t num_samples, const Nodes::ProcessingToken &token=Nodes::ProcessingToken::AUDIO_RATE)
	@breif Moves the node from its current channel(s) to the specified channel(s) with an optional fade time
uint64_t	samples_to_blocks (uint64_t samples)
	Converts samples to blocks based on current block size.
double	samples_to_seconds (uint64_t samples)
	Converts a number of audio samples to the equivalent time duration in seconds.
bool	save_audio (const std::shared_ptr< Kakshya::SoundStreamContainer > &container, const std::string &suggested_name="output.wav")
	Present a native save-file dialog and write container to the chosen path via IOManager::write().
bool	save_composite (const std::shared_ptr< Kakshya::CompositeContainer > &container, const std::string &suggested_name="output.csv")
	Choose a CSV or TSV destination and save a CompositeContainer.
bool	save_image (const std::shared_ptr< Buffers::TextureBuffer > &buffer, const std::string &suggested_name, const IO::ImageWriteOptions &options)
	Present a native save-file dialog filtered to image formats and save buffer to the chosen path via IOManager::save_image().
bool	save_image (const std::shared_ptr< Buffers::TextureBuffer > &buffer, const std::string &suggested_name="output.png")
	Present a native save-file dialog filtered to image formats and save buffer to the chosen path via IOManager::save_image().
bool	save_mesh (const std::shared_ptr< Buffers::MeshBuffer > &buffer, const std::string &suggested_name, const IO::ModelWriteOptions &options)
	Present a native save-file dialog filtered to 3D model formats and save buffer to the chosen path via IOManager::save_mesh().
bool	save_mesh (const std::shared_ptr< Buffers::MeshBuffer > &buffer, const std::string &suggested_name="output.gltf")
	Present a native save-file dialog filtered to 3D model formats and save buffer to the chosen path via IOManager::save_mesh().
bool	save_mesh (const std::shared_ptr< Nodes::Network::MeshNetwork > &network, const std::string &suggested_name, const IO::ModelWriteOptions &options)
	Present a native save-file dialog filtered to 3D model formats and save network to the chosen path via IOManager::save_mesh().
bool	save_mesh (const std::shared_ptr< Nodes::Network::MeshNetwork > &network, const std::string &suggested_name="output.gltf")
	Present a native save-file dialog filtered to 3D model formats and save network to the chosen path via IOManager::save_mesh().
bool	save_spatial (std::vector< IO::SpatialCaptureSource > sources, const std::string &suggested_name="output.abc")
	Present a native save-file dialog filtered to Alembic and write every source once via IOManager::save_spatial_snapshot().
bool	save_volume (const std::shared_ptr< Buffers::VolumeGridBuffer > &volume, const std::string &suggested_name, const IO::VolumeWriteOptions &options)
	Present a native save-file dialog filtered to volume formats and save volume to the chosen path via IOManager::save_volume().
bool	save_volume (const std::shared_ptr< Buffers::VolumeGridBuffer > &volume, const std::string &suggested_name="output.vdb")
	Present a native save-file dialog filtered to volume formats and save volume to the chosen path via IOManager::save_volume().
std::shared_ptr< Vruta::SoundRoutine >	schedule_line (float start_value, float end_value, float duration_seconds, uint32_t step_duration=5, bool retain=true, std::string name="")
	Creates a line generator that interpolates between values over time and schedules it for evaluation.
void	schedule_metro (double interval_seconds, std::function< void()> callback, std::string name="", Vruta::ProcessingToken token=Vruta::ProcessingToken::SAMPLE_ACCURATE)
	Creates a metronome task and addes it to the default scheduler list for evaluation.
template<std::incrementable Index = uint64_t, typename Generator , typename Callback > requires Kriya::PatternGenerator<Generator, Index> && Kriya::PatternCallback<Callback, typename Kriya::PatternTraits<Generator, Index>::value_type>
void	schedule_pattern (Generator generator, Callback callback, std::vector< double > durations, std::string name="", Vruta::ProcessingToken token=Vruta::ProcessingToken::SAMPLE_ACCURATE)
	Schedules a typed pattern whose steps are spaced by a list of durations.
template<std::incrementable Index = uint64_t, typename Generator , typename Callback , typename Third > requires Kriya::PatternGenerator<Generator, Index> && Kriya::PatternCallback<Callback, typename Kriya::PatternTraits<Generator, Index>::value_type> && (Kriya::PatternCondition<Third, Index> || Kriya::PatternDurationSource<Third>)
void	schedule_pattern (Generator generator, Callback callback, Third third, std::string name="", Vruta::ProcessingToken token=Vruta::ProcessingToken::SAMPLE_ACCURATE)
	Schedules a typed pattern driven by a condition or by a durations function.
void	schedule_pattern (std::function< std::any(uint64_t)> pattern_func, std::function< void(std::any)> callback, double interval_seconds, std::string name="", Vruta::ProcessingToken token=Vruta::ProcessingToken::SAMPLE_ACCURATE)
	Schedules a pattern generator with one interval between steps.
void	schedule_pattern (std::function< std::any(uint64_t)> pattern_func, std::function< void(std::any)> callback, std::vector< double > durations, std::string name="", Vruta::ProcessingToken token=Vruta::ProcessingToken::SAMPLE_ACCURATE)
	Schedules a pattern generator whose steps are spaced by a list of durations.
void	schedule_sequence (std::vector< std::pair< double, std::function< void()> > > sequence, std::string name="", Vruta::ProcessingToken token=Vruta::ProcessingToken::SAMPLE_ACCURATE)
	Creates a sequence task that calls functions at specified times and addes it to the default scheduler list for evaluation.
void	schedule_task (const std::string &name, const std::shared_ptr< Vruta::Routine > &task, bool initialize=false)
	Schedules a routine of any type that is already held by a shared_ptr.
void	schedule_task (const std::string &name, Vruta::FreeRoutine &&task, bool initialize=false)
	Schedules a new free routine conditional task.
void	schedule_task (const std::string &name, Vruta::GraphicsRoutine &&task, bool initialize=false)
	Schedules a new sound routine task.
void	schedule_task (const std::string &name, Vruta::SoundRoutine &&task, bool initialize=false)
	Schedules a new sound routine task.
uint64_t	seconds_to_blocks (double seconds)
	Converts a time duration in seconds to the equivalent number of processing blocks.
uint64_t	seconds_to_samples (double seconds)
	Converts a time duration in seconds to the equivalent number of audio samples.
void	set_mix_normalization_for_channel (uint32_t channel, bool enabled)
	Sets whether a channel's mix is averaged over its sources.
void	set_mix_normalization_for_channels (const std::vector< uint32_t > &channels, bool enabled)
	Sets whether the mix of several channels is averaged over their sources.
void	Start ()
	Starts audio processing on the default engine.
template<typename T >
std::shared_ptr< T >	store (std::shared_ptr< T > obj)
	Transfer ownership of an existing object to the persistent store for process lifetime.
template<typename T >
std::shared_ptr< T >	store (std::string_view key, std::shared_ptr< T > obj)
	Transfer ownership of an existing object to the persistent store and expose it to the live arena under key.
template<typename T >
void	store (T obj)
	Transfer ownership of a value to the persistent store for process lifetime.
void	supply_buffer_to_channel (const std::shared_ptr< Buffers::AudioBuffer > &buffer, uint32_t channel, double mix=1.0)
	Supplies a buffer to a single channel with mixing.
void	supply_buffer_to_channels (const std::shared_ptr< Buffers::AudioBuffer > &buffer, const std::vector< uint32_t > &channels, double mix=1.0)
	Supplies a buffer to multiple channels with mixing.
TimeSpec	Time (double seconds)
void	unbind_viewport_preset (const std::shared_ptr< Core::Window > &window, const std::string &name="default")
	Cancel all event handlers registered by bind_viewport_preset() and restore the window input config to its state before bind was called.
void	unregister_audio_buffer (const std::shared_ptr< Buffers::AudioBuffer > &buffer, uint32_t channel=0)
	Unregisters an AudioBuffer from the default engine's buffer manager.
void	unregister_audio_node (const std::shared_ptr< Nodes::Node > &node, const std::vector< uint32_t > &channels)
	Removes a node from the root node from list of channels.
void	unregister_audio_node (const std::shared_ptr< Nodes::Node > &node, uint32_t channel=0)
	Removes a node from the root node of a specific channel.
void	unregister_graphics_buffer (const std::shared_ptr< Buffers::VKBuffer > &buffer)
	Unregisters a VKBuffer from the default engine's buffer manager.
void	unregister_input_node (const std::shared_ptr< Nodes::Input::InputNode > &node)
	Unregister an input node.
void	unregister_node (const std::shared_ptr< Nodes::Node > &node, const Nodes::ProcessingToken &token, uint32_t channel=0)
	Removes a node from the root node of specified channels.
void	unregister_node_network (const std::shared_ptr< Nodes::Network::NodeNetwork > &network, const Nodes::ProcessingToken &token=Nodes::ProcessingToken::AUDIO_RATE)
	Unregisters a node network from the default engine's node graph manager.
template<typename... Args>
bool	update_task_params (const std::string &name, Args... args)
	Updates parameters of a scheduled task.
template<typename... Args>
MAYAFLUX_API bool	update_task_params (const std::string &name, Args... args)
	Updates parameters of a scheduled task.
glm::vec2	window_coords (const glm::vec3 &ndc_pos, const std::shared_ptr< Core::Window > &window)
	Convert NDC vec3 position to window pixel coordinates using window state.
glm::vec2	window_coords (const glm::vec3 &ndc_pos, uint32_t window_width, uint32_t window_height)
	Convert NDC vec3 position to window pixel coordinates.
glm::vec2	window_coords (double ndc_x, double ndc_y, double ndc_z, const std::shared_ptr< Core::Window > &window)
	Convert NDC coordinates to window pixel coordinates using window state.
glm::vec2	window_coords (double ndc_x, double ndc_y, double ndc_z, uint32_t window_width, uint32_t window_height)
	Convert NDC coordinates to window pixel coordinates.

Variables
static constexpr DomainSpec	Audio { .value = Domain::AUDIO }
	Domain constant for Audio domain.
static constexpr DomainSpec	Graphics { .value = Domain::GRAPHICS }
	Domain constant for Graphics domain.
Creator	vega {}
	Global Creator instance.

Detailed Description

Main namespace for the Maya Flux audio engine.

This namespace provides convenience wrappers around the core functionality of the Maya Flux audio engine. These wrappers simplify access to the centrally managed components and common operations, making it easier to work with the engine without directly managing the Engine instance.

All functions in this namespace operate on the default Engine instance and its managed components. For custom or non-default components, use their specific handles and methods directly rather than these wrappers.