@brief Creates a new projectM instance, reading settings from the given file. @param setting_file_path A path to the settings file to read the configuration from. If NULL or an empty path are provided, default settings will be used. @param flags Any combination of values from the projectm_flags enumeration. @return A projectM handle for the newly created instance that must be used in subsequent API calls. NULL if the instance could not be created successfully.

projectm_create_settings ^⚠

@brief Creates a new projectM instance with given settings. @param settings A pointer to a projectm_settings_t with the settings to be used by the new instance. If this pointer is NULL, default settings will be used. @param flags Any combination of values from the projectm_flags enumeration. @return A projectM handle for the newly created instance that must be used in subsequent API calls. NULL if the instance could not be created successfully.

projectm_default_key_handler ^⚠

@brief Default key handler that processes user input.

projectm_delete_search_text ^⚠

@brief Deletes one character from the preset search text.

projectm_destroy ^⚠

@brief Destroys the given instance and frees the resources.

projectm_free_settings ^⚠

@brief Frees the memory of an allocated projectm_settings structure.

projectm_free_string ^⚠

@brief Frees the memory of an allocated string.

projectm_get_aspect_correction ^⚠

@brief Returns whether aspect ratio correction is enabled or not. @param instance The projectM instance handle. @return True if aspect ratio correction is enabled, false otherwise.

projectm_get_data_dir_path ^⚠

@brief Returns the path projectM uses to search for additional data. @param instance The projectM instance handle. @return The data dir path.

projectm_get_easter_egg ^⚠

@brief Returns the current “easter egg” value. @param instance The projectM instance handle. @return The current “easter egg” value.

projectm_get_error_loading_current_preset ^⚠

@brief Returns whether the current preset was loaded successfully or not. @param instance The projectM instance handle. @return True if the preset was not loaded successfully, false if it is displayed correctly.

projectm_get_fps ^⚠

@brief Returns the target frames per second count. @note This is not the actual FPS, but the targeted refresh framerate if the integrating application. @param instance The projectM instance handle.

projectm_get_hard_cut_duration ^⚠

@brief Returns the minimum display time before a hard cut can happen. @param instance The projectM instance handle. @return The minimum number of seconds the preset will be displayed before a hard cut.

projectm_get_hard_cut_enabled ^⚠

@brief Returns whether hard cuts are enabled or not. @param instance The projectM instance handle. @return True if hard cuts are enabled, false otherwise.

projectm_get_hard_cut_sensitivity ^⚠

@brief Returns the current hard cut sensitivity. @param instance The projectM instance handle. @return The current hard cut sensitivity.

projectm_get_menu_font_filename ^⚠

@brief Returns the path and filename of the font used to render the menu overlay text. @param instance The projectM instance handle. @return The path and filename of the menu text font.

projectm_get_mesh_size ^⚠

@brief Returns the per-pixel equation mesh size in units. @param instance The projectM instance handle. @param width The width of the mesh. @param height The height of the mesh.

projectm_get_playlist_size ^⚠

@brief Returns the number of presets in the current playlist. @param instance The projectM instance handle. @return The number of presets in the currently loaded playlist.

projectm_get_preset_filename ^⚠

@brief Returns the path and filename of the preset at the requested playlist index. @note Make sure the index is inside the playlist bounds! @param instance The projectM instance handle. @param index The playlist index to return the filename for. @return The full path and filename of the preset at the given index.

projectm_get_preset_index ^⚠

@brief Returns the playlist index for the given preset name.

projectm_get_preset_name ^⚠

@brief Returns the display name of the preset at the requested playlist index. @note Make sure the index is inside the playlist bounds! @param instance The projectM instance handle. @param index The playlist index to return the display name for. @return The display name of the preset at the given index.

projectm_get_preset_path ^⚠

@brief Returns the search path for presets and textures. @param instance The projectM instance handle. @return The path used to search for presets and textures.

projectm_get_preset_rating ^⚠

@brief Returns the rating for the given index and transition type. @param instance The projectM instance handle. @param index The playlist item to retrieve the rating from. @param rating_type The rating type to retrieve, either hard or soft cut. @return The rating value of the requested item and type.

projectm_get_search_index ^⚠

@brief Gets the index of the provided preset name in the current search result list. @param instance The projectM instance handle. @param name The name of the preset to return the index for. @return The search result list index of the given preset name.

projectm_get_search_text ^⚠

