-
Notifications
You must be signed in to change notification settings - Fork 9
API Naming Conventions
Christopher Bruns edited this page Aug 18, 2021
·
7 revisions
Many types, symbols, functions, and parameters are named differently in pyopenxr, compared to the C API.
For example, an intial "Xr" or "XR_" prefix is stripped off of the C API symbol, because in the python API, these symbols are in the "xr" module.
An exception is string values, which are the same in the python and C APIs. Both input string parameters and string result parameters are the same.
| symbol | Python example | C example |
|---|---|---|
| function | xr.create_instance(...) |
xrCreateInstance(...) |
| constant | xr.MAX_SYSTEM_NAME_SIZE |
XR_MAX_SYSTEM_NAME_SIZE |
| struct name | xr.ExtensionProperties |
XrExtensionProperties |
| type alias | xr.Version |
XrVersion |
| enum type | xr.FormFactor |
xrFormFactor |
| enum value | xr.FormFactor.HEAD_MOUNTED_DISPLAY |
XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY |