oxr_instance_action_context.h

Go to the documentation of this file.

// Copyright 2018-2024, Collabora, Ltd.
// Copyright 2023-2026, NVIDIA CORPORATION.
// SPDX-License-Identifier: BSL-1.0
/*!
 * @file
 * @brief Holds per instance action context.
 * @ingroup oxr_main
 */
 
#pragma once
 
#include "oxr_forward_declarations.h"
#include "oxr_interaction_profile_array.h"
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/*!
 * Holds all action-related state that lives at the instance level (shared
 * across sessions). Used for duplicate checking and storage of client-suggested
 * that are later applied when action sets are attached to a session.
 *
 * - @ref action_sets: Registry of action set name and localized name pairs.
 *   Used to enforce uniqueness in xrCreateActionSet and to remove entries when
 *   an action set is destroyed.
 * - @ref suggested_profiles: Interaction profile bindings suggested by the app
 *   via xrSuggestInteractionProfileBindings. When the app calls
 *   xrAttachSessionActionSets, this array is cloned into the session’s action
 *   context so the runtime can apply those suggestions for that session.
 *
 * In a future extension, this context is intended to support namespaced action
 * sets and to allow plugins (e.g. in a game) to suggest their own bindings
 * without affecting the main application’s bindings.
 *
 * @ingroup oxr_main
 */
struct oxr_instance_action_context
{
        /*!
         * Action set name and localized name stores.
         */
        struct
        {
                struct u_hashset *name_store;
                struct u_hashset *loc_store;
        } action_sets;
 
        /*!
         * Interaction profile bindings that have been suggested by the client.
         */
        struct oxr_interaction_profile_array suggested_profiles;
};
 
 
/*
 *
 * Functions
 *
 */
 
/*!
 * Initialize the action context for an instance.
 *
 * @param log Logger
 * @param context Action context to initialize
 * @public @memberof oxr_instance_action_context
 * @ingroup oxr_main
 */
XRT_CHECK_RESULT XrResult
oxr_instance_action_context_init(struct oxr_logger *log, struct oxr_instance_action_context *context);
 
/*!
 * Finalize and cleanup the action context for an instance.
 *
 * @param context Action context to finalize
 * @public @memberof oxr_instance_action_context
 * @ingroup oxr_main
 */
void
oxr_instance_action_context_fini(struct oxr_instance_action_context *context);
 
 
#ifdef __cplusplus
}
#endif