@brief Returns the current preset search text. @param instance The projectM instance handle. @return The current search text used to search for presets in the playlist.

projectm_get_selected_preset_index ^⚠

@brief Returns the currently selected preset index. @param instance The projectM instance handle. @param index A valid pointer to an unsigned int that will receive the preset index. @return True if a preset idnex was returned, false if no preset was selected, e.g. the playlist is empty.

projectm_get_settings ^⚠

@brief Returns a structure with the current projectM settings. @param instance The projectM instance handle. @return A struct with all currently used settings.

projectm_get_shuffle_enabled ^⚠

@brief Returns whether playlist shuffling is currently enabled or not. @param instance The projectM instance handle. @return True if shuffle is enabled, false if not.

projectm_get_soft_cut_duration ^⚠

@brief Returns the time in seconds for a soft transition between two presets. @param instance The projectM instance handle. @return Time in seconds it takes to smoothly transition from one preset to another.

projectm_get_texture_size ^⚠

@brief Returns the size of the internal render texture. @param instance The projectM instance handle. @return The size of the internal rendering texture.

projectm_get_title ^⚠

@brief Returns the current title text. @param instance The projectM instance handle. @return The currently set title text.

projectm_get_title_font_filename ^⚠

@brief Returns the path and filename of the font used to render the title overlay text. @param instance The projectM instance handle. @return The path and filename of the title text font.

projectm_get_window_size ^⚠

@brief Returns the current viewport size in pixels. @param instance The projectM instance handle. @param width Valid pointer to a size_t variable that will receive the window width value. @param height Valid pointer to a size_t variable that will receive the window height value.

projectm_init_render_to_texture ^⚠

@brief Enables render-to-texture.

projectm_insert_preset_url ^⚠

@brief Adds a new preset at the given position in the playlist.

projectm_is_preset_locked ^⚠

@brief Returns whether the current preset is locked or not. @param instance The projectM instance handle. @return True if the preset lock is enabled, false otherwise.

projectm_is_text_input_active ^⚠

@brief Returns whether the search text input mode is active or not. @param instance The projectM instance handle. @param no_minimum_length If set to true, will return true if at least one character has been typed, otherwise a minimum length of three characters is required. @return True if text input mode is active, false otherwise.

projectm_key_handler ^⚠

@brief Key handler that processes user input.

projectm_lock_preset ^⚠

@brief Locks or unlocks the current preset.

projectm_pcm_add_float ^⚠

@brief Adds 32-bit floating-point audio samples.

projectm_pcm_add_int16 ^⚠

@brief Adds 16-bit integer audio samples.

projectm_pcm_add_uint8 ^⚠

@brief Adds 8-bit unsigned integer audio samples.

projectm_pcm_get_max_samples ^⚠

@brief Returns the maximum number of audio samples that can be stored.

projectm_populate_preset_menu ^⚠

@brief Populates the on-screen preset menu. @param instance The projectM instance handle.

projectm_preset_position_valid ^⚠

@brief Returns whether the currently selected preset has a valid position in the playlist.

projectm_remove_preset ^⚠

@brief Removes a preset from the playlist. @param instance The projectM instance handle. @param index The preset index to remove from the playlist.

projectm_render_frame ^⚠

@brief Renders a single frame.

projectm_reset_gl ^⚠

@brief Reset the projectM OpenGL renderer.

projectm_reset_search_text ^⚠

@brief Deletes the whole search text.

projectm_reset_textures ^⚠

@brief Reloads all textures.

projectm_select_next_preset ^⚠

@brief Switches to the next preset in the current playlist.

projectm_select_preset ^⚠

@brief Selects and displays the preset. @param instance The projectM instance handle. @param index the preset to display. @param hard_cut If true, a hard cut is made, otherwise it will be blended smoothly.

projectm_select_preset_by_name ^⚠

@brief Displays the preset with the given name. @param instance The projectM instance handle. @param preset_name The preset name to search for. @param hard_cut If true, the preset will be shown immediately, if false a soft transition will be rendered.

projectm_select_preset_position ^⚠

@brief Selects a preset, but does not display it. @param instance The projectM instance handle. @param index The preset index to select.

projectm_select_previous_preset ^⚠

@brief Switches to the previous preset in the current playlist.

projectm_select_random_preset ^⚠

@brief Switches to a random preset in the current playlist.

projectm_set_aspect_correction ^⚠

@brief Enabled or disables aspect ratio correction in presets that support it.

projectm_set_easter_egg ^⚠

