oxr_action_attachment Struct Reference

Data associated with an Action that has been attached to a Session. More...

#include <oxr/oxr_objects.h>

Collaboration diagram for oxr_action_attachment:

Static Public Member Functions
static void	oxr_action_attachment_teardown (struct oxr_action_attachment *act_attached)
	Tear down an action attachment struct.
static XrResult	oxr_action_attachment_init (struct oxr_logger *log, struct oxr_action_attachment *act_attached, struct oxr_session_attached_actions *attached_actions, struct oxr_action_set_attachment *act_set_attached, struct oxr_action_ref *act_ref)
	Set up an action attachment struct.
static XrResult	oxr_action_attachment_bind (struct oxr_logger *log, struct oxr_instance *inst, struct oxr_action_attachment *act_attached, const struct oxr_roles *roles, const struct oxr_profiles_per_subaction *profiles)

Data Fields
struct oxr_action_set_attachment *	act_set_attached
	The owning action set attachment.
struct oxr_action_ref *	act_ref
	This action's refcounted data.
struct oxr_session_attached_actions *	attached_actions
	The session attached actions this action attachment belongs to.
uint32_t	act_key
	Unique key for the session hashmap.
struct oxr_subaction_paths	any_pose_subaction_path
	For pose actions any subaction paths are special treated, at bind time we pick one subaction path and stick to it as long as the action lives.
struct oxr_action_state	any_state
struct oxr_action_cache	left
struct oxr_action_cache	right
struct oxr_action_cache	head
struct oxr_action_cache	gamepad
struct oxr_action_cache	eyes
struct oxr_action_cache	user

Detailed Description

Data associated with an Action that has been attached to a Session.

More information on the action vs action attachment and action set vs action set attachment parallel is in the docs for OpenXR input

See also

oxr_action

Member Function Documentation

oxr_action_attachment_bind()

static XrResult oxr_action_attachment_bind ( struct oxr_logger *  log, struct oxr_instance *  inst, struct oxr_action_attachment *  act_attached, const struct oxr_roles *  roles, const struct oxr_profiles_per_subaction *  profiles  )

static

The any sub path is special cased for poses, it binds to one sub path and sticks with it.

References act_ref, act_set_attached, oxr_action_set_attachment::act_set_key, oxr_action_set_attachment::act_set_ref, oxr_action_ref::action_type, oxr_action_ref::name, oxr_action_set_ref::name, OXR_FOR_EACH_VALID_SUBACTION_PATH, OXR_FOR_EACH_VALID_SUBACTION_PATH_DETAILED, oxr_log_slog(), oxr_slog_cancel(), and oxr_action_ref::subaction_paths.

oxr_action_attachment_init()

static XrResult oxr_action_attachment_init ( struct oxr_logger *  log, struct oxr_action_attachment *  act_attached, struct oxr_session_attached_actions *  attached_actions, struct oxr_action_set_attachment *  act_set_attached, struct oxr_action_ref *  act_ref  )

static

Set up an action attachment struct.

References act_key, oxr_action_ref::act_key, act_ref, act_set_attached, attached_actions, oxr_error(), oxr_refcounted_ref(), oxr_refcounted_unref(), and U_ZERO.

Referenced by oxr_session::oxr_session_attach_action_sets().

oxr_action_attachment_teardown()

static void oxr_action_attachment_teardown ( struct oxr_action_attachment *  act_attached )

static

Tear down an action attachment struct.

Does not deallocate the struct itself.

References act_ref, attached_actions, OXR_FOR_EACH_SUBACTION_PATH, and oxr_refcounted_unref().

Field Documentation

act_key

uint32_t oxr_action_attachment::act_key

Unique key for the session hashmap.

Referenced by oxr_action_attachment_init(), oxr_session::oxr_action_get_pose_input(), oxr_session_attached_actions::oxr_session_attached_actions_add_action_attachment(), and oxr_session_attached_actions::oxr_session_attached_actions_remove_action_attachment().

act_ref

struct oxr_action_ref* oxr_action_attachment::act_ref

This action's refcounted data.

Referenced by oxr_action_attachment_bind(), oxr_action_attachment_init(), and oxr_action_attachment_teardown().

act_set_attached

struct oxr_action_set_attachment* oxr_action_attachment::act_set_attached

The owning action set attachment.

Referenced by oxr_action_attachment_bind(), oxr_action_attachment_init(), oxr_action_sync_data(), and oxr_session::oxr_session_attach_action_sets().

any_pose_subaction_path

struct oxr_subaction_paths oxr_action_attachment::any_pose_subaction_path

For pose actions any subaction paths are special treated, at bind time we pick one subaction path and stick to it as long as the action lives.

Referenced by oxr_session::oxr_action_get_pose_input().

attached_actions

struct oxr_session_attached_actions* oxr_action_attachment::attached_actions

The session attached actions this action attachment belongs to.

Referenced by oxr_action_attachment_init(), oxr_action_attachment_teardown(), and oxr_session::oxr_session_attach_action_sets().

---

The documentation for this struct was generated from the following files:

• state_trackers/oxr/oxr_objects.h
• state_trackers/oxr/actions/oxr_input.c