#include <GHOST_XrSession.hh>

Public Types
enum	LifeExpectancy { SESSION_KEEP_ALIVE , SESSION_DESTROY }

Public Member Functions
State Queries
bool	isRunning () const

Actions
bool	createActionSet (const GHOST_XrActionSetInfo &info)

void	destroyActionSet (const char *action_set_name)

bool	createActions (const char action_set_name, uint32_t count, const GHOST_XrActionInfo infos)

void	destroyActions (const char action_set_name, uint32_t count, const char const *action_names)

bool	createActionBindings (const char action_set_name, uint32_t count, const GHOST_XrActionProfileInfo infos)

void	destroyActionBindings (const char action_set_name, uint32_t count, const char const action_names, const char const *profile_paths)

bool	attachActionSets ()

bool	syncActions (const char *action_set_name=nullptr)

bool	applyHapticAction (const char action_set_name, const char action_name, const char *subaction_path, const int64_t &duration, const float &frequency, const float &amplitude)

void	stopHapticAction (const char action_set_name, const char action_name, const char *subaction_path)

void *	getActionSetCustomdata (const char *action_set_name)

void *	getActionCustomdata (const char action_set_name, const char action_name)

uint32_t	getActionCount (const char *action_set_name)

void	getActionCustomdataArray (const char action_set_name, void *r_customdata_array)

Controller Model
bool	loadControllerModel (const char *subaction_path)

void	unloadControllerModel (const char *subaction_path)

bool	updateControllerModelComponents (const char *subaction_path)

bool	getControllerModelData (const char *subaction_path, GHOST_XrControllerModelData &r_data)

Create, Initialize and Destruct
	GHOST_XrSession (GHOST_XrContext &xr_context)

	~GHOST_XrSession ()

State Management
void	start (const GHOST_XrSessionBeginInfo *begin_info)

void	requestEnd ()

LifeExpectancy	handleStateChangeEvent (const XrEventDataSessionStateChanged &lifecycle)

Drawing
bool	needsUpsideDownDrawing () const

void	draw (void *draw_customdata)

Graphics Context Injection
Sessions need access to Ghost graphics context information. Additionally, this API allows creating contexts on the fly (created on start, destructed on end). For this, callbacks to bind (potentially create) and unbind (potentially destruct) a Ghost graphics context have to be set, which will be called on session start and end respectively.
void	unbindGraphicsContext ()

Detailed Description

Definition at line 21 of file GHOST_XrSession.hh.

Member Enumeration Documentation

◆ LifeExpectancy

enum GHOST_XrSession::LifeExpectancy

Enumerator
SESSION_KEEP_ALIVE
SESSION_DESTROY

Definition at line 23 of file GHOST_XrSession.hh.

Constructor & Destructor Documentation

◆ GHOST_XrSession()

GHOST_XrSession::GHOST_XrSession ( GHOST_XrContext & xr_context )

Definition at line 68 of file GHOST_XrSession.cc.

◆ ~GHOST_XrSession()

GHOST_XrSession::~GHOST_XrSession ( )

Definition at line 73 of file GHOST_XrSession.cc.

References CHECK_XR_ASSERT, GHOST_XrContext::getCustomFuncs(), GHOST_XrCustomFuncs::session_exit_customdata, GHOST_XrCustomFuncs::session_exit_fn, and unbindGraphicsContext().

Member Function Documentation

◆ applyHapticAction()

bool GHOST_XrSession::applyHapticAction	(	const char *	action_set_name,
		const char *	action_name,
		const char *	subaction_path,
		const int64_t &	duration,
		const float &	frequency,
		const float &	amplitude )

Definition at line 849 of file GHOST_XrSession.cc.

References GHOST_XrAction::applyHapticFeedback(), find_action_set(), and GHOST_XrActionSet::findAction().

◆ attachActionSets()

bool GHOST_XrSession::attachActionSets ( )

Definition at line 753 of file GHOST_XrSession.cc.

References CHECK_XR, and GHOST_XrContext::getInstance().

◆ createActionBindings()

bool GHOST_XrSession::createActionBindings	(	const char *	action_set_name,
		uint32_t	count,
		const GHOST_XrActionProfileInfo *	infos )

Definition at line 707 of file GHOST_XrSession.cc.

References count, GHOST_XrAction::createBinding(), find_action_set(), GHOST_XrActionSet::findAction(), and GHOST_XrContext::getInstance().

◆ createActions()

bool GHOST_XrSession::createActions	(	const char *	action_set_name,
		uint32_t	count,
		const GHOST_XrActionInfo *	infos )

Definition at line 673 of file GHOST_XrSession.cc.

References count, GHOST_XrActionSet::createAction(), find_action_set(), and GHOST_XrContext::getInstance().

◆ createActionSet()

bool GHOST_XrSession::createActionSet ( const GHOST_XrActionSetInfo & info )

Action functions to be called pre-session start. NOTE: The "destroy" functions can also be called post-session start.

Definition at line 651 of file GHOST_XrSession.cc.

References GHOST_XrContext::getInstance().

◆ destroyActionBindings()

void GHOST_XrSession::destroyActionBindings	(	const char *	action_set_name,
		uint32_t	count,
		const char const	action_names,
		const char const	profile_paths )

Definition at line 733 of file GHOST_XrSession.cc.

References count, GHOST_XrAction::destroyBinding(), find_action_set(), and GHOST_XrActionSet::findAction().