@brief Sets the “easter egg” value.

projectm_set_hard_cut_duration ^⚠

@brief Sets the minimum display time before a hard cut can happen.

projectm_set_hard_cut_enabled ^⚠

@brief Enables or disables hard cuts.

projectm_set_hard_cut_sensitivity ^⚠

@brief Sets the hard cut volume sensitivity.

projectm_set_help_text ^⚠

@brief Sets the help menu text.

projectm_set_mesh_size ^⚠

@brief Sets the per-pixel equation mesh size in units. @note This will recreate the renderer. @param instance The projectM instance handle. @param width The new width of the mesh. @param height The new height of the mesh.

projectm_set_preset_duration ^⚠

@brief Sets the preset display duration before switching to the next using a soft cut.

projectm_set_preset_name ^⚠

@brief Changes the display name of the given preset in the playlist. @param instance The projectM instance handle. @param index the playlist item index to change. @param name The new display name.

projectm_set_preset_rating ^⚠

@brief Changes the rating or a playlist item and type. @param instance The projectM instance handle. @param index the playlist item to change the rating of. @param rating The new rating value. @param rating_type The type of the rating, either hard or soft cut.

projectm_set_preset_rating_changed_event_callback ^⚠

@brief Sets a callback function that will be called when a preset rating changed.

projectm_set_preset_switch_failed_event_callback ^⚠

@brief Sets a callback function that will be called when a preset change failed.

projectm_set_preset_switched_event_callback ^⚠

@brief Sets a callback function that will be called when a preset changes.

projectm_set_search_text ^⚠

@brief Sets the current preset search text. @param instance The projectM instance handle. @param search_text The search text used to search for presets in the current playlist.

projectm_set_shuffle_enable_changed_event_callback ^⚠

@brief Sets a callback function that will be called when the shuffle setting changes.

projectm_set_shuffle_enabled ^⚠

@brief Enables or disables preset playlist shuffling. @param instance The projectM instance handle. @param shuffle_enabled True to randomly select the next preset, false to skip to the next item in line.

projectm_set_soft_cut_duration ^⚠

@brief Sets the time in seconds for a soft transition between two presets.

projectm_set_texture_size ^⚠

@brief Changes the size of the internal render texture. @note This will recreate the internal renderer. @param instance The projectM instance handle. @param size The new size of the render texture. Must be a power of 2.

projectm_set_title ^⚠

@brief Sets the current title text and displays it. @param instance The projectM instance handle. @param title The title text to display.

projectm_set_toast_message ^⚠

@brief Displays a short message in the center of the rendering area for a few seconds.

projectm_set_window_size ^⚠

@brief Sets the current viewport size in pixels.

projectm_touch ^⚠

@brief Starts a touch event or moves an existing waveform.

projectm_touch_destroy ^⚠

@brief Removes any additional touch waveforms under the given coordinates. @param instance The projectM instance handle. @param x The last known x touch coordinate. @param y The last known y touch coordinate.

projectm_touch_destroy_all ^⚠

@brief Removes all touch waveforms from the screen.

projectm_touch_drag ^⚠

@brief Centers any waveforms under the coordinates to simulate dragging. @param instance The projectM instance handle. @param x The x coordinate of the drag. @param y the y coordinate of the drag. @param pressure The amount of pressure applied in a range from 0.0 to 1.0.

projectm_write_config ^⚠

@brief Saves the given settings struct into a file.

Type Definitions

For specifying audio data format.

projectm_flags

Flags that influence projectM instance creation.

projectm_handle

projectm_pcm_channel

Placeholder values that can be used to address channel indices in PCM data arrays.

projectm_preset_rating_changed_event

@brief Callback function that is executed if a preset rating has been changed.

projectm_preset_rating_type

Rating types supported by projectM. Used to control preset selection for different types of transitions (hard/soft).

projectm_preset_switch_failed_event

@brief Callback function that is executed if a preset change failed.

projectm_preset_switched_event

@brief Callback function that is executed on each preset change.

projectm_settings

@brief projectM instance settings.

projectm_shuffle_enable_changed_event

@brief Callback function that is executed is the shuffle setting has changed. @param shuffle_enabled True if shuffle is enabled, false if it was disabled. @param user_data A user-defined data pointer that was provided when registering the callback, e.g. context information.

projectm_touch_type

Waveform render types used in the touch start method.

Crate projectm_rs

Structs

Constants

Functions

Type Definitions