Blender V5.3
GHOST_Xr-api.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2025 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
10
11#pragma once
12
13#include "GHOST_IXrContext.hh"
14#include "GHOST_Types.hh"
15
16/* XR-context */
17
25void GHOST_XrErrorHandler(GHOST_XrErrorHandlerFn handler_fn, void *customdata);
26
36GHOST_IXrContext *GHOST_XrContextCreate(const GHOST_XrContextCreateInfo *create_info);
41
51 GHOST_XrGraphicsContextBindFn bind_fn,
52 GHOST_XrGraphicsContextUnbindFn unbind_fn);
53
61void GHOST_XrDrawViewFunc(GHOST_IXrContext *xr_context, GHOST_XrDrawViewFn draw_view_fn);
62
70 GHOST_XrPassthroughEnabledFn passthrough_enabled_fn);
71
79 GHOST_XrDisablePassthroughFn disable_passthrough_fn);
80
81/* sessions */
88 const GHOST_XrSessionBeginInfo *begin_info);
92void GHOST_XrSessionEnd(GHOST_IXrContext *xr_context);
99void GHOST_XrSessionDrawViews(GHOST_IXrContext *xr_context, void *customdata);
105int GHOST_XrSessionIsRunning(const GHOST_IXrContext *xr_context);
106
113
114/* events */
122
123/* actions */
127int GHOST_XrCreateActionSet(GHOST_IXrContext *xr_context, const GHOST_XrActionSetInfo *info);
128
132void GHOST_XrDestroyActionSet(GHOST_IXrContext *xr_context, const char *action_set_name);
133
138 const char *action_set_name,
139 uint32_t count,
140 const GHOST_XrActionInfo *infos);
141
146 const char *action_set_name,
147 uint32_t count,
148 const char *const *action_names);
149
154 const char *action_set_name,
155 uint32_t count,
156 const GHOST_XrActionProfileInfo *infos);
157
162 const char *action_set_name,
163 uint32_t count,
164 const char *const *action_names,
165 const char *const *profile_paths);
166
171
178int GHOST_XrSyncActions(GHOST_IXrContext *xr_context, const char *action_set_name);
179
183int GHOST_XrApplyHapticAction(GHOST_IXrContext *xr_context_handle,
184 const char *action_set_name,
185 const char *action_name,
186 const char *subaction_path,
187 const int64_t *duration,
188 const float *frequency,
189 const float *amplitude);
190
194void GHOST_XrStopHapticAction(GHOST_IXrContext *xr_context_handle,
195 const char *action_set_name,
196 const char *action_name,
197 const char *subaction_path);
198
202void *GHOST_XrGetActionSetCustomdata(GHOST_IXrContext *xr_context, const char *action_set_name);
203
208 const char *action_set_name,
209 const char *action_name);
210
214unsigned int GHOST_XrGetActionCount(GHOST_IXrContext *xr_context, const char *action_set_name);
215
220 const char *action_set_name,
221 void **r_customdata_array);
222
223/* controller model */
227int GHOST_XrLoadControllerModel(GHOST_IXrContext *xr_context, const char *subaction_path);
228
232void GHOST_XrUnloadControllerModel(GHOST_IXrContext *xr_context, const char *subaction_path);
233
238 const char *subaction_path);
239
244 const char *subaction_path,
245 GHOST_XrControllerModelData *r_data);
GHOST_TSuccess
void GHOST_XrDestroyActionSet(GHOST_IXrContext *xr_context, const char *action_set_name)
Definition GHOST_Xr.cc:121
int GHOST_XrCreateActions(GHOST_IXrContext *xr_context, const char *action_set_name, uint32_t count, const GHOST_XrActionInfo *infos)
Definition GHOST_Xr.cc:127
void GHOST_XrDestroyActions(GHOST_IXrContext *xr_context, const char *action_set_name, uint32_t count, const char *const *action_names)
Definition GHOST_Xr.cc:137
int GHOST_XrLoadControllerModel(GHOST_IXrContext *xr_context, const char *subaction_path)
Definition GHOST_Xr.cc:242
void GHOST_XrContextDestroy(GHOST_IXrContext *xr_context)
Definition GHOST_Xr.cc:58
void GHOST_XrPassthroughEnabledFunc(GHOST_IXrContext *xr_context, GHOST_XrPassthroughEnabledFn passthrough_enabled_fn)
Definition GHOST_Xr.cc:96
unsigned int GHOST_XrGetActionCount(GHOST_IXrContext *xr_context, const char *action_set_name)
Definition GHOST_Xr.cc:226
GHOST_IXrContext * GHOST_XrContextCreate(const GHOST_XrContextCreateInfo *create_info)
Initialize the Ghost XR-context.
Definition GHOST_Xr.cc:40
int GHOST_XrCreateActionSet(GHOST_IXrContext *xr_context, const GHOST_XrActionSetInfo *info)
Definition GHOST_Xr.cc:114
GHOST_TSuccess GHOST_XrEventsHandle(GHOST_IXrContext *xr_context)
int GHOST_XrGetControllerModelData(GHOST_IXrContext *xr_context, const char *subaction_path, GHOST_XrControllerModelData *r_data)
Definition GHOST_Xr.cc:263
int GHOST_XrSyncActions(GHOST_IXrContext *xr_context, const char *action_set_name)
Definition GHOST_Xr.cc:176
void GHOST_XrSessionEnd(GHOST_IXrContext *xr_context)
Definition GHOST_Xr.cc:68
int GHOST_XrSessionNeedsUpsideDownDrawing(const GHOST_IXrContext *xr_context)
Definition GHOST_Xr.cc:108
void GHOST_XrGetActionCustomdataArray(GHOST_IXrContext *xr_context, const char *action_set_name, void **r_customdata_array)
Definition GHOST_Xr.cc:233
void GHOST_XrSessionStart(GHOST_IXrContext *xr_context, const GHOST_XrSessionBeginInfo *begin_info)
Definition GHOST_Xr.cc:63
void * GHOST_XrGetActionCustomdata(GHOST_IXrContext *xr_context, const char *action_set_name, const char *action_name)
Definition GHOST_Xr.cc:216
int GHOST_XrSessionIsRunning(const GHOST_IXrContext *xr_context)
Definition GHOST_Xr.cc:78
int GHOST_XrCreateActionBindings(GHOST_IXrContext *xr_context, const char *action_set_name, uint32_t count, const GHOST_XrActionProfileInfo *infos)
Definition GHOST_Xr.cc:146
void GHOST_XrDisablePassthroughFunc(GHOST_IXrContext *xr_context, GHOST_XrDisablePassthroughFn disable_passthrough_fn)
Definition GHOST_Xr.cc:102
void GHOST_XrStopHapticAction(GHOST_IXrContext *xr_context_handle, const char *action_set_name, const char *action_name, const char *subaction_path)
Definition GHOST_Xr.cc:199
void * GHOST_XrGetActionSetCustomdata(GHOST_IXrContext *xr_context, const char *action_set_name)
Definition GHOST_Xr.cc:209
int GHOST_XrAttachActionSets(GHOST_IXrContext *xr_context)
Definition GHOST_Xr.cc:169
void GHOST_XrErrorHandler(GHOST_XrErrorHandlerFn handler_fn, void *customdata)
Definition GHOST_Xr.cc:35
int GHOST_XrUpdateControllerModelComponents(GHOST_IXrContext *xr_context, const char *subaction_path)
Definition GHOST_Xr.cc:255
void GHOST_XrGraphicsContextBindFuncs(GHOST_IXrContext *xr_context, GHOST_XrGraphicsContextBindFn bind_fn, GHOST_XrGraphicsContextUnbindFn unbind_fn)
Definition GHOST_Xr.cc:84
void GHOST_XrUnloadControllerModel(GHOST_IXrContext *xr_context, const char *subaction_path)
Definition GHOST_Xr.cc:249
void GHOST_XrDrawViewFunc(GHOST_IXrContext *xr_context, GHOST_XrDrawViewFn draw_view_fn)
Definition GHOST_Xr.cc:91
void GHOST_XrDestroyActionBindings(GHOST_IXrContext *xr_context, const char *action_set_name, uint32_t count, const char *const *action_names, const char *const *profile_paths)
Definition GHOST_Xr.cc:157
void GHOST_XrSessionDrawViews(GHOST_IXrContext *xr_context, void *customdata)
Definition GHOST_Xr.cc:73
int GHOST_XrApplyHapticAction(GHOST_IXrContext *xr_context_handle, const char *action_set_name, const char *action_name, const char *subaction_path, const int64_t *duration, const float *frequency, const float *amplitude)
Definition GHOST_Xr.cc:183
long long int int64_t
#define frequency(freq)