◆ destroyActions()

void GHOST_XrSession::destroyActions	(	const char *	action_set_name,
		uint32_t	count,
		const char const	action_names )

Definition at line 693 of file GHOST_XrSession.cc.

References count, GHOST_XrActionSet::destroyAction(), and find_action_set().

◆ destroyActionSet()

void GHOST_XrSession::destroyActionSet ( const char * action_set_name )

Definition at line 666 of file GHOST_XrSession.cc.

◆ draw()

void GHOST_XrSession::draw ( void * draw_customdata )

Definition at line 454 of file GHOST_XrSession.cc.

References GHOST_XrCustomFuncs::disable_passthrough_fn, GHOST_XrContext::getCustomFuncs(), and GHOST_XrCustomFuncs::passthrough_enabled_fn.

◆ getActionCount()

uint32_t GHOST_XrSession::getActionCount ( const char * action_set_name )

Definition at line 914 of file GHOST_XrSession.cc.

References find_action_set(), and GHOST_XrActionSet::getActionCount().

◆ getActionCustomdata()

void * GHOST_XrSession::getActionCustomdata	(	const char *	action_set_name,
		const char *	action_name )

Definition at line 899 of file GHOST_XrSession.cc.

References find_action_set(), GHOST_XrActionSet::findAction(), and GHOST_XrAction::getCustomdata().

◆ getActionCustomdataArray()

void GHOST_XrSession::getActionCustomdataArray	(	const char *	action_set_name,
		void **	r_customdata_array )

Definition at line 924 of file GHOST_XrSession.cc.

References find_action_set(), and GHOST_XrActionSet::getActionCustomdataArray().

◆ getActionSetCustomdata()

void * GHOST_XrSession::getActionSetCustomdata ( const char * action_set_name )

Definition at line 889 of file GHOST_XrSession.cc.

References find_action_set(), and GHOST_XrActionSet::getCustomdata().

◆ getControllerModelData()

bool GHOST_XrSession::getControllerModelData	(	const char *	subaction_path,
		GHOST_XrControllerModelData &	r_data )

Definition at line 988 of file GHOST_XrSession.cc.

◆ handleStateChangeEvent()

GHOST_XrSession::LifeExpectancy GHOST_XrSession::handleStateChangeEvent ( const XrEventDataSessionStateChanged & lifecycle )

Definition at line 282 of file GHOST_XrSession.cc.

References SESSION_DESTROY, and SESSION_KEEP_ALIVE.

◆ isRunning()

bool GHOST_XrSession::isRunning ( ) const

Definition at line 591 of file GHOST_XrSession.cc.

◆ loadControllerModel()

bool GHOST_XrSession::loadControllerModel ( const char * subaction_path )

Controller model functions.

Definition at line 942 of file GHOST_XrSession.cc.

References GHOST_XrContext::getInstance(), and GHOST_XrContext::isExtensionEnabled().

◆ needsUpsideDownDrawing()

bool GHOST_XrSession::needsUpsideDownDrawing ( ) const

Definition at line 580 of file GHOST_XrSession.cc.

◆ requestEnd()

void GHOST_XrSession::requestEnd ( )

Definition at line 264 of file GHOST_XrSession.cc.

◆ start()

void GHOST_XrSession::start ( const GHOST_XrSessionBeginInfo * begin_info )

Definition at line 212 of file GHOST_XrSession.cc.

References CHECK_XR, create_reference_spaces(), GHOST_XrContext::getCustomFuncs(), GHOST_XrContext::getGraphicsBindingType(), GHOST_XrContext::getInstance(), GHOST_XrGraphicsBindingCreateFromType(), GHOST_XrCustomFuncs::gpu_ctx_bind_fn, GHOST_XrContext::isDebugMode(), and GHOST_XrCustomFuncs::session_create_fn.

◆ stopHapticAction()

void GHOST_XrSession::stopHapticAction	(	const char *	action_set_name,
		const char *	action_name,
		const char *	subaction_path )

Definition at line 872 of file GHOST_XrSession.cc.

References find_action_set(), GHOST_XrActionSet::findAction(), and GHOST_XrAction::stopHapticFeedback().

◆ syncActions()

bool GHOST_XrSession::syncActions ( const char * action_set_name = nullptr )

Action functions to be called post-session start.

Parameters

action_set_name When nullptr, all attached action sets will be synced.

Definition at line 796 of file GHOST_XrSession.cc.

References CHECK_XR, find_action_set(), GHOST_XrActionSet::getActionSet(), and GHOST_XrActionSet::updateStates().

◆ unbindGraphicsContext()

void GHOST_XrSession::unbindGraphicsContext ( )

Definition at line 626 of file GHOST_XrSession.cc.

References GHOST_XrContext::getCustomFuncs(), and GHOST_XrCustomFuncs::gpu_ctx_unbind_fn.

Referenced by ~GHOST_XrSession().

◆ unloadControllerModel()

void GHOST_XrSession::unloadControllerModel ( const char * subaction_path )

Definition at line 967 of file GHOST_XrSession.cc.

◆ updateControllerModelComponents()

bool GHOST_XrSession::updateControllerModelComponents ( const char * subaction_path )

Definition at line 974 of file GHOST_XrSession.cc.

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

Public Types

Public Member Functions

Create, Initialize and Destruct

State Management

Drawing

Graphics Context Injection