A single action. More...

#include <oxr/oxr_objects.h>

Inheritance diagram for oxr_action:

Collaboration diagram for oxr_action:

[legend]

Public Member Functions
XrResult	oxr_action_create (struct oxr_logger log, struct oxr_action_set act_set, const XrActionCreateInfo createInfo, struct oxr_action *out_act)

Public Member Functions inherited from oxr_handle_base
XrResult	oxr_handle_destroy (struct oxr_logger log, struct oxr_handle_base hb)
	Destroy the handle's object, as well as all child handles recursively.

Data Fields
struct oxr_handle_base	handle
	Common structure for things referred to by OpenXR handles.

struct oxr_action_set *	act_set
	Owner of this action.

struct oxr_action_ref *	data
	The data for this action that must live as long as any session we are attached to.

uint32_t	act_key
	Unique key for the session hashmap.

struct u_hashset_item *	name_item
	The item in the name hashset.

struct u_hashset_item *	loc_item
	The item in the localized hashset.

Data Fields inherited from oxr_handle_base
uint64_t	debug
	Magic (per-handle-type) value for debugging.

struct oxr_handle_base *	parent
	Pointer to this object's parent handle holder, if any.

struct oxr_handle_base *	children [256]
	Array of children, if any.

enum oxr_handle_state	state
	Current handle state.

oxr_handle_destroyer	destroy
	Destroy the object this handle refers to.

Related Symbols
(Note that these are not member symbols.)
static XrAction	oxr_action_to_openxr (struct oxr_action *act)
	To go back to a OpenXR object.

Related Symbols inherited from oxr_handle_base
typedef XrResult(*	oxr_handle_destroyer) (struct oxr_logger log, struct oxr_handle_base hb)
	Function pointer type for a handle destruction function.

XrResult	oxr_handle_allocate_and_init (struct oxr_logger log, size_t size, uint64_t debug, oxr_handle_destroyer destroy, struct oxr_handle_base parent, void **out)
	Allocate some memory for use as a handle, and initialize it as a handle.

#define	OXR_ALLOCATE_HANDLE(LOG, OUT, DEBUG, DESTROY, PARENT) oxr_handle_allocate_and_init(LOG, sizeof(OUT), DEBUG, DESTROY, PARENT, (void *)&OUT)
	Allocates memory for a handle and evaluates to an XrResult.

#define	OXR_ALLOCATE_HANDLE_OR_RETURN(LOG, OUT, DEBUG, DESTROY, PARENT)
	Allocate memory for a handle, returning in case of failure.

const char *	oxr_handle_state_to_string (enum oxr_handle_state state)
	Returns a human-readable label for a handle state.

Additional Inherited Members
Protected Member Functions inherited from oxr_handle_base
XrResult	oxr_handle_init (struct oxr_logger log, struct oxr_handle_base hb, uint64_t debug, oxr_handle_destroyer destroy, struct oxr_handle_base *parent)
	Initialize a handle holder, and if a parent is specified, update its child list to include this handle.

Detailed Description

A single action.

Parent type/handle is oxr_action_set

For actual usage, an action is attached to a session: the corresponding data is in oxr_action_attachment

OpenXR Object:: XrAction

Field Documentation

◆ act_key

uint32_t oxr_action::act_key

Unique key for the session hashmap.

Duplicated from oxr_action_ref::act_key for efficiency.

Referenced by oxr_action_attachment::oxr_action_attachment_init(), oxr_xrApplyHapticFeedback(), oxr_xrCreateActionSpace(), oxr_xrEnumerateBoundSourcesForAction(), oxr_xrGetActionStateBoolean(), oxr_xrGetActionStateFloat(), oxr_xrGetActionStatePose(), oxr_xrGetActionStateVector2f(), and oxr_xrStopHapticFeedback().

◆ act_set

struct oxr_action_set* oxr_action::act_set

Owner of this action.

Referenced by oxr_session::oxr_session_attach_action_sets(), oxr_xrApplyHapticFeedback(), oxr_xrGetActionStateBoolean(), oxr_xrGetActionStateFloat(), oxr_xrGetActionStatePose(), oxr_xrGetActionStateVector2f(), oxr_xrStopHapticFeedback(), and oxr_xrSuggestInteractionProfileBindings().

◆ data

struct oxr_action_ref* oxr_action::data

The data for this action that must live as long as any session we are attached to.

Referenced by oxr_action_attachment::oxr_action_attachment_init(), oxr_xrApplyHapticFeedback(), oxr_xrGetActionStateBoolean(), oxr_xrGetActionStateFloat(), oxr_xrGetActionStatePose(), oxr_xrGetActionStateVector2f(), oxr_xrStopHapticFeedback(), and oxr_xrSuggestInteractionProfileBindings().

◆ handle

struct oxr_handle_base oxr_action::handle

Common structure for things referred to by OpenXR handles.

Referenced by oxr_xrDestroyAction().

◆ loc_item

struct u_hashset_item* oxr_action::loc_item

The item in the localized hashset.

◆ name_item

struct u_hashset_item* oxr_action::name_item

The item in the name hashset.

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

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

Public Member Functions

Data Fields

Related Symbols

Additional Inherited Members