stereokit-rust 0.4.0-alpha.22

use crate::{
    StereoKitError,
    anchor::{_AnchorT, Anchor},
    font::{_FontT, Font, FontT},
    material::{_MaterialT, Material, MaterialBuffer, MaterialBufferT, MaterialT},
    maths::{Bool32T, Matrix, Pose, Quat, Ray, Rect, Vec2, Vec3, ray_from_mouse},
    mesh::{_MeshT, Mesh, MeshT},
    model::{_ModelT, Model, ModelT},
    render_list::{_RenderListT, RenderList},
    shader::{_ShaderT, Shader, ShaderT},
    sk::{MainThreadToken, OriginMode},
    sound::{_SoundT, Sound, SoundT},
    sprite::{_SpriteT, Sprite},
    tex::{_TexT, Tex, TexFormat, TexT},
    util::{Color32, Color128, SphericalHarmonics},
};
use std::{
    ffi::{CStr, CString, c_char, c_ushort, c_void},
    fmt,
    mem::{size_of, transmute_copy},
    path::Path,
    ptr::{NonNull, null, null_mut},
};

// Re-export interactor types for convenient access
pub use crate::interactor::{
    DefaultInteractors, Interaction, Interactor, InteractorActivation, InteractorEvent, InteractorType,
};

/// All StereoKit assets implement this interface! This is mostly to help group and hold Asset objects, and is
/// particularly useful when working with Assets at a high level with the Assets class.
/// <https://stereokit.net/Pages/StereoKit/IAsset.html>
pub trait IAsset {
    // sets the unique identifier of this asset resource! This can be helpful for debugging, managing your assets, or
    // finding them later on!
    // <https://stereokit.net/Pages/StereoKit/IAsset/Id.html>
    //fn id(&mut self, id: impl AsRef<str>);

    /// gets the unique identifier of this asset resource! This can be helpful for debugging, managing your assets, or
    /// finding them later on!
    /// <https://stereokit.net/Pages/StereoKit/IAsset/Id.html>
    fn get_id(&self) -> &str;
}

/// StereoKit uses an asynchronous loading system to prevent assets from blocking execution! This means that asset
/// loading systems will return an asset to you right away, even though it is still being processed in the background.
/// <https://stereokit.net/Pages/StereoKit/AssetState.html>
///
/// see also: [`Tex::get_asset_state`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(C)]
pub enum AssetState {
    /// This asset encountered an issue when parsing the source data. Either the format is unrecognized by StereoKit,
    /// or the data may be corrupt. Check the logs for additional details.
    Unsupported = -3,
    /// The asset data was not found! This is most likely an issue with a bad file path, or file permissions. Check
    /// the logs for additional details.
    NotFound = -2,
    /// An unknown error occurred when trying to load the asset! Check the logs for additional details.
    Error = -1,
    /// This asset is in its default state. It has not been told to load anything, nor does it have any data!
    None = 0,
    /// This asset is currently queued for loading, but hasn’t received any data yet. Attempting to access metadata or
    /// asset data will result in blocking the app’s execution until that data is loaded!
    Loading = 1,
    /// This asset is still loading, but some of the higher level data is already available for inspection without
    /// blocking the app. Attempting to access the core asset data will result in blocking the app’s execution until
    /// that data is loaded!
    LoadedMeta = 2,
    /// This asset is completely loaded without issues, and is ready for use!
    Loaded = 3,
}

/// A flag for what ‘type’ an Asset may store.
///
/// None -> No type, this may come from some kind of invalid Asset id.
/// <https://stereokit.net/Pages/StereoKit/AssetType.html>
///
/// see also [`Assets`] [`Asset`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum AssetType {
    None = 0,
    Mesh = 1,
    Tex = 2,
    Shader = 3,
    Material = 4,
    Model = 5,
    Font = 6,
    Sprite = 7,
    Sound = 8,
    Solid = 9,
    Anchor = 10,
    RenderList = 11,
}

/// If you want to manage loading assets, this is the class for you!
///  <https://stereokit.net/Pages/StereoKit/Assets.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{maths::Matrix, system::{Assets, AssetType, Asset, Pivot},
///                      sprite::Sprite};
///
/// let my_sprite = Sprite::from_file("textures/open_gltf.jpeg", None, None)
///                   .expect("open_gltf.jpeg should be able to create sprite");
///
/// for asset in Assets::all().filter(|s| !s.to_string().contains(" default/")) {
///     if let Asset::Sprite(sprite) = asset {
///         if !sprite.get_id().starts_with("sk/ui/") {
///             assert_eq!(sprite, my_sprite);
///         }
///     }
/// }
///
/// for asset in Assets::all_of_type(AssetType::Sprite) {
///     if let Asset::Sprite(sprite) = asset {
///         if !sprite.get_id().starts_with("sk/ui/") {
///             assert_eq!(sprite, my_sprite);
///         }
///     } else {
///         panic!("asset should be a sprite");
///     }
/// }
///
/// filename_scr = "screenshots/assets.jpeg"; fov_scr= 55.0;
/// test_screenshot!( // !!!! Get a proper main loop !!!!
///     my_sprite.draw(token, Matrix::Y_180, Pivot::Center, None);
/// );
/// ```
/// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/assets.jpeg" alt="screenshot" width="200">
pub struct Assets;

pub type AssetT = *mut c_void;

unsafe extern "C" {
    pub fn assets_releaseref_threadsafe(asset: *mut c_void);
    pub fn assets_current_task() -> i32;
    pub fn assets_total_tasks() -> i32;
    pub fn assets_current_task_priority() -> i32;
    pub fn assets_block_for_priority(priority: i32);
    pub fn assets_count() -> i32;
    pub fn assets_get_index(index: i32) -> AssetT;
    pub fn assets_get_type(index: i32) -> AssetType;
    pub fn asset_get_type(asset: AssetT) -> AssetType;
    pub fn asset_set_id(asset: AssetT, id: *const c_char);
    pub fn asset_get_id(asset: AssetT) -> *const c_char;
    pub fn asset_addref(asset: AssetT);
    pub fn asset_release(asset: AssetT);
}

/// Non-canonical structure to store an asset and avoid reducer `Box<dyn Asset>`
///
/// see also [`AssetType`] [`Assets`]
#[derive(Debug)]
pub enum Asset {
    None,
    Mesh(Mesh),
    Tex(Tex),
    Shader(Shader),
    Material(Material),
    Model(Model),
    Font(Font),
    Sprite(Sprite),
    Sound(Sound),
    Solid(*mut c_void),
    Anchor(Anchor),
    RenderList(RenderList),
}

impl fmt::Display for Asset {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Asset::None => write!(f, "None"),
            Asset::Mesh(v) => write!(f, "Mesh : {}", v.get_id()),
            Asset::Tex(v) => write!(f, "Tex : {}", v.get_id()),
            Asset::Shader(v) => write!(f, "Shader : {}", v.get_id()),
            Asset::Material(v) => write!(f, "Material : {}", v.get_id()),
            Asset::Model(v) => write!(f, "Model : {}", v.get_id()),
            Asset::Font(v) => write!(f, "Font : {}", v.get_id()),
            Asset::Sprite(v) => write!(f, "Sprite : {}", v.get_id()),
            Asset::Sound(v) => write!(f, "Sound : {}", v.get_id()),
            Asset::Solid(_) => write!(f, "Solid : ... deprecated ..."),
            Asset::Anchor(v) => write!(f, "Anchor : {}", v.get_id()),
            Asset::RenderList(v) => write!(f, "RenderList : {}", v.get_id()),
        }
    }
}

/// Iterator on [`Assets`] producing some [`Asset`]
///
/// see also [`Assets::all`] [`Assets::all_of_type`]
#[derive(Debug, Copy, Clone)]
pub struct AssetIter {
    index: i32,
    pub asset_type: AssetType,
}

impl Iterator for AssetIter {
    type Item = Asset;

    fn next(&mut self) -> Option<Self::Item> {
        self.index += 1;
        let count = unsafe { assets_count() };
        if self.asset_type == AssetType::None {
            if self.index < count {
                match unsafe { assets_get_type(self.index) } {
                    AssetType::None => {
                        Log::err(format!("Asset at index {:?}/{:?} is AssetType::None", self.index, count));
                        None
                    }
                    asset_type => {
                        let asset_id = unsafe { assets_get_index(self.index) };
                        Some(self.to_asset(asset_type, asset_id))
                    }
                }
            } else {
                None
            }
        } else {
            while self.index < count {
                if unsafe { assets_get_type(self.index) } == self.asset_type {
                    let asset_id = unsafe { assets_get_index(self.index) };
                    return Some(self.to_asset(self.asset_type, asset_id));
                } else {
                    self.index += 1;
                }
            }
            None
        }
    }
}

impl AssetIter {
    /// Get the asset
    fn to_asset(self, asset_type: AssetType, c_id: *mut c_void) -> Asset {
        match asset_type {
            AssetType::None => Asset::None,
            AssetType::Mesh => Asset::Mesh(Mesh(NonNull::new(c_id as *mut _MeshT).unwrap())),
            AssetType::Tex => Asset::Tex(Tex(NonNull::new(c_id as *mut _TexT).unwrap())),
            AssetType::Shader => Asset::Shader(Shader(NonNull::new(c_id as *mut _ShaderT).unwrap())),
            AssetType::Material => Asset::Material(Material(NonNull::new(c_id as *mut _MaterialT).unwrap())),
            AssetType::Model => Asset::Model(Model(NonNull::new(c_id as *mut _ModelT).unwrap())),
            AssetType::Font => Asset::Font(Font(NonNull::new(c_id as *mut _FontT).unwrap())),
            AssetType::Sprite => Asset::Sprite(Sprite(NonNull::new(c_id as *mut _SpriteT).unwrap())),
            AssetType::Sound => Asset::Sound(Sound(NonNull::new(c_id as *mut _SoundT).unwrap())),
            AssetType::Solid => todo!("Solids are deprecated!"),
            AssetType::Anchor => Asset::Anchor(Anchor(NonNull::new(c_id as *mut _AnchorT).unwrap())),
            AssetType::RenderList => Asset::RenderList(RenderList(NonNull::new(c_id as *mut _RenderListT).unwrap())),
        }
    }

    /// Get an iterator upon all assets loaded if asset_type is None or only assets of the given AssetType
    /// <https://stereokit.net/Pages/StereoKit/Assets.html>
    pub fn iterate(asset_type: Option<AssetType>) -> AssetIter {
        let asset_type = asset_type.unwrap_or(AssetType::None);
        AssetIter { index: -1, asset_type }
    }
}

impl Assets {
    /// A list of supported model format extensions. This pairs pretty well with Platform::file_picker when attempting to
    /// load a Model!
    /// <https://stereokit.net/Pages/StereoKit/Assets/ModelFormats.html>
    pub const MODEL_FORMATS: [&'static str; 5] = [".gltf", ".glb", ".obj", ".stl", ".ply"];

    /// A list of supported texture format extensions. This pairs pretty well with Platform::file_picker when attempting
    /// to load a Tex!
    /// <https://stereokit.net/Pages/StereoKit/Assets/TextureFormats.html>
    pub const TEXTURE_FORMATS: [&'static str; 11] =
        [".jpg", ".jpeg", ".png", ".hdr", ".tga", ".bmp", ".psd", ".pic", ".qoi", ".gif", ".ktx2"];

    /// supported sound format by asset Sound <https://stereokit.net/Pages/StereoKit/Sound.html>
    pub const SOUND_FORMATS: [&'static str; 2] = [".wav", ".mp3"];

    /// This is an iterator upon all assets loaded by StereoKit at the current moment.
    /// <https://stereokit.net/Pages/StereoKit/Assets/All.html>
    ///
    /// see also [`AssetIter`] [`Asset`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::Matrix,  system::{Assets, AssetType, Asset},
    ///                      sprite::Sprite};
    ///
    /// let my_sprite = Sprite::from_file("textures/open_gltf.jpeg", None, None)
    ///                   .expect("open_gltf.jpeg should be able to create sprite");
    ///
    /// let all = Assets::all();
    ///
    /// let mut sprite_count = 0    ; let mut texture_count = 0;
    /// let mut model_count = 0     ; let mut sound_count = 0;
    /// let mut material_count = 0  ; let mut shader_count = 0;
    /// let mut font_count = 0      ; let mut other_count = 0;
    /// let mut mesh_count = 0      ; let mut render_list_count = 0;
    /// for asset in all {
    ///     match asset {
    ///         Asset::Sprite(sprite) => sprite_count += 1,
    ///         Asset::Model(model) => model_count +=1,
    ///         Asset::Sound(sound) => sound_count +=1,
    ///         Asset::Tex(texture) => texture_count +=1,
    ///         Asset::Material(material) => material_count +=1,
    ///         Asset::Font(font) => font_count +=1,
    ///         Asset::Mesh(mesh) => mesh_count +=1,
    ///         Asset::Shader(shader) => shader_count +=1,
    ///         Asset::RenderList(render_list) => render_list_count +=1,
    ///     _  => other_count +=1,  
    ///
    ///     }
    /// }
    /// assert_eq!(sprite_count,    13 + 1 );
    /// assert_eq!(texture_count,   23 + 1 );
    /// assert_eq!(model_count,     2);
    /// assert_eq!(sound_count,     5);
    /// assert_eq!(material_count,  37 + 1 );
    /// assert_eq!(shader_count,    15);
    /// assert_eq!(font_count,      1);
    /// assert_eq!(mesh_count,  26);
    /// assert_eq!(render_list_count, 1);
    /// assert_eq!(other_count, 0);
    /// ```
    pub fn all() -> AssetIter {
        AssetIter::iterate(None)
    }

    /// This is an iterator upon all assets matching the specified type.
    /// <https://stereokit.net/Pages/StereoKit/Assets/Type.html>
    /// * `asset_type` - Any [`IAsset`] type
    ///
    /// see also [`AssetIter`] [`Asset`] [`IAsset`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Assets, AssetType, Asset},
    ///                      sprite::Sprite};
    ///
    /// let my_sprite = Sprite::from_file("textures/open_gltf.jpeg", None, None)
    ///                   .expect("open_gltf.jpeg should be able to create sprite");
    ///
    /// let all = Assets::all_of_type(AssetType::Sprite);
    ///
    /// let mut sprite_count = 0;
    /// for asset in all {
    ///     match asset {
    ///         Asset::Sprite(sprite) => sprite_count += 1,
    ///         _ => panic!("asset should be a sprite"),
    ///     }
    /// }
    /// assert_eq!(sprite_count, 13 + 1);
    /// ```
    pub fn all_of_type(asset_type: AssetType) -> AssetIter {
        AssetIter::iterate(Some(asset_type))
    }

    /// This is the index of the current asset loading task. Note that to load one asset, multiple tasks are generated.
    /// <https://stereokit.net/Pages/StereoKit/Assets/CurrentTask.html>
    ///
    /// see also [`assets_current_task`] [`Assets::total_tasks`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Assets, sprite::Sprite};
    /// let my_sprite = Sprite::from_file("textures/open_gltf.jpeg", None, None)
    ///                   .expect("open_gltf.jpeg should be able to create sprite");
    ///
    /// let current_task = Assets::current_task();
    /// // TODO: most of the time true but ... assert_eq!(Assets::total_tasks(), 1);
    /// number_of_steps = 200;
    /// assert_eq!(current_task, 0);
    /// ```
    pub fn current_task() -> i32 {
        unsafe { assets_current_task() }
    }

    /// StereoKit processes tasks in order of priority. This returns the priority of the current task, and can be used
    /// to wait until all tasks within a certain priority range have been completed.
    /// <https://stereokit.net/Pages/StereoKit/Assets/CurrentTaskPriority.html>
    ///
    /// see also [`assets_current_task_priority`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Assets, sprite::Sprite};
    ///
    /// let my_sprite = Sprite::from_file("textures/open_gltf.jpeg", None, None)
    ///                   .expect("open_gltf.jpeg should be able to create sprite");
    ///
    /// let current_task_priority  = Assets::current_task_priority();
    /// assert_eq!(current_task_priority, 10);
    /// ```
    pub fn current_task_priority() -> i32 {
        unsafe { assets_current_task_priority() }
    }

    /// This is the total number of tasks that have been added to the loading system, including all completed and
    /// pending tasks. Note that to load one asset, multiple tasks are generated.
    /// <https://stereokit.net/Pages/StereoKit/Assets/TotalTasks.html>
    ///
    /// see also [`assets_total_tasks`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Assets, sprite::Sprite};
    ///
    /// let my_sprite1 = Sprite::from_file("textures/open_gltf.jpeg", None, None)
    ///                   .expect("open_gltf.jpeg should be able to create sprite");
    ///
    /// let my_sprite2 = Sprite::from_file("textures/log_viewer.jpeg", None, None)
    ///                   .expect("log_viewer.jpeg should be able to create sprite");
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     let total_tasks  = Assets::total_tasks();
    ///     assert_eq!(total_tasks, 2);
    /// );
    /// ```
    pub fn total_tasks() -> i32 {
        unsafe { assets_total_tasks() }
    }

    /// This will block the execution of the application until all asset tasks below the priority value have completed
    /// loading. To block until all assets are loaded, pass in i32::MAX for the priority.
    /// <https://stereokit.net/Pages/StereoKit/Assets/BlockForPriority.html>
    ///
    /// see also [`assets_block_for_priority`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Vec3, Matrix},  system::{Assets, AssetState}, tex::Tex,
    ///                      material::Material, mesh::Mesh, model::Model, util::named_colors};
    ///
    /// // The model is loaded asynchronously, so we need to wait for it to be loaded before we can screenshot it.
    /// let model = Model::from_file("cuve.glb", None)
    ///                 .expect("mobiles.gltf should be a valid model");
    /// let transform = Matrix::t_r_s([0.15, -0.75, -1.0], [0.0, 110.0, 0.0], [0.4, 0.4, 0.4]);
    ///
    /// Assets::block_for_priority(i32::MAX);
    ///
    /// filename_scr = "screenshots/assets_block_for_priority.jpeg";
    /// test_screenshot!( // !!!! Get a proper main loop !!!!
    ///     model.draw(token, transform, Some(named_colors::MISTY_ROSE.into()), None);
    /// );
    /// ```
    /// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/assets_block_for_priority.jpeg" alt="screenshot" width="200">
    pub fn block_for_priority(priority: i32) {
        unsafe { assets_block_for_priority(priority) }
    }
}

/// This describes what technology is being used to power StereoKit’s XR backend.
/// <https://stereokit.net/Pages/StereoKit/BackendXRType.html>
///
/// see also [`Backend::xr_type`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum BackendXRType {
    /// StereoKit is not using an XR backend of any sort. That means the application is flatscreen and has the simulator
    /// disabled.
    None = 0,
    /// StereoKit is using the flatscreen XR simulator. Inputs are emulated, and some advanced XR functionality may not
    /// be available.
    Simulator = 1,
    /// StereoKit is currently powered by OpenXR! This means we’re running on a real XR device. Not all OpenXR runtimes
    /// provide the same functionality, but we will have access to more fun stuff :)
    OpenXR = 2,
    /// StereoKit is running in a browser, and is using WebXR!
    WebXR = 3,
}

/// This describes the platform that StereoKit is running on.
/// <https://stereokit.net/Pages/StereoKit/BackendPlatform.html>
///
/// see also [`Backend::platform`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum BackendPlatform {
    /// This is running as a Windows app using the Win32 APIs.
    Win32 = 0,
    /// This is running as a Windows app using the UWP APIs.
    Uwp = 1,
    /// This is running as a Linux app.
    Linux = 2,
    /// This is running as an Android app.
    Android = 3,
    /// This is running in a browser.
    Web = 4,
}

/// This describes the graphics API thatStereoKit is using for rendering.
/// <https://stereokit.net/Pages/StereoKit/BackendGraphics.html>
///
/// see also [`Backend::graphics`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum BackendGraphics {
    /// An invalid default value.
    None = 0,
    /// DirectX’s Direct3D11 is used for rendering! This is used by default on Windows.
    D3D11 = 1,
    /// OpenGL is used for rendering, using GLX (OpenGL Extension to the X Window System) for loading. This is used by
    /// default on Linux.
    OpenGLGLX = 2,
    /// OpenGL is used for rendering, using WGL (Windows Extensions to OpenGL) for loading. Native developers can
    /// configure SK to use this on Windows.
    OpenGLWGL = 3,
    /// OpenGL ES is used for rendering, using EGL (EGL Native Platform Graphics Interface) for loading. This is used by
    /// default on Android, and native developers can configure SK to use this on Linux.
    OpenGLESEGL = 4,
    /// WebGL is used for rendering. This is used by default on Web.
    WebGL = 5,
}

/// XrInstance type
pub type OpenXRHandleT = u64;

/// This class exposes some of StereoKit’s backend functionality. This allows for tighter integration with certain
/// platforms, but also means your code becomes less portable. Everything in this class should be guarded by
/// availability checks.
///  
/// <https://stereokit.net/Pages/StereoKit/Backend.html>
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::system::{Backend, BackendGraphics, BackendPlatform, BackendXRType, BackendOpenXR};
///
/// let graphics = Backend::graphics();
/// let platform = Backend::platform();
/// let xr_type = Backend::xr_type();
///
/// if cfg!(target_os = "windows") {
///     assert_eq!(graphics, BackendGraphics::D3D11);
///     assert_eq!(platform, BackendPlatform::Win32);
/// } else {
///     assert_eq!(graphics, BackendGraphics::OpenGLESEGL);
///     assert_eq!(platform, BackendPlatform::Linux);
/// }
/// assert_eq!(BackendOpenXR::eyes_sample_time(), 0);
///
/// xr_mode_stop_here!();
/// // These are the expected results for offscreen tests on a PC:
/// assert_eq!(xr_type, BackendXRType::None);
///
/// ```
pub struct Backend;

pub type VoidFunction = unsafe extern "system" fn();

unsafe extern "C" {
    pub fn backend_xr_get_type() -> BackendXRType;
    pub fn backend_openxr_get_instance() -> OpenXRHandleT;
    pub fn backend_openxr_get_session() -> OpenXRHandleT;
    pub fn backend_openxr_get_system_id() -> OpenXRHandleT;
    pub fn backend_openxr_get_space() -> OpenXRHandleT;
    pub fn backend_openxr_get_time() -> i64;
    pub fn backend_openxr_get_eyes_sample_time() -> i64;
    pub fn backend_openxr_get_function(function_name: *const c_char) -> Option<VoidFunction>;
    pub fn backend_openxr_ext_enabled(extension_name: *const c_char) -> Bool32T;
    pub fn backend_openxr_ext_request(extension_name: *const c_char);
    pub fn backend_openxr_ext_exclude(extension_name: *const c_char);
    pub fn backend_openxr_use_minimum_exts(use_minimum_exts: Bool32T);
    pub fn backend_openxr_composition_layer(XrCompositionLayerBaseHeader: *mut c_void, data_size: i32, sort_order: i32);
    pub fn backend_openxr_end_frame_chain(XrBaseHeader: *mut c_void, data_size: i32);
    pub fn backend_openxr_set_hand_joint_scale(joint_scale_factor: f32);
    pub fn backend_openxr_add_callback_pre_session_create(
        xr_pre_session_create_callback: ::std::option::Option<unsafe extern "C" fn(context: *mut c_void)>,
        context: *mut c_void,
    );
    pub fn backend_openxr_add_callback_poll_event(
        xr_poll_event_callback: ::std::option::Option<
            unsafe extern "C" fn(context: *mut c_void, xr_event_data_buffer: *mut c_void),
        >,
        context: *mut c_void,
    );
    pub fn backend_openxr_remove_callback_poll_event(
        xr_poll_event_callback: ::std::option::Option<
            unsafe extern "C" fn(context: *mut c_void, xr_event_data_buffer: *mut c_void),
        >,
    );
    pub fn backend_platform_get() -> BackendPlatform;
    pub fn backend_android_get_java_vm() -> *mut c_void;
    pub fn backend_android_get_activity() -> *mut c_void;
    pub fn backend_android_get_jni_env() -> *mut c_void;
    pub fn backend_graphics_get() -> BackendGraphics;
    pub fn backend_d3d11_get_d3d_device() -> *mut c_void;
    pub fn backend_d3d11_get_d3d_context() -> *mut c_void;
    pub fn backend_d3d11_get_deferred_d3d_context() -> *mut c_void;
    pub fn backend_d3d11_get_deferred_mtx() -> *mut c_void;
    pub fn backend_d3d11_get_main_thread_id() -> u32;
    pub fn backend_opengl_wgl_get_hdc() -> *mut c_void;
    pub fn backend_opengl_wgl_get_hglrc() -> *mut c_void;
    pub fn backend_opengl_glx_get_context() -> *mut c_void;
    pub fn backend_opengl_glx_get_display() -> *mut c_void;
    pub fn backend_opengl_glx_get_drawable() -> *mut c_void;
    pub fn backend_opengl_egl_get_context() -> *mut c_void;
    pub fn backend_opengl_egl_get_config() -> *mut c_void;
    pub fn backend_opengl_egl_get_display() -> *mut c_void;
}

impl Backend {
    /// This describes the graphics API thatStereoKit is using for rendering. StereoKit uses D3D11 for Windows platforms,
    /// and a flavor of OpenGL for Linux, Android, and Web.
    /// <https://stereokit.net/Pages/StereoKit/Backend/Graphics.html>
    ///
    /// see also [`backend_graphics_get`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Backend, BackendGraphics};
    ///
    /// let graphics = Backend::graphics();
    /// if cfg!(target_os = "windows") {
    ///     assert_eq!(graphics, BackendGraphics::D3D11);
    /// } else {
    ///     assert_eq!(graphics, BackendGraphics::OpenGLESEGL);
    /// }
    /// ```
    pub fn graphics() -> BackendGraphics {
        unsafe { backend_graphics_get() }
    }

    /// What kind of platform is StereoKit running on? This can be important to tell you what APIs or functionality is
    /// available to the app.
    /// <https://stereokit.net/Pages/StereoKit/Backend/Platform.html>
    ///
    /// see also [`backend_platform_get`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Backend, BackendPlatform};
    ///
    /// let platform = Backend::platform();
    /// if cfg!(target_os = "windows") {
    ///     assert_eq!(platform, BackendPlatform::Win32);
    /// } else {
    ///     assert_eq!(platform, BackendPlatform::Linux);
    /// }
    /// ```
    pub fn platform() -> BackendPlatform {
        unsafe { backend_platform_get() }
    }

    /// What technology is being used to drive StereoKit’s XR functionality? OpenXR is the most likely candidate here,
    /// but if you’re running the flatscreen Simulator, or running in the web with WebXR, then this will reflect that.
    /// <https://stereokit.net/Pages/StereoKit/Backend/XRType.html>
    ///
    /// see also [`backend_xr_get_type`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Backend, BackendXRType};
    ///
    /// let xr_type = Backend::xr_type();
    ///
    /// xr_mode_stop_here!();
    /// // These are the expected results for offscreen tests on a PC:
    /// assert_eq!(xr_type, BackendXRType::None);
    /// ```
    pub fn xr_type() -> BackendXRType {
        unsafe { backend_xr_get_type() }
    }
}

/// This class is NOT of general interest, unless you are trying to add support for some unusual OpenXR extension!
/// StereoKit should do all the OpenXR work that most people will need. If you find yourself here anyhow for something
/// you feel StereoKit should support already, please add a feature request on GitHub!
///
/// This class contains handles and methods for working directly with OpenXR. This may allow you to activate or work
/// with OpenXR extensions that StereoKit hasn’t implemented or exposed yet. Check that Backend.XRType is OpenXR before
/// using any of this.
///
/// These properties may best be used with some external OpenXR binding library, but you may get some limited mileage
/// with the API as provided here.
/// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR.html>
///
/// see implementations in [`crate::tools::xr_fb_passthrough`] [`crate::tools::os_api`]
/// ### Examples
/// ```
/// use stereokit_rust::system::{Backend, BackendOpenXR, BackendXRType};
///
/// // This must be set before initializing StereoKit.
/// BackendOpenXR::use_minimum_exts(false);
/// BackendOpenXR::exclude_ext("XR_EXT_hand_tracking");
/// BackendOpenXR::request_ext("XR_EXT_hand_tracking");
///
/// stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
///
/// let xr_type = Backend::xr_type();
/// let eyes_sample_time = BackendOpenXR::eyes_sample_time();
/// let instance         = BackendOpenXR::instance();
/// let session          = BackendOpenXR::session();
/// let space            = BackendOpenXR::space();
/// let system_id        = BackendOpenXR::system_id();
/// let time             = BackendOpenXR::time();
/// let ext_enabled      = BackendOpenXR::ext_enabled("XR_EXT_hand_tracking");
/// let get_function_ptr = BackendOpenXR::get_function_ptr("xrGetHandTrackerEXT");
/// let get_function     = BackendOpenXR::get_function::<unsafe extern "C" fn()>("xrGetHandTrackerEXT");
/// BackendOpenXR::set_hand_joint_scale(1.0);
/// BackendOpenXR::use_minimum_exts(true);
///
/// xr_mode_stop_here!();
/// // These are the expected results for offscreen tests on a PC:
/// assert_eq!( xr_type, BackendXRType::None);
///  assert_ne!( xr_type, BackendXRType::OpenXR);
/// assert_eq!(eyes_sample_time, 0);
/// assert_eq!(instance, 0);
/// assert_eq!(session, 0);
/// assert_eq!(space, 0);
/// assert_eq!(system_id, 0);
/// assert_eq!(time, 0);
/// assert_eq!(ext_enabled, false);
/// assert_eq!(get_function_ptr, None);
/// assert_eq!(get_function, None);
/// ```
pub struct BackendOpenXR;

impl BackendOpenXR {
    /// Type: XrTime. This is the OpenXR time of the eye tracker sample associated with the current value of.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/EyesSampleTime.html>
    ///
    /// see also [`backend_openxr_get_eyes_sample_time`]
    pub fn eyes_sample_time() -> i64 {
        unsafe { backend_openxr_get_eyes_sample_time() }
    }

    /// Type: XrInstance. StereoKit’s instance handle, valid after Sk.initialize.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/Instance.html>
    ///
    /// see also [`backend_openxr_get_instance`]
    ///
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// let instance_handle = BackendOpenXR::instance();
    ///
    /// // In XR mode, this would be a valid XrInstance handle for OpenXR operations
    /// // In offscreen mode, returns 0
    ///
    /// offscreen_mode_stop_here!();
    /// assert_ne!(instance_handle, 0);
    /// ```
    pub fn instance() -> OpenXRHandleT {
        unsafe { backend_openxr_get_instance() }
    }

    /// Type: XrSession. StereoKit’s current session handle, this will be valid after SK.Initialize, but the session may
    /// not be started quite so early.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/Session.html>
    ///
    /// see also [`backend_openxr_get_session`]
    ///
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// let session_handle = BackendOpenXR::session();
    ///
    /// // In XR mode, this would be a valid XrSession handle for OpenXR session operations
    /// // In offscreen mode, returns 0
    ///
    /// offscreen_mode_stop_here!();
    /// assert_ne!(session_handle, 0);
    /// ```
    pub fn session() -> OpenXRHandleT {
        unsafe { backend_openxr_get_session() }
    }

    /// Type: XrSpace. StereoKit’s primary coordinate space, valid after SK.Initialize, this will most likely be created
    /// from XR_REFERENCE_SPACE_TYPE_UNBOUNDED_MSFT or XR_REFERENCE_SPACE_TYPE_LOCAL.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/Space.html>
    ///
    /// see also [`backend_openxr_get_space`]
    ///
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// let space_handle = BackendOpenXR::space();
    ///
    /// // In XR mode, this would be a valid XrSpace handle for coordinate transformations
    /// // In offscreen mode, returns 0
    ///
    /// offscreen_mode_stop_here!();
    /// assert_ne!(space_handle, 0);
    /// ```
    pub fn space() -> OpenXRHandleT {
        unsafe { backend_openxr_get_space() }
    }

    /// Type: XrSystemId. This is the id of the device StereoKit is currently using! This is the result of calling
    /// xrGetSystem with XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/SystemId.html>
    ///
    /// see also [`backend_openxr_get_system_id`]
    ///
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// let system_id = BackendOpenXR::system_id();
    ///
    /// // In XR mode, this would be a valid XrSystemId for the current XR device
    /// // In offscreen mode, returns 0
    ///
    /// offscreen_mode_stop_here!();
    /// assert_ne!(system_id, 0);
    /// ```
    pub fn system_id() -> OpenXRHandleT {
        unsafe { backend_openxr_get_system_id() }
    }

    /// Type: XrTime. This is the OpenXR time for the current frame, and is available after Sk.initialize.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/Time.html>
    ///
    /// see also [`backend_openxr_get_time`]
    ///
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// let current_time = BackendOpenXR::time();
    ///
    /// // In offscreen mode, returns 0
    ///
    /// offscreen_mode_stop_here!();
    /// assert_ne!(current_time, 0);
    /// ```
    pub fn time() -> i64 {
        unsafe { backend_openxr_get_time() }
    }

    /// Tells StereoKit to request only the extensions that are absolutely critical to StereoKit. You can still request
    /// extensions via OpenXR.RequestExt, and this can be used to opt-in to extensions that StereoKit would normally
    /// request automatically.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/UseMinimumExts.html>
    ///
    /// see also [`backend_openxr_use_minimum_exts`]
    pub fn use_minimum_exts(value: bool) {
        unsafe { backend_openxr_use_minimum_exts(value as Bool32T) }
    }

    /// This allows you to add XrCompositionLayers to the list that StereoKit submits to xrEndFrame. You must call this
    /// every frame you wish the layer to be included.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/AddCompositionLayer.html>
    /// * `xr_composition_layer_x` - A serializable XrCompositionLayer struct that follows the
    ///   XrCompositionLayerBaseHeader data pattern.
    /// * `sort_order` - An sort order value for sorting with other composition layers in the list. The primary
    ///   projection layer that StereoKit renders to is at 0, -1 would be before it, and +1 would be after.
    ///
    /// see also [`backend_openxr_composition_layer`]
    ///
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// // Only works in XR mode but offscreen accept it.
    /// use openxr_sys as oxr;
    ///
    /// // Create projection views for left eye only
    /// let mut projection_views = [
    ///     oxr::CompositionLayerProjectionView {
    ///         ty: oxr::StructureType::COMPOSITION_LAYER_PROJECTION_VIEW,
    ///         next: std::ptr::null(),
    ///         sub_image: oxr::SwapchainSubImage {
    ///             swapchain: oxr::Swapchain::from_raw(0), // Should be valid swapchain
    ///             image_rect: oxr::Rect2Di {
    ///                 offset: oxr::Offset2Di { x: 0, y: 0 },
    ///                 extent: oxr::Extent2Di { width: 1024, height: 1024 },
    ///             },
    ///             image_array_index: 0,
    ///         },
    ///         pose: oxr::Posef {
    ///             orientation: oxr::Quaternionf { x: 0.0, y: 0.0, z: 0.0, w: 1.0 },
    ///             position: oxr::Vector3f { x: -0.032, y: 0.0, z: 0.0 }, // Left eye offset
    ///         },
    ///         fov: oxr::Fovf {
    ///             angle_left: -0.7853981, // -45 degrees
    ///             angle_right: 0.7853981,  // 45 degrees
    ///             angle_up: 0.7853981,     // 45 degrees
    ///             angle_down: -0.7853981,  // -45 degrees
    ///         },
    ///     }
    /// ];
    ///
    /// let mut composition_layer = oxr::CompositionLayerProjection {
    ///     ty: oxr::StructureType::COMPOSITION_LAYER_PROJECTION,
    ///     next: std::ptr::null(),
    ///     layer_flags: oxr::CompositionLayerFlags::BLEND_TEXTURE_SOURCE_ALPHA,
    ///     space: oxr::Space::from_raw(BackendOpenXR::space()),
    ///     view_count: 1,
    ///     views: projection_views.as_ptr(),
    /// };
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     BackendOpenXR::add_composition_layer(&mut composition_layer, 0);
    /// );
    /// ```
    pub fn add_composition_layer<T>(xr_composition_layer_x: &mut T, sort_order: i32) {
        let size = size_of::<T>();
        let ptr = xr_composition_layer_x as *mut _ as *mut c_void;
        unsafe { backend_openxr_composition_layer(ptr, size as i32, sort_order) }
    }

    /// This adds an item to the chain of objects submitted to StereoKit’s xrEndFrame call!
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/AddEndFrameChain.html>
    /// * `xr_base_header` - An OpenXR object that will be chained into the xrEndFrame call.
    ///
    /// see also [`backend_openxr_end_frame_chain`]
    ///
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// // Only works in XR mode but offscreen accept it.
    /// use openxr_sys as oxr;
    /// let mut frame_end_info = oxr::FrameEndInfo {
    ///     ty: oxr::StructureType::FRAME_END_INFO,
    ///     next: std::ptr::null(),
    ///     display_time: oxr::Time::from_nanos(BackendOpenXR::time()),
    ///     environment_blend_mode:  oxr::EnvironmentBlendMode::OPAQUE,
    ///     layer_count: 0,
    ///     layers: std::ptr::null_mut(), // Should be filled with valid layers
    ///     
    /// };
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     BackendOpenXR::add_end_frame_chain(&mut frame_end_info);
    /// );
    /// ```
    pub fn add_end_frame_chain<T>(xr_base_header: &mut T) {
        let size = size_of::<T>();
        let ptr = xr_base_header as *mut _ as *mut c_void;
        unsafe { backend_openxr_end_frame_chain(ptr, size as i32) }
    }

    /// This ensures that StereoKit does not load a particular extension! StereoKit will behave as if the extension is
    /// not available on the device. It will also be excluded even if you explicitly requested it with RequestExt
    /// earlier, or afterwards. This MUST be called before SK.Initialize.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/ExcludeExt.html>
    /// * `extension_name` - The extension name as listed in the OpenXR spec. For example: “XR_EXT_hand_tracking”.
    ///
    /// see also [`backend_openxr_ext_exclude`]
    ///
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// // This must be called before SK.Initialize
    /// BackendOpenXR::exclude_ext("XR_EXT_hand_tracking");
    /// BackendOpenXR::exclude_ext("XR_FB_passthrough");
    ///
    /// stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    ///
    /// offscreen_mode_stop_here!();
    /// // Later, we can check if the extensions were not loaded:
    /// assert_eq!(BackendOpenXR::ext_enabled("XR_EXT_hand_tracking"), false);
    /// assert_eq!(BackendOpenXR::ext_enabled("XR_FB_passthrough"), false);
    /// ```
    pub fn exclude_ext(extension_name: impl AsRef<str>) {
        let c_str = CString::new(extension_name.as_ref()).unwrap();
        unsafe { backend_openxr_ext_exclude(c_str.as_ptr()) }
    }

    /// Requests that OpenXR load a particular extension. This MUST be called before SK.Initialize. Note that it’s
    /// entirely possible that your extension will not load on certain runtimes, so be sure to check ExtEnabled to see
    /// if it’s available to use.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/RequestExt.html>
    /// * `extension_name` - The extension name as listed in the OpenXR spec. For example: “XR_EXT_hand_tracking”.
    ///
    /// see also [`backend_openxr_ext_request`]
    ///
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// // This must be called before SK.Initialize
    /// BackendOpenXR::request_ext("XR_EXT_hand_tracking");
    /// BackendOpenXR::request_ext("XR_the_ext_that_does_not_exist");
    ///
    /// stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    ///
    /// offscreen_mode_stop_here!();
    /// // Later, check if extensions were loaded as we can't be sure they are ok for this runtime:
    /// assert_eq!(BackendOpenXR::ext_enabled("XR_EXT_hand_tracking"), true);
    /// assert_eq!(BackendOpenXR::ext_enabled("XR_the_ext_that_does_not_exist"), false);
    /// ```
    pub fn request_ext(extension_name: impl AsRef<str>) {
        let c_str = CString::new(extension_name.as_ref()).unwrap();
        unsafe { backend_openxr_ext_request(c_str.as_ptr()) }
    }

    /// This tells if an OpenXR extension has been requested and successfully loaded by the runtime. This MUST only be
    /// called after SK.Initialize.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/ExtEnabled.html>
    /// * `extension_name` - The extension name as listed in the OpenXR spec. For example: “XR_EXT_hand_tracking”.
    ///
    /// see also [`backend_openxr_ext_enabled`]
    ///
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// // Check if an extension is enabled (only works in XR mode)
    /// let hand_tracking_enabled = BackendOpenXR::ext_enabled("XR_EXT_hand_tracking");
    /// let imaginary_enabled = BackendOpenXR::ext_enabled("XR_the_ext_that_does_not_exist");
    ///
    /// offscreen_mode_stop_here!();
    /// // In offscreen mode, extensions are never enabled
    /// assert_eq!(hand_tracking_enabled, true);
    /// assert_eq!(imaginary_enabled, false);
    /// ```
    pub fn ext_enabled(extension_name: impl AsRef<str>) -> bool {
        if Backend::xr_type() == BackendXRType::OpenXR {
            let c_str = CString::new(extension_name.as_ref()).unwrap();
            unsafe { backend_openxr_ext_enabled(c_str.as_ptr()) != 0 }
        } else {
            false
        }
    }

    /// This is basically xrGetInstanceProcAddr from OpenXR, you can use this to get and call functions from an
    /// extension you’ve loaded.
    /// ### Important Note
    /// It is more relevant to use the openxrs crate which contains the function signatures
    ///
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/GetFunctionPtr.html>
    /// * `function_name` - The name of the function to get the pointer for.
    ///
    /// see also [`backend_openxr_get_function`]
    ///
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// // Get a function pointer from an OpenXR extension (only works in XR mode)
    /// let hand_tracker_fn = BackendOpenXR::get_function_ptr("xrCreateHandTrackerEXT");
    /// let passthrough_fn = BackendOpenXR::get_function_ptr("xrInexistantFunction");
    ///
    /// offscreen_mode_stop_here!();
    /// // In offscreen mode, function pointers are None
    /// assert_eq!(hand_tracker_fn.is_some(), true);
    /// assert_eq!(passthrough_fn, None);
    /// ```
    pub fn get_function_ptr(function_name: impl AsRef<str>) -> Option<VoidFunction> {
        let c_str = CString::new(function_name.as_ref()).unwrap();
        unsafe { backend_openxr_get_function(c_str.as_ptr()) }
    }

    /// This is basically xrGetInstanceProcAddr from OpenXR, you can use this to get and call functions from an
    /// extension you’ve loaded.
    /// ### Important Note
    /// It is more relevant to use the openxrs crate which contains the function signatures
    ///
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/GetFunctionPtr.html>
    /// * `function_name` - The name of the function to get the pointer for.
    ///
    /// see also [`backend_openxr_get_function`]
    ///
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::BackendOpenXR;
    ///
    /// // Get a typed function pointer from an OpenXR extension (only works in XR mode)
    /// let hand_tracker_fn: Option<unsafe extern "C" fn()> = BackendOpenXR::get_function("xrCreateHandTrackerEXT");
    ///
    /// offscreen_mode_stop_here!();
    /// // In offscreen mode, function pointers are None
    /// assert_eq!(hand_tracker_fn.is_some(), true);
    /// ```
    pub fn get_function<T>(function_name: impl AsRef<str>) -> Option<T> {
        let c_str = CString::new(function_name.as_ref()).unwrap();
        let function = unsafe { backend_openxr_get_function(c_str.as_ptr()) };
        unsafe { transmute_copy(&function) }
    }

    /// This sets a scaling value for joints provided by the articulated hand extension. Some systems just don’t seem to
    /// get their joint sizes right!
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenXR/SetHandJointScale.html>
    /// * `joint_scale_factor` - 1 being the default value, 2 being twice as large as normal, and 0.5 being half as big
    ///   as normal.
    ///
    /// see also [`backend_openxr_set_hand_joint_scale`]
    ///
    /// ### Example
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Backend, BackendOpenXR, BackendXRType};
    ///
    /// // Adjust hand joint scaling (only effective in XR mode with hand tracking)
    /// BackendOpenXR::set_hand_joint_scale(1.2); // Make joints 20% larger
    ///
    /// // Or make them smaller
    /// BackendOpenXR::set_hand_joint_scale(0.8); // Make joints 20% smaller
    ///
    /// // Reset to default
    /// BackendOpenXR::set_hand_joint_scale(1.0);
    /// ```
    pub fn set_hand_joint_scale(joint_scale_factor: f32) {
        unsafe { backend_openxr_set_hand_joint_scale(joint_scale_factor) }
    }
}

/// This class contains variables that may be useful for interop with the Android operating system, or other Android
/// libraries.
///
/// see also `SkInfo::get_android_app`
/// <https://stereokit.net/Pages/StereoKit/Backend.Android.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::system::BackendAndroid;
///
/// let activity = BackendAndroid::activity();
/// let java_vm = BackendAndroid::java_vm();
/// let jni_environment = BackendAndroid::jni_environment();
///
/// // These are results for a non Android environment:
/// assert_eq!(activity, std::ptr::null_mut());
/// assert_eq!(java_vm, std::ptr::null_mut());
/// assert_eq!(jni_environment, std::ptr::null_mut());
/// ```
pub struct BackendAndroid;

impl BackendAndroid {
    /// This is the jobject activity that StereoKit uses on Android. This is only valid after Sk.initialize, on Android
    /// systems.
    /// <https://stereokit.net/Pages/StereoKit/Backend.Android/Activity.html>
    ///
    /// see also [`backend_android_get_activity`]
    pub fn activity() -> *mut c_void {
        unsafe { backend_android_get_activity() }
    }

    /// This is the JavaVM* object that StereoKit uses on Android. This is only valid after Sk.initialize, on Android
    /// systems.
    /// <https://stereokit.net/Pages/StereoKit/Backend.Android/JavaVM.html>
    ///
    /// see also [`backend_android_get_java_vm`]
    pub fn java_vm() -> *mut c_void {
        unsafe { backend_android_get_java_vm() }
    }

    /// This is the JNIEnv* object that StereoKit uses on Android. This is only valid after Sk.initialize, on Android
    /// systems.
    /// <https://stereokit.net/Pages/StereoKit/Backend.Android/JNIEnvironment.html>
    ///
    /// see also [`backend_android_get_jni_env`]
    pub fn jni_environment() -> *mut c_void {
        unsafe { backend_android_get_jni_env() }
    }
}

/// When using Direct3D11 for rendering, this contains a number of variables that may be useful for doing advanced
/// rendering tasks. This is the default rendering backend on Windows.
/// <https://stereokit.net/Pages/StereoKit/Backend.D3D11.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::system::BackendD3D11;
/// let d3d_context = BackendD3D11::d3d_context();
/// let d3d_device = BackendD3D11::d3d_device();
///
/// if cfg!(target_os = "windows") {
///     // These are results for a D3D11 environment:
///     assert_eq!(d3d_context, std::ptr::null_mut());
///     assert_ne!(d3d_device, std::ptr::null_mut());
/// } else {
///     // These are results for a non D3D11 environment:
///     assert_eq!(d3d_context, std::ptr::null_mut());
///     assert_eq!(d3d_device, std::ptr::null_mut());
/// }
/// ```
pub struct BackendD3D11;

impl BackendD3D11 {
    /// This is the main ID3D11DeviceContext* StereoKit uses for rendering.
    /// <https://stereokit.net/Pages/StereoKit/Backend.D3D11/D3DContext.html>
    ///
    /// see also [`backend_d3d11_get_d3d_context`]
    pub fn d3d_context() -> *mut c_void {
        unsafe { backend_d3d11_get_d3d_context() }
    }

    /// This is the main ID3D11Device* StereoKit uses for rendering.
    /// <https://stereokit.net/Pages/StereoKit/Backend.D3D11/D3DDevice.html>
    ///
    /// see also [`backend_d3d11_get_d3d_device`]
    pub fn d3d_device() -> *mut c_void {
        unsafe { backend_d3d11_get_d3d_device() }
    }
}

/// When using OpenGL with the WGL loader for rendering, this contains a number of variables that may be useful for
/// doing advanced rendering tasks. This is Windows only, and requires gloabally defining SKG_FORCE_OPENGL when building
/// the core StereoKitC library.
/// <https://stereokit.net/Pages/StereoKit/Backend.OpenGL_WGL.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::system::BackendOpenGLWGL;
/// let hdc = BackendOpenGLWGL::hdc();
/// let hglrc = BackendOpenGLWGL::hglrc();
///
/// // These are results for a non OpenGLWGL environment:
/// assert_eq!(hdc, std::ptr::null_mut());
/// assert_eq!(hglrc, std::ptr::null_mut());
/// ```
pub struct BackendOpenGLWGL;

impl BackendOpenGLWGL {
    /// This is the Handle to Device Context HDC StereoKit uses with wglMakeCurrent.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenGL_WGL/HDC.html>
    ///
    /// see also [`backend_opengl_wgl_get_hdc`]
    pub fn hdc() -> *mut c_void {
        unsafe { backend_opengl_wgl_get_hdc() }
    }

    /// This is the Handle to an OpenGL Rendering Context HGLRC StereoKit uses with wglMakeCurrent.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenGL_WGL/HGLRC.html>
    ///
    /// see also [`backend_opengl_wgl_get_hglrc`]
    pub fn hglrc() -> *mut c_void {
        unsafe { backend_opengl_wgl_get_hglrc() }
    }
}

/// When using OpenGL ES with the EGL loader for rendering, this contains a number of variables that may be useful for
/// doing advanced rendering tasks. This is the default rendering backend for Android, and Linux builds can be
/// configured to use this with the SK_LINUX_EGL cmake option when building the core StereoKitC library.
/// <https://stereokit.net/Pages/StereoKit/Backend.OpenGLES_EGL.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::system::BackendOpenGLESEGL;
///
/// if cfg!(target_os = "linux") {
///     // These are results for a OpenGLESEGL environment:
///
///     let context = BackendOpenGLESEGL::context();
///     assert_ne!(context, std::ptr::null_mut());
///
///     let display = BackendOpenGLESEGL::display();
///     assert_ne!(display, std::ptr::null_mut());
/// }
/// ```
pub struct BackendOpenGLESEGL;

impl BackendOpenGLESEGL {
    /// This is the EGLContext StereoKit receives from eglCreateContext.
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenGLES_EGL/Context.html>
    ///
    /// see also [`backend_opengl_egl_get_context`]
    pub fn context() -> *mut c_void {
        unsafe { backend_opengl_egl_get_context() }
    }

    /// This is the EGLDisplay StereoKit receives from eglGetDisplay
    /// <https://stereokit.net/Pages/StereoKit/Backend.OpenGLES_EGL/Display.html>
    ///
    /// see also [`backend_opengl_egl_get_display`]
    pub fn display() -> *mut c_void {
        unsafe { backend_opengl_egl_get_display() }
    }
}

/// When used with a hierarchy modifying function that will push/pop items onto a
/// stack, this can be used to change the behavior of how parent hierarchy items
/// will affect the item being added to the top of the stack.
/// <https://stereokit.net/Pages/StereoKit/HierarchyParent.html>
///
/// see also [`Hierarchy`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum HierarchyParent {
    /// Inheriting is generally the default behavior of a hierarchy stack, the
    /// current item will inherit the properties of the parent stack item in some
    /// form or another.
    Inherit = 0,
    /// Ignoring the parent hierarchy stack item will let you skip inheriting
    /// anything from the parent item. The new item remains exactly as provided.
    Ignore = 1,
}

/// This class represents a stack of transform matrices that build up a transform hierarchy! This can be used like an
/// object-less parent-child system, where you push a parent’s transform onto the stack, render child objects relative
/// to that parent transform and then pop it off the stack.
///
/// Performance note: if any matrices are on the hierarchy stack, any render will cause a matrix multiplication to
/// occur! So if you have a collection of objects with their transforms baked and cached into matrices for performance
/// reasons, you’ll want to ensure there are no matrices in the hierarchy stack, or that the hierarchy is disabled!
/// It’ll save you a matrix multiplication in that case :)
/// <https://stereokit.net/Pages/StereoKit/Hierarchy.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{maths::Matrix, system::{Hierarchy, HierarchyParent}, mesh::Mesh,
///                      material::Material, util::named_colors};
///
/// let sphere = Mesh::generate_sphere(0.2, None);
/// let material = Material::pbr();
/// let transform = Matrix::t([0.4, 0.4, 0.4]);
///
/// filename_scr = "screenshots/hierarchy.jpeg";
/// test_screenshot!( // !!!! Get a proper main loop !!!!
///     sphere.draw(token, &material, transform, None, None);
///
///     assert!(Hierarchy::is_enabled(&token));
///
///     Hierarchy::push(token, Matrix::t([0.0, -0.5, -0.5]), None);
///     sphere.draw(token, &material, transform, Some(named_colors::RED.into()), None);
///     assert_eq!(Hierarchy::to_local_point(&token, [0.4, 0.4, 0.4]), [0.4, 0.9, 0.9].into());
///     assert_eq!(Hierarchy::to_world_point(&token, [0.4, 0.9, 0.9]), [0.4, 0.4, 0.4].into());
///     Hierarchy::pop(token);
///
///     Hierarchy::push(token, Matrix::t([-0.5, -0.5, 0.25]), Some(HierarchyParent::Ignore));
///     sphere.draw(token, &material, transform, Some(named_colors::GREEN.into()), None);
///     assert_eq!(Hierarchy::to_local_point(&token, [0.4, 0.4, 0.4]), [0.9, 0.9, 0.15].into());
///     assert_eq!(Hierarchy::to_world_point(&token, [0.9, 0.9, 0.15]), [0.4, 0.4, 0.4].into());
///
///     Hierarchy::enabled(token, false);
///     sphere.draw(token, &material, Matrix::IDENTITY, Some(named_colors::BLUE.into()), None);
///     assert_eq!(Hierarchy::to_local_point(&token, [0.4, 0.4, 0.4]), [0.4, 0.4, 0.4].into());
///     Hierarchy::enabled(token, true);
///     Hierarchy::pop(&token);
/// );
/// ```
/// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/hierarchy.jpeg" alt="screenshot" width="200">
pub struct Hierarchy;

unsafe extern "C" {
    pub fn hierarchy_push(transform: *const Matrix, parent_behavior: HierarchyParent);
    pub fn hierarchy_push_pose(pose: *const Pose, parent_behavior: HierarchyParent);
    pub fn hierarchy_pop();
    pub fn hierarchy_set_enabled(enabled: Bool32T);
    pub fn hierarchy_is_enabled() -> Bool32T;
    pub fn hierarchy_to_world() -> *const Matrix;
    pub fn hierarchy_to_local() -> *const Matrix;
    pub fn hierarchy_to_local_point(world_pt: *const Vec3) -> Vec3;
    pub fn hierarchy_to_local_direction(world_dir: *const Vec3) -> Vec3;
    pub fn hierarchy_to_local_rotation(world_orientation: *const Quat) -> Quat;
    pub fn hierarchy_to_local_pose(world_pose: *const Pose) -> Pose;
    pub fn hierarchy_to_local_ray(world_ray: Ray) -> Ray;
    pub fn hierarchy_to_world_point(local_pt: *const Vec3) -> Vec3;
    pub fn hierarchy_to_world_direction(local_dir: *const Vec3) -> Vec3;
    pub fn hierarchy_to_world_rotation(local_orientation: *const Quat) -> Quat;
    pub fn hierarchy_to_world_pose(local_pose: *const Pose) -> Pose;
    pub fn hierarchy_to_world_ray(local_ray: Ray) -> Ray;
}

impl Hierarchy {
    /// This is enabled by default. Disabling this will cause any draw call to ignore any Matrices that are on the
    /// Hierarchy stack.
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/Enabled.html>
    ///
    /// see also [`hierarchy_set_enabled`] [`Hierarchy::is_enabled`]
    pub fn enabled(_token: &MainThreadToken, enable: bool) {
        unsafe { hierarchy_set_enabled(enable as Bool32T) }
    }

    /// This is enabled by default. Disabling this will cause any draw call to ignore any Matrices that are on the
    /// Hierarchy stack.
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/Enabled.html>
    ///
    /// see also [hierarchy_is_enabled] [`Hierarchy::enabled`]
    pub fn is_enabled(_token: &MainThreadToken) -> bool {
        unsafe { hierarchy_is_enabled() != 0 }
    }

    /// Removes the top Matrix from the stack!
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/Pop.html>
    ///
    /// see also [`hierarchy_pop`] [`Hierarchy::push`]
    pub fn pop(_token: &MainThreadToken) {
        unsafe { hierarchy_pop() }
    }

    /// Pushes a transform Matrix (eventually a Pose) onto the stack, and combines it with the Matrix below it. Any draw
    /// operation’s Matrix will now be combined with this Matrix to make it relative to the current hierarchy. Use
    /// Hierarchy.pop to remove it from the Hierarchy stack! All Push calls must have an accompanying Pop call.
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/Push.html>
    /// * `parent_behavior` - This determines how this matrix combines with the parent matrix below it. Normal behavior
    ///   is to "inherit" the parent matrix, but there are cases where you may wish to entirely ignore the parent
    ///   transform. For example, if you're in UI space, and wish to do some world space rendering. If None, has default
    ///   value "Inherit"
    ///
    /// see also [`hierarchy_push`] [`Hierarchy::pop`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::Matrix, system::{Hierarchy, HierarchyParent}};
    ///
    /// test_steps! { // !!!! Get a proper main loop !!!!
    ///     Hierarchy::push(token, Matrix::t([0.0, -0.5, -0.5]), None);
    ///     assert_eq!(Hierarchy::to_local_point(token, [0.4, 0.4, 0.4]), [0.4, 0.9, 0.9].into());
    ///     assert_eq!(Hierarchy::to_world_point(token, [0.4, 0.9, 0.9]), [0.4, 0.4, 0.4].into());
    ///     Hierarchy::pop(token);
    /// }
    /// ```
    pub fn push<M: Into<Matrix>>(_token: &MainThreadToken, transform: M, parent_behavior: Option<HierarchyParent>) {
        let parent_behavior = parent_behavior.unwrap_or(HierarchyParent::Inherit);
        unsafe { hierarchy_push(&transform.into(), parent_behavior) }
    }

    /// Converts a world space point into the local space of the current Hierarchy stack!
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/ToLocal.html>
    /// * `world_point` - A point in world space.
    ///
    /// Returns the provided point now in local hierarchy space
    /// see also [`hierarchy_to_local_point`] [`Hierarchy::to_world_point`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::Pose, system::{Hierarchy, HierarchyParent}};
    ///
    /// test_steps! { // !!!! Get a proper main loop !!!!
    ///     Hierarchy::push(token, Pose::new([0.0, -0.5, -0.5], None), None);
    ///     assert_eq!(Hierarchy::to_local_point(token, [0.4, 0.4, 0.4]), [0.4, 0.9, 0.9].into());
    ///     assert_eq!(Hierarchy::to_world_point(token, [0.4, 0.9, 0.9]), [0.4, 0.4, 0.4].into());
    ///     Hierarchy::pop(token);
    /// }
    /// ```
    pub fn to_local_point<V: Into<Vec3>>(_token: &MainThreadToken, world_point: V) -> Vec3 {
        unsafe { hierarchy_to_local_point(&world_point.into()) }
    }

    /// Converts a world space rotation into the local space of the current Hierarchy stack!
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/ToLocal.html>
    /// * `world_orientation` - A rotation in world space
    ///
    /// Returns the provided rotation now in local hierarchy space
    /// see also [`hierarchy_to_local_rotation`] [`Hierarchy::to_world_rotation`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Matrix, Quat, Vec3}, system::{Hierarchy, HierarchyParent}};
    ///
    /// test_steps! { // !!!! Get a proper main loop !!!!
    ///     Hierarchy::push(token, Matrix::r([0.0, 0.0, 180.0]), None);
    ///     let local: Vec3 = Hierarchy::to_local_rotation(token, [90.0, 180.0, 0.0])
    ///                           .to_angles_degrees().into();
    ///     assert_eq!(local, [-90.0, 0.0, 0.0].into());
    ///
    ///     let world: Vec3 = Hierarchy::to_world_rotation(token, [90.0, 180.0, 0.0])
    ///                           .to_angles_degrees().into();
    ///     assert_eq!(world, [-90.0, 0.0, 0.0].into());
    ///     Hierarchy::pop(token);
    /// }
    /// ```
    pub fn to_local_rotation<Q: Into<Quat>>(_token: &MainThreadToken, world_orientation: Q) -> Quat {
        unsafe { hierarchy_to_local_rotation(&world_orientation.into()) }
    }

    /// Converts a world pose relative to the current hierarchy stack into local space!
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/ToLocal.html>
    /// * `world_pose` - A pose in world space.
    ///
    /// Returns the provided pose now in local hierarchy space!
    /// see also [`hierarchy_to_local_pose`] [Hierarchy::to_local_pose]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Matrix, Quat, Pose}, system::{Hierarchy, HierarchyParent}};
    ///
    /// test_steps! { // !!!! Get a proper main loop !!!!
    ///     Hierarchy::push(token, Matrix::t([0.0, -0.5, -0.5]), None);
    ///     let pose = Pose::new([10.0, 20.0, 30.0], None);
    ///     assert_eq!(Hierarchy::to_local_pose(token, pose), Pose::new([10.0, 20.5, 30.5], None));
    ///     assert_eq!(Hierarchy::to_world_pose(token, Pose::new([10.0, 20.5, 30.5], None)), pose);
    ///     Hierarchy::pop(token);
    /// }
    /// ```
    pub fn to_local_pose<P: Into<Pose>>(_token: &MainThreadToken, world_pose: P) -> Pose {
        unsafe { hierarchy_to_local_pose(&world_pose.into()) }
    }

    /// Converts a world ray relative to the current hierarchy stack into local space!
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/ToLocal.html>
    /// * `world_ray` - A ray in world space
    ///
    /// Returns the provided ray now in local hierarchy space
    /// see also [`hierarchy_to_local_ray`] [`Hierarchy::to_world_ray`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Vec3, Matrix, Quat, Ray}, system::{Lines, Hierarchy},
    ///     util::{named_colors}, mesh::Mesh, material::{Material, Cull}};
    ///
    /// // Create Meshes
    /// let cube = Mesh::generate_cube(Vec3::ONE * 0.8, None);
    /// let sphere = Mesh::generate_sphere(1.0, Some(4));
    ///
    /// let material = Material::pbr().copy();
    /// let transform = Matrix::r(Quat::from_angles(40.0, 50.0, 20.0));
    /// let inv = transform.get_inverse();
    ///
    /// let ray = Ray::new([1.0, 2.0, 2.5 ], [-1.0, -2.0, -2.25]);
    ///
    /// filename_scr = "screenshots/hierarchy_ray.jpeg";
    /// test_screenshot!( // !!!! Get a proper main loop !!!!
    ///     let world_space_ray = Hierarchy::to_world_ray(token, ray);
    ///     assert_eq!(world_space_ray, ray);
    ///     Lines::add_ray(token, world_space_ray, 2.2, named_colors::WHITE, None, 0.02);
    ///
    ///     Hierarchy::push(token, transform, None);
    ///     let local_transform = Matrix::t([-0.1, 0.1, 0.1]);
    ///     cube.draw(token, &material, local_transform, Some(named_colors::MAGENTA.into()), None);
    ///
    ///     let local_space_ray = Hierarchy::to_local_ray(token, world_space_ray);
    ///     let mesh_space_ray = local_transform.get_inverse().transform_ray(local_space_ray);
    ///     let (contact_cube, ind_cube) = cube.intersect( mesh_space_ray, Some(Cull::Back))
    ///                                        .expect("Ray should touch cube");
    ///     assert_eq!(ind_cube, 15);
    ///
    ///     let local_contact_cube = local_transform.transform_point(contact_cube);
    ///     let transform_contact = Matrix::t_s(local_contact_cube, Vec3::ONE * 0.1);
    ///     sphere.draw(token, &material, transform_contact, Some(named_colors::YELLOW.into()), None );
    ///     Hierarchy::pop(token);
    /// );
    /// ```
    /// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/hierarchy_ray.jpeg" alt="screenshot" width="200">
    pub fn to_local_ray<R: Into<Ray>>(_token: &MainThreadToken, world_ray: R) -> Ray {
        unsafe { hierarchy_to_local_ray(world_ray.into()) }
    }

    /// Converts a world space direction into the local space of the current Hierarchy stack! This excludes the
    /// translation component normally applied to vectors, so it’s still a valid direction.
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/ToLocalDirection.html>
    /// * `world_direction` - A direction in world space
    ///
    /// Returns the provided direction now in local hierarchy space
    /// see also [`hierarchy_to_local_direction`] [`Hierarchy::to_world_direction`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Matrix, Vec3}, system::{Hierarchy, HierarchyParent}};
    ///
    /// test_steps! { // !!!! Get a proper main loop !!!!
    ///     Hierarchy::push(token, Matrix::r([0.0, 0.0, 180.0]), None);
    ///     assert_eq!(Hierarchy::to_local_direction(token, [1.0, 0.0, 0.0]), [-1.0, 0.0, 0.0].into());
    ///     assert_eq!(Hierarchy::to_world_direction(token, [-1.0, 0.0, 0.0]), [1.0, 0.0, 0.0].into());
    ///     Hierarchy::pop(token);
    /// }
    /// ```
    /// see also [`hierarchy_to_local_direction`] [`hierarchy_to_world_direction`]
    pub fn to_local_direction<V: Into<Vec3>>(_token: &MainThreadToken, world_direction: V) -> Vec3 {
        unsafe { hierarchy_to_local_direction(&world_direction.into()) }
    }

    /// Converts a local point relative to the current hierarchy stack into world space!
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/ToWorld.html>
    /// * `local_point` - A point in local space
    ///
    /// Returns the provided point now in world space
    ///
    /// see also [`hierarchy_to_world_point`]
    /// see example in [`Hierarchy::to_local_point`]
    pub fn to_world_point<V: Into<Vec3>>(_token: &MainThreadToken, local_point: V) -> Vec3 {
        unsafe { hierarchy_to_world_point(&local_point.into()) }
    }

    /// Converts a local rotation relative to the current hierarchy stack into world space!
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/ToWorld.html>
    /// * `local_orientaion` - A rotation in local space
    ///
    /// Returns the provided rotation now in world space
    ///
    /// see also [`hierarchy_to_world_rotation`]
    /// see example in [`Hierarchy::to_local_rotation`]
    pub fn to_world_rotation<Q: Into<Quat>>(_token: &MainThreadToken, local_orientation: Q) -> Quat {
        unsafe { hierarchy_to_world_rotation(&local_orientation.into()) }
    }

    /// Converts a local pose relative to the current hierarchy stack into world space!
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/ToWorld.html>
    /// * `local_pose` - A pose in local space
    ///
    /// Returns the provided pose now in world space
    ///
    /// see also [`hierarchy_to_world_pose`]
    /// see example in [`Hierarchy::to_local_pose`]
    pub fn to_world_pose<P: Into<Pose>>(_token: &MainThreadToken, local_pose: P) -> Pose {
        unsafe { hierarchy_to_world_pose(&local_pose.into()) }
    }

    /// Converts a local ray relative to the current hierarchy stack into world space!
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/ToWorld.html>
    /// * `local_ray` - A ray in local space
    ///
    /// Returns the provided ray now in world space
    ///
    /// see also [`hierarchy_to_world_ray`]
    /// see example in [`Hierarchy::to_local_ray`]
    pub fn to_world_ray<P: Into<Ray>>(_token: &MainThreadToken, local_ray: P) -> Ray {
        unsafe { hierarchy_to_world_ray(local_ray.into()) }
    }

    /// Converts a local direction relative to the current hierarchy stack into world space! This excludes the
    /// translation component normally applied to vectors, so it’s still a valid direction.
    /// <https://stereokit.net/Pages/StereoKit/Hierarchy/ToWorldDirection.html>
    /// * `local_direction` - A direction in local space
    ///
    /// Returns the provided direction now in world space
    ///
    /// see also [`hierarchy_to_world_direction`]
    /// see example in [`Hierarchy::to_local_direction`]
    pub fn to_world_direction<V: Into<Vec3>>(_token: &MainThreadToken, local_direction: V) -> Vec3 {
        unsafe { hierarchy_to_world_direction(&local_direction.into()) }
    }
}

bitflags::bitflags! {
/// What type of device is the source of the pointer? This is a bit-flag that can contain some input source family
/// information.
/// <https://stereokit.net/Pages/StereoKit/InputSource.html>
///
/// see also [`Pointer`] [`Input`]
    #[derive(Debug, Copy, Clone, PartialEq, Eq)]
    #[repr(C)]
    pub struct InputSource: u32 {
        /// Matches with all input sources!
        const Any = 2147483647;
        /// Zero, this is not a valid input source, and should never be used!
        const None = 0;
        /// Matches with any hand input source.
        const Hand = 1;
        /// Matches with left hand input sources.
        const HandLeft = 2;
        /// Matches with right hand input sources.
        const HandRight = 4;
        /// Matches with Gaze category input sources.
        #[deprecated(since = "0.4.0", note = "Use Input::get_eyes() instead")]
        const Gaze = 16;
        /// Matches with the head gaze input source.
        #[deprecated(since = "0.4.0", note = "Use Input::get_eyes() instead")]
        const GazeHead = 32;
        /// Matches with the eye gaze input source.
        #[deprecated(since = "0.4.0", note = "Use Input::get_eyes() instead")]
        const GazeEyes = 64;
        /// Matches with mouse cursor simulated gaze as an input source.
        #[deprecated(since = "0.4.0", note = "Use Input::get_eyes() instead")]
        const GazeCurzor = 128;
        /// Matches with any input source that has an activation button!
        #[deprecated(since = "0.4.0", note = "Not working any more")]
        const CanPress = 256;
    }
}

/// An enum for indicating which hand to use!
/// <https://stereokit.net/Pages/StereoKit/Handed.html>
///
/// see also [Hand] [Controller]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum Handed {
    /// Left hand.
    Left = 0,
    /// Right hand.
    Right = 1,
    /// The number of hands one generally has, this is much nicer than doing a for loop with ‘2’ as the condition! It’s
    /// much clearer when you can loop Hand.Max times instead.
    Max = 2,
}

bitflags::bitflags! {
    /// A bit-flag for the current state of a button input.
    /// <https://stereokit.net/Pages/StereoKit/BtnState.html>
    ///
    /// see also [`Input`] [`Ui`]
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::BtnState;
    ///
    /// let state = BtnState::Active | BtnState::JustActive;
    /// assert!(state.contains(BtnState::Active));
    /// assert!(state.contains(BtnState::JustActive));
    /// assert!(!state.contains(BtnState::JustInactive));
    /// assert!(!state.contains(BtnState::Changed));
    /// ```
    #[derive(Default, Debug, Copy, Clone, PartialEq, Eq, PartialOrd)]
    #[repr(C)]
    pub struct BtnState: u32 {
        /// Is the button currently up, unpressed?
        const Inactive = 0;
        /// Is the button currently down, pressed?
        const Active = 1 << 0;
        /// Has the button just been released? Only true for a single frame.
        const JustInactive = 1 << 1;
        /// Has the button just been pressed? Only true for a single frame.
        const JustActive = 1 << 2;
        /// Has the button just changed state this frame?
        const Changed = Self::JustInactive.bits() | Self::JustActive.bits();
        /// Matches with all states!
        const Any = 0x7FFFFFFF;
    }
}

/// A collection of extension methods for the BtnState enum that makes bit-field checks a little easier.
/// <https://stereokit.net/Pages/StereoKit/BtnStateExtensions.html>
impl BtnState {
    /// Creates a Button State using the current and previous frame's state! These two states allow us to add the
    /// "JustActive" and "JustInactive" bitflags when changes happen.
    /// <https://stereokit.net/Pages/StereoKit/BtnState/Make.html>
    /// * `was_active` - Was it active previously?
    /// * `is_active` - And is it active currently?
    ///
    /// Returns a bitflag with "Just" events added in!
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::BtnState;
    ///
    /// // Button was not pressed, now it is pressed
    /// let state = BtnState::make(false, true);
    /// assert!(state.contains(BtnState::Active));
    /// assert!(state.contains(BtnState::JustActive));
    /// assert!(!state.contains(BtnState::JustInactive));
    ///
    /// // Button was pressed, now it is not pressed
    /// let state = BtnState::make(true, false);
    /// assert!(!state.contains(BtnState::Active));
    /// assert!(state.contains(BtnState::JustInactive));
    /// assert!(!state.contains(BtnState::JustActive));
    ///
    /// // Button was pressed, still pressed
    /// let state = BtnState::make(true, true);
    /// assert!(state.contains(BtnState::Active));
    /// assert!(!state.contains(BtnState::JustActive));
    /// assert!(!state.contains(BtnState::JustInactive));
    /// ```
    pub fn make(was_active: bool, is_active: bool) -> BtnState {
        let mut result = if is_active { BtnState::Active } else { BtnState::Inactive };

        if was_active && !is_active {
            result |= BtnState::JustInactive;
        }
        if is_active && !was_active {
            result |= BtnState::JustActive;
        }

        result
    }

    /// Is the button pressed?
    /// <https://stereokit.net/Pages/StereoKit/BtnStateExtensions/IsActive.html>
    pub fn is_active(&self) -> bool {
        (*self & BtnState::Active) > BtnState::Inactive
    }

    /// Has the button just been pressed this frame?
    /// <https://stereokit.net/Pages/StereoKit/BtnStateExtensions/IsJustActive.html>
    pub fn is_just_active(&self) -> bool {
        (*self & BtnState::JustActive) > BtnState::Inactive
    }

    /// Has the button just been released this frame?
    /// <https://stereokit.net/Pages/StereoKit/BtnStateExtensions/IsJustInactive.html>
    pub fn is_just_inactive(&self) -> bool {
        (*self & BtnState::JustInactive) > BtnState::Inactive
    }

    /// Was the button either presses or released this frame?
    /// <https://stereokit.net/Pages/StereoKit/BtnStateExtensions/IsChanged.html>
    pub fn is_changed(&self) -> bool {
        (*self & BtnState::Changed) > BtnState::Inactive
    }
}

/// This is the tracking state of a sensory input in the world, like a controller’s position sensor, or a QR code
/// identified by a tracking system.
/// <https://stereokit.net/Pages/StereoKit/TrackState.html>
///
/// see also [`Controller`]
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::system::{TrackState, Input, Handed};
///
/// let controller = Input::controller(Handed::Right);
///
/// assert_eq!(controller.tracked_pos, TrackState::Lost);
/// assert_ne!(controller.tracked_pos, TrackState::Inferred);
/// assert_ne!(controller.tracked_pos, TrackState::Known);
///
/// assert_eq!(controller.tracked_rot, TrackState::Lost);
/// assert_ne!(controller.tracked_rot, TrackState::Inferred);
/// assert_ne!(controller.tracked_rot, TrackState::Known);
/// ```
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum TrackState {
    /// The system has no current knowledge about the state of this input. It may be out of visibility, or possibly just
    /// disconnected.
    Lost = 0,
    /// The system doesn’t know for sure where this is, but it has an educated guess that may be inferred from previous
    /// data at a lower quality. For example, a controller may still have accelerometer data after going out of view,
    /// which can still be accurate for a short time after losing optical tracking.
    Inferred = 1,
    /// The system actively knows where this input is. Within the constraints of the relevant hardware’s capabilities,
    /// this is as accurate as it gets!
    Known = 2,
}

/// Pointer is an abstraction of a number of different input sources, and a way to surface input events!
/// <https://stereokit.net/Pages/StereoKit/Pointer.html>
///
/// see also [`Input`]
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::{Input, InputSource, Pointer, BtnState, Handed, TrackState},
///                      maths::{Vec3, Quat, Pose, Ray}};
///
/// // By default we only have the 2 hands.
/// assert_eq!(Input::pointer_count(None), 0);
/// let pointer = Input::pointer(0, None);
///
/// assert_eq!(pointer.source, InputSource::None);
/// assert_eq!(pointer.state, BtnState::Inactive);
/// assert_eq!(pointer.tracked, BtnState::Inactive);
/// assert_eq!(pointer.orientation, Quat::ZERO);
/// assert_eq!(pointer.ray, Ray::ZERO);
/// assert_eq!(pointer.get_pose(), Pose::ZERO);
///
/// let hand_pointer = Input::pointer(1, Some(InputSource::Hand));
/// assert_eq!(hand_pointer.source, InputSource::None);
/// assert_eq!(pointer.state, BtnState::Inactive);
/// assert_eq!(pointer.tracked, BtnState::Inactive);
/// assert_eq!(pointer.orientation, Quat::ZERO);
/// assert_eq!(pointer.ray, Ray::ZERO);
/// assert_eq!(pointer.get_pose(), Pose::ZERO);
/// ```
#[derive(Debug, Copy, Clone)]
#[repr(C)]
pub struct Pointer {
    /// What input source did this pointer come from? This is a bit-flag that contains input family and capability
    /// information.
    pub source: InputSource,
    /// Is the pointer source being tracked right now?
    pub tracked: BtnState,
    /// What is the state of the input source’s ‘button’, if it has one?
    pub state: BtnState,
    /// A ray in the direction of the pointer.
    pub ray: Ray,
    /// Orientation of the pointer! Since a Ray has no concept of ‘up’, this can be used to retrieve more orientation
    /// information.
    pub orientation: Quat,
}

impl Pointer {
    /// Convenience function that turns ray.position and orientation into a Pose.
    /// <https://stereokit.net/Pages/StereoKit/Pointer/Pose.html>
    pub fn get_pose(&self) -> Pose {
        Pose::new(self.ray.position, Some(self.orientation))
    }
}

/// Contains information to represents a joint on the hand.
/// <https://stereokit.net/Pages/StereoKit/HandJoint.html>
///
/// see also  [`Input::hand`] [`Hand::get`] [`FingerId`] [`JointId`]
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::{Input, Handed, FingerId, JointId},
///                      maths::{Vec3, Quat, Pose, Ray}};
///
/// let hand = Input::hand(Handed::Left);
/// let index_root = hand.get(FingerId::Index, JointId::Root);
/// assert_eq!(index_root.position, Vec3 { x: -0.011, y: -0.038, z: 0.004 });
///
/// let hand = Input::hand(Handed::Right);
/// let index_root = hand.get(FingerId::Index, JointId::Root);
/// assert_eq!(index_root.position, Vec3 { x:  0.011, y: -0.038, z: 0.004 });
///
/// let index_tip = hand.get(FingerId::Index, JointId::Tip);
/// assert_eq!(index_tip.position, Vec3 { x: 0.029, y: 0.097, z: -0.041 });
/// assert_eq!(index_tip.orientation, Quat { x: -0.193, y: -0.004, z: 0.046, w: -0.98 });
/// assert_eq!(index_tip.radius, 0.007);
/// ```
#[derive(Debug, Copy, Clone, PartialEq)]
#[repr(C)]
pub struct HandJoint {
    /// The center of the joint’s world space location.
    pub position: Vec3,
    /// The joint’s world space orientation, where Forward points to the next joint down the finger, and Up will point
    /// towards the back of the hand. On the left hand, Right will point towards the thumb, and on the right hand, Right
    /// will point away from the thumb.
    pub orientation: Quat,
    /// The distance, in meters, to the surface of the hand from this joint.
    pub radius: f32,
}

/// Index values for each finger! From 0-4, from thumb to little finger.
/// <https://stereokit.net/Pages/StereoKit/FingerId.html>
///
/// see also  [`Input::hand`] [`Hand::get`] [`JointId`]
#[derive(Debug, Copy, Clone)]
#[repr(u32)]
pub enum FingerId {
    /// Thumb
    Thumb = 0,
    /// The primary index/pointer finger! Finger 1.
    Index = 1,
    /// next to the index finger.
    Middle = 2,
    /// ! What does one do with this finger? I guess… wear rings on it?
    Ring = 3,
    /// The smallest little finger! AKA, The Pinky.
    Little = 4,
}

/// Here’s where hands get crazy! Technical terms, and watch out for the thumbs!
/// <https://stereokit.net/Pages/StereoKit/JointId.html>
///
/// see also  [`Input::hand`] [`Hand::get`] [`FingerId`]
#[derive(Debug, Copy, Clone)]
#[repr(u32)]
pub enum JointId {
    /// This is at the base of the hand, right above the wrist. For the thumb, Root and KnuckleMajor have the same
    /// value.
    Root = 0,
    /// Joint 1. These are the knuckles at the top of the palm! For the thumb, Root and KnuckleMajor have the same
    /// value.
    KnuckleMajor = 1,
    ///  These are the knuckles in the middle of the finger! First joints on the fingers themselves.
    KnuckleMid = 2,
    /// The joints right below the fingertip!
    KnuckleMinor = 3,
    /// The end/tip of each finger!
    Tip = 4,
}

/// This enum provides information about StereoKit’s hand tracking data source. It allows you to distinguish between
/// true hand data such as that provided by a Leap Motion Controller, and simulated data that StereoKit provides when
/// true hand data is not present.
/// <https://stereokit.net/Pages/StereoKit/HandSource.html>
///
/// see also [`Input::hand_source`]
#[derive(Debug, Copy, Clone, PartialEq)]
#[repr(u32)]
pub enum HandSource {
    /// There is currently no source of hand data! This means there are no tracked controllers, or active hand tracking
    /// systems. This may happen if the user has hand tracking disabled, and no active controllers.
    None = 0,
    /// The current hand data is a simulation of hand data rather than true hand data. It is backed by either a
    /// controller, or a mouse, and may have a more limited range of motion.
    Simulated = 1,
    /// This is true hand data which exhibits the full range of motion of a normal hand. It is backed by something like
    /// a Leap Motion Controller, or some other optical (or maybe glove?) hand tracking system.
    Articulated = 2,
    /// This hand data is provided by your use of SK’s override functionality. What properties it exhibits depends on
    /// what override data you’re sending to StereoKit!
    Overridden = 3,
}

/// Id of a simulated hand pose, for use with Input.HandSimPoseRemove
/// <https://stereokit.net/Pages/StereoKit/HandSimId.html>
///
/// see also [`Input::hand_sim_pose_add`] [`Input::hand_sim_pose_remove`]
pub type HandSimId = i32;

#[derive(Debug, Copy, Clone)]
#[repr(C)]
/// Information about a hand!
/// <https://stereokit.net/Pages/StereoKit/Hand.html>
///
/// see also [`Input::hand`]
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::{Hierarchy, Input, Handed, FingerId, JointId}, util::named_colors,
///                      maths::{Vec3, Quat, Pose, Matrix}, mesh::Mesh, material::Material};
///
/// let hand = Input::hand(Handed::Left);
/// let thumb_tip = hand.get(FingerId::Thumb, JointId::Tip);
///
/// let sphere = Mesh::generate_sphere(1.0, Some(12));
/// let mut material_sphere = Material::pbr().copy();
/// let main_transform = Matrix::t_r([0.0, -0.05, 0.88], [0.0, 210.0, 0.0]);
///
/// filename_scr = "screenshots/hand.jpeg";
/// test_screenshot!( // !!!! Get a proper main loop !!!!
///     for finger in 0..5 {
///         for joint in 0..5 {
///             let joint_pose = hand.get_u(finger, joint);
///             let transform = Matrix::t_s(joint_pose.position, Vec3::ONE * joint_pose.radius);
///             Hierarchy::push(token, main_transform, None);
///                 sphere.draw(token, &material_sphere, transform, Some(named_colors::BLACK.into()), None);
///             Hierarchy::pop(token);
///         }
///     }
/// );
/// ```
/// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/hand.jpeg" alt="screenshot" width="200">
///
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::{Input, Handed, FingerId, JointId, BtnState, Hand, HandJoint},
///                      maths::{Vec3, Quat, Pose}};
///
/// let hand = Input::hand(Handed::Left);
/// let thumb_tip = hand.get(FingerId::Thumb, JointId::Tip);
/// assert_eq!(thumb_tip.position, Vec3 { x: -0.072, y: 0.028, z: -0.055 });
///
/// let hand = Input::hand(Handed::Right);
///
/// let thumb_tip  = hand.get(FingerId::Thumb, JointId::Tip);
/// let thumb_tip2 = hand.get_u(0,4);
/// let thumb_tip3 = hand.fingers[FingerId::Thumb as usize][JointId::Tip as usize];
/// assert_eq!(thumb_tip.position, Vec3 { x: 0.072, y: 0.028, z: -0.055 });
/// assert_eq!(thumb_tip, thumb_tip2);
/// assert_eq!(thumb_tip, thumb_tip3);
///
/// assert_eq!(hand.wrist,      Pose::ZERO);
/// assert_eq!(hand.palm,       Pose::IDENTITY);
/// assert_eq!(hand.aim,        Pose::ZERO);
/// assert_eq!(hand.pinch_pt,   Vec3::ZERO);
/// assert_eq!(hand.handed,     Handed::Right);
/// assert_eq!(hand.tracked,    BtnState::Inactive);
/// assert_eq!(hand.pinch,      BtnState::Inactive);
/// assert_eq!(hand.grip,       BtnState::Inactive);
/// assert_eq!(hand.aim_ready,  BtnState::Inactive);
///
/// assert_eq!(hand.is_gripped(), false);
/// assert_eq!(hand.is_just_gripped(), false);
/// assert_eq!(hand.is_just_ungripped(), false);
/// assert_eq!(hand.is_pinched(), false);
/// assert_eq!(hand.is_just_pinched(), false);
/// assert_eq!(hand.is_just_unpinched(), false);
/// assert_eq!(hand.is_tracked(), false);
/// assert_eq!(hand.is_just_tracked(), false);
/// assert_eq!(hand.is_just_untracked(), false);
/// ```
pub struct Hand {
    /// This is a 2D array with 25 HandJoints. You can get the right joint by finger*5 + joint
    pub fingers: [[HandJoint; 5usize]; 5usize],
    /// Pose of the wrist. TODO: Not populated right now.
    pub wrist: Pose,
    /// The position and orientation of the palm! Position is specifically defined as the middle of the middle finger’s
    /// root (metacarpal) bone. For orientation, Forward is the direction the flat of the palm is facing, “Iron Man”
    /// style. X+ is to the outside of the right hand, and to the inside of the left hand.
    pub palm: Pose,
    /// A pose an orientation representing where the hand is pointing to. This may be provided by the OpenXR runtime, or
    /// be a fallback provided by StereoKit. Typically this starts and the index finger's primary knuckle, and points in
    /// the same direction as a line drawn from the shoulder to the knuckle.
    pub aim: Pose,
    /// This is an approximation of where the center of a ‘pinch’ gesture occurs, and is used internally by StereoKit
    /// for some tasks, such as UI. For simulated hands, this position will give you the most stable pinch location
    /// possible. For real hands, it’ll be pretty close to the stablest point you’ll get. This is especially important
    /// for when the user begins and ends their pinch action, as you’ll often see a lot of extra movement in the fingers
    /// then.
    pub pinch_pt: Vec3,
    /// Is this a right hand, or a left hand?
    pub handed: Handed,
    /// Is the hand being tracked by the sensors right now?
    pub tracked: BtnState,
    /// Is the hand making a pinch gesture right now? Finger and thumb together.
    pub pinch: BtnState,
    /// Is the hand making a grip gesture right now? Fingers next to the palm.
    pub grip: BtnState,
    /// This is a filter state for when the hand is ready to interact with something at a distance. This often factors
    /// into account palm direction, as well as distance from the body, and the current pinch and tracked state.
    pub aim_ready: BtnState,
    /// This is the size of the hand, calculated by measuring the length of the middle finger! This is calculated by
    /// adding the distances between each joint, then adding the joint radius of the root and tip. This value is
    /// recalculated at relatively frequent intervals, and can vary by as much as a centimeter.
    pub size: f32,
    /// What percentage of activation is the pinch gesture right now? Where 0 is a hand in an outstretched resting
    /// position, and 1 is fingers touching, within a device error tolerant threshold.
    pub pinch_activation: f32,
    /// What percentage of activation is the grip gesture right now? Where 0 is a hand in an outstretched resting
    /// position, and 1 is ring finger touching the base of the palm, within a device error tolerant threshold.
    pub grip_activation: f32,
}

impl Hand {
    /// Returns the joint information of the indicated hand joint! This also includes fingertips as a ‘joint’. This is
    /// the same as the [] operator. Note that for thumbs, there are only 4 ‘joints’ in reality, so StereoKit has
    /// JointId.Root and JointId.KnuckleMajor as the same pose, so JointId.Tip is still the tip of the thumb!
    /// <https://stereokit.net/Pages/StereoKit/Hand/Get.html>
    pub fn get(&self, finger: FingerId, joint: JointId) -> HandJoint {
        self.fingers[finger as usize][joint as usize]
    }

    /// Returns the joint information of the indicated hand joint! This also includes fingertips as a ‘joint’. This is
    /// the same as the [] operator. Note that for thumbs, there are only 4 ‘joints’ in reality, so StereoKit has
    /// JointId.Root and JointId.KnuckleMajor as the same pose, so JointId.Tip is still the tip of the thumb!
    /// <https://stereokit.net/Pages/StereoKit/Hand/Get.html>
    pub fn get_u(&self, finger: usize, joint: usize) -> HandJoint {
        self.fingers[finger][joint]
    }

    /// Are the fingers currently gripped?
    /// <https://stereokit.net/Pages/StereoKit/Hand/IsGripped.html>
    pub fn is_gripped(&self) -> bool {
        (self.grip & BtnState::Active) > BtnState::Inactive
    }

    /// Have the fingers just been gripped this frame?
    /// <https://stereokit.net/Pages/StereoKit/Hand/IsJustGripped.html>
    pub fn is_just_gripped(&self) -> bool {
        (self.grip & BtnState::JustActive) > BtnState::Inactive
    }

    /// Have the fingers just stopped being gripped this frame?
    /// <https://stereokit.net/Pages/StereoKit/Hand/IsJustUngripped.html>
    pub fn is_just_ungripped(&self) -> bool {
        (self.grip & BtnState::JustInactive) > BtnState::Inactive
    }

    /// Are the fingers currently pinched?
    /// <https://stereokit.net/Pages/StereoKit/Hand/IsPinched.html>
    pub fn is_pinched(&self) -> bool {
        (self.pinch & BtnState::Active) > BtnState::Inactive
    }

    /// Have the fingers just been pinched this frame?
    /// <https://stereokit.net/Pages/StereoKit/Hand/IsJustPinched.html>
    pub fn is_just_pinched(&self) -> bool {
        (self.pinch & BtnState::JustActive) > BtnState::Inactive
    }

    /// Have the fingers just stopped being pinched this frame?
    /// <https://stereokit.net/Pages/StereoKit/Hand/IsJustUnpinched.html>
    pub fn is_just_unpinched(&self) -> bool {
        (self.pinch & BtnState::JustInactive) > BtnState::Inactive
    }

    /// Is the hand being tracked by the sensors right now?
    /// <https://stereokit.net/Pages/StereoKit/Hand/IsTracked.html>
    pub fn is_tracked(&self) -> bool {
        (self.tracked & BtnState::Active) > BtnState::Inactive
    }

    /// Has the hand just started being tracked this frame?
    /// <https://stereokit.net/Pages/StereoKit/Hand/IsJustTracked.html>
    pub fn is_just_tracked(&self) -> bool {
        (self.tracked & BtnState::JustActive) > BtnState::Inactive
    }

    /// Has the hand just stopped being tracked this frame?
    /// <https://stereokit.net/Pages/StereoKit/Hand/IsJustUntracked.html>
    pub fn is_just_untracked(&self) -> bool {
        (self.tracked & BtnState::JustInactive) > BtnState::Inactive
    }

    /// Set the Material used to render the hand! The default material uses an offset of 10 to ensure it gets drawn
    /// overtop of other elements.
    /// <https://stereokit.net/Pages/StereoKit/Hand/Material.html>
    ///
    /// see also [`input_hand_material`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Input, Handed, Hand}, material::Material, util::Color128};
    ///
    /// let mut hand = Input::hand(Handed::Right);
    ///
    /// let mut material = Material::hand().copy();
    /// material.color_tint(Color128::new(0.8, 0.5, 0.1, 1.0));
    /// hand.material(&material);
    ///
    /// assert_ne!(material, Material::hand())
    /// ```
    pub fn material(&mut self, material: impl AsRef<Material>) -> &mut Self {
        unsafe { input_hand_material(self.handed, material.as_ref().0.as_ptr()) }
        self
    }

    /// Sets whether or not StereoKit should render this hand for you. Turn this to false if you’re going to render your
    /// own, or don’t need the hand itself to be visible.
    /// <https://stereokit.net/Pages/StereoKit/Hand/Visible.html>
    ///
    /// see also [`input_hand_visible`]
    pub fn visible(&mut self, visible: bool) -> &mut Self {
        unsafe { input_hand_visible(self.handed, visible as Bool32T) }
        self
    }
}

/// Represents an input from an XR headset’s controller!
/// <https://stereokit.net/Pages/StereoKit/ControllerKey.html>
///
/// see also [`Input::hand_sim_pose_add`]
#[derive(Debug, Copy, Clone)]
#[repr(u32)]
pub enum ControllerKey {
    /// Doesn’t represent a key, generally means this item has not been set to any particular value!
    None_ = 0,
    /// The trigger button on the controller, where the user’s index finger typically sits.
    Trigger = 1,
    /// The grip button on the controller, usually where the fingers that are not the index finger sit.
    Grip = 2,
    /// This is the lower of the two primary thumb buttons, sometimes labelled X, and sometimes A.
    X1 = 3,
    /// This is the upper of the two primary thumb buttons, sometimes labelled Y, and sometimes B.
    X2 = 4,
    /// This is when the thumbstick on the controller is actually pressed. This has nothing to do with the horizontal
    /// or vertical movement of the stick.
    Stick = 5,
    /// This is the menu, or settings button of the controller.
    Menu = 6,
}

/// This represents a physical controller input device! Tracking information, buttons, analog sticks and triggers!
/// There’s also a Menu button that’s tracked separately at Input.ContollerMenu.
/// <https://stereokit.net/Pages/StereoKit/Controller.html>
///
/// see also [`Input::controller`]
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::{Hierarchy, Input, Handed},
///                      maths::{Matrix}, model::Model, material::Material};
///
/// let model_left = Input::get_controller_model(Handed::Left);
/// let model_right = Input::get_controller_model(Handed::Right);
/// let transform_left = Matrix::t_r([-0.05, 0.0, 0.93], [90.0, 00.0, 0.0]);
/// let transform_right = Matrix::t_r([0.05, 0.0, 0.93], [90.0, 00.0, 0.0]);
///
/// filename_scr = "screenshots/controller.jpeg";
/// test_screenshot!( // !!!! Get a proper main loop !!!!
///     model_left.draw(token, transform_left, None, None);
///     model_right.draw(token, transform_right, None, None);
/// );
/// ```
/// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/controller.jpeg" alt="screenshot" width="200">
///
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::{Input, Handed, BtnState, TrackState},
///                      maths::{Vec2, Vec3, Quat, Pose}};
///
/// let controller = Input::controller(Handed::Left);
///
/// let controller = Input::controller(Handed::Right);
///
/// assert_eq!(controller.pose,       Pose::ZERO);
/// assert_eq!(controller.palm,       Pose::ZERO);
/// assert_eq!(controller.aim,        Pose::ZERO);
/// assert_eq!(controller.tracked,    BtnState::Inactive);
/// assert_eq!(controller.tracked_pos, TrackState::Lost);
/// assert_eq!(controller.tracked_rot, TrackState::Lost);
/// assert_eq!(controller.x1,         BtnState::Inactive);
/// assert_eq!(controller.x2,         BtnState::Inactive);
/// assert_eq!(controller.trigger,    0.0);
/// assert_eq!(controller.grip,       0.0);
/// assert_eq!(controller.stick,      Vec2::ZERO);
///
/// assert_eq!(controller.is_just_tracked(), false);
/// assert_eq!(controller.is_just_untracked(), false);
/// assert_eq!(controller.is_stick_clicked(), false);
/// assert_eq!(controller.is_stick_just_clicked(), false);
/// assert_eq!(controller.is_tracked(), false);
/// assert_eq!(controller.is_x1_just_pressed(), false);
/// assert_eq!(controller.is_x1_just_unpressed(), false);
/// assert_eq!(controller.is_x1_pressed(), false);
/// assert_eq!(controller.is_x2_just_pressed(), false);
/// assert_eq!(controller.is_x2_just_unpressed(), false);
/// assert_eq!(controller.is_x2_pressed(), false);
/// ```
#[derive(Debug, Copy, Clone)]
#[repr(C)]
pub struct Controller {
    /// The grip pose of the controller. This approximately represents the center of the hand’s position. Check
    /// trackedPos and trackedRot for the current state of the pose data.
    pub pose: Pose,
    pub palm: Pose,
    /// The aim pose of a controller is where the controller ‘points’ from and to. This is great for pointer rays and
    /// far interactions.
    pub aim: Pose,
    /// This tells the current tracking state of this controller overall. If either position or rotation are trackable,
    /// then this will report tracked. Typically, positional tracking will be lost first, when the controller goes out
    /// of view, and rotational tracking will often remain as long as the controller is still connected. This is a good
    /// way to check if the controller is connected to the system at all.
    pub tracked: BtnState,
    /// This tells the current tracking state of the controller’s position information. This is often the first part of
    /// tracking data to go, so it can often be good to account for this on occasions.
    pub tracked_pos: TrackState,
    /// This tells the current tracking state of the controller’s rotational information.
    pub tracked_rot: TrackState,
    /// This represents the click state of the controller’s analog stick or directional controller.
    pub stick_click: BtnState,
    /// The current state of the controller’s X1 button. Depending on the specific hardware, this is the first general
    /// purpose button on the controller. For example, on an Oculus Quest Touch controller this would represent ‘X’ on
    /// the left controller, and ‘A’ on the right controller.
    pub x1: BtnState,
    ///The current state of the controller’s X2 button. Depending on the specific hardware, this is the second general
    /// purpose button on the controller. For example, on an Oculus Quest Touch controller this would represent ‘Y’ on
    /// the left controller, and ‘B’ on the right controller.
    pub x2: BtnState,
    /// The trigger button at the user’s index finger. These buttons typically have a wide range of activation, so this
    /// is provided as a value from 0.0 -> 1.0, where 0 is no interaction, and 1 is full interaction. If a controller
    /// has binary activation, this will jump straight from 0 to 1.
    pub trigger: f32,
    /// The grip button typically sits under the user’s middle finger. These buttons occasionally have a wide range of
    /// activation, so this is provided as a value from 0.0 -> 1.0, where 0 is no interaction, and 1 is full
    /// interaction. If a controller has binary activation, this will jump straight from 0 to 1.
    pub grip: f32,
    /// This is the current 2-axis position of the analog stick or equivalent directional controller. This generally
    /// ranges from -1 to +1 on each axis. This is a raw input, so dead-zones and similar issues are not accounted for
    /// here, unless modified by the OpenXR platform itself.
    pub stick: Vec2,
}

impl Controller {
    /// Is the controller’s X1 button currently pressed? Depending on the specific hardware, this is the first
    /// general purpose button on the controller. For example, on an Oculus Quest Touch controller this would
    /// represent ‘X’ on the left controller, and ‘A’ on the right controller.
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsX1Pressed.html>
    pub fn is_x1_pressed(&self) -> bool {
        (self.x1 & BtnState::Active) > BtnState::Inactive
    }

    /// Has the controller’s X1 button just been pressed this frame? Depending on the specific hardware, this is the
    /// first general purpose button on the controller. For example, on an Oculus Quest Touch controller this would
    /// represent ‘X’ on the left controller, and ‘A’ on the right controller.
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsX1JustPressed.html>
    pub fn is_x1_just_pressed(&self) -> bool {
        (self.x1 & BtnState::JustActive) > BtnState::Inactive
    }

    /// Has the controller’s X1 button just been released this frame? Depending on the specific hardware, this is
    /// the first general purpose button on the controller. For example, on an Oculus Quest Touch controller this
    /// would represent ‘X’ on the left controller, and ‘A’ on the right controller.
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsX1JustUnPressed.html>
    pub fn is_x1_just_unpressed(&self) -> bool {
        (self.x1 & BtnState::JustInactive) > BtnState::Inactive
    }

    /// Is the controller’s X2 button currently pressed? Depending on the specific hardware, this is the second
    /// general purpose button on the controller. For example, on an Oculus Quest Touch controller this would
    /// represent ‘Y’ on the left controller, and ‘B’ on the right controller.
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsX2Pressed.html>
    pub fn is_x2_pressed(&self) -> bool {
        (self.x2 & BtnState::Active) > BtnState::Inactive
    }

    /// Has the controller’s X2 button just been pressed this frame? Depending on the specific hardware, this is the
    /// second general purpose button on the controller. For example, on an Oculus Quest Touch controller this would
    /// represent ‘Y’ on the left controller, and ‘B’ on the right controller.
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsX2JustPressed.html>
    pub fn is_x2_just_pressed(&self) -> bool {
        (self.x2 & BtnState::JustActive) > BtnState::Inactive
    }

    /// Has the controller’s X2 button just been released this frame? Depending on the specific hardware, this is
    /// the second general purpose button on the controller. For example, on an Oculus Quest Touch controller this
    /// would represent ‘Y’ on the left controller, and ‘B’ on the right controller.
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsX2JustUnPressed.html>
    pub fn is_x2_just_unpressed(&self) -> bool {
        (self.x2 & BtnState::JustInactive) > BtnState::Inactive
    }

    /// Is the analog stick/directional controller button currently being actively pressed?
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsStickClicked.html>
    pub fn is_stick_clicked(&self) -> bool {
        (self.stick_click & BtnState::Active) > BtnState::Inactive
    }

    /// Is the analog stick/directional controller button currently being actively pressed?
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsStickJustClicked.html>
    pub fn is_stick_just_clicked(&self) -> bool {
        (self.stick_click & BtnState::JustActive) > BtnState::Inactive
    }

    /// Has the analog stick/directional controller button just been released this frame?
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsStickJustUnclicked.html>
    pub fn is_stick_just_unclicked(&self) -> bool {
        (self.stick_click & BtnState::JustInactive) > BtnState::Inactive
    }

    /// Is the controller being tracked by the sensors right now?
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsTracked.html>
    pub fn is_tracked(&self) -> bool {
        (self.tracked & BtnState::Active) > BtnState::Inactive
    }

    /// Has the controller just started being tracked this frame?
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsJustTracked.html>
    pub fn is_just_tracked(&self) -> bool {
        (self.tracked & BtnState::JustActive) > BtnState::Inactive
    }

    /// Has the analog stick/directional controller button just been released this frame?
    /// <https://stereokit.net/Pages/StereoKit/Controller/IsJustUntracked.html>
    pub fn is_just_untracked(&self) -> bool {
        (self.tracked & BtnState::JustInactive) > BtnState::Inactive
    }
}

/// This stores information about the mouse! What’s its state, where’s it pointed, do we even have one?
/// <https://stereokit.net/Pages/StereoKit/Mouse.html>
///
/// see also [`Input::get_mouse`]
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::Input, maths::{Vec2, Vec3}};
///
/// let mouse = Input::get_mouse();
///
/// assert_eq!(mouse.is_available(),false);
/// assert_eq!(mouse.pos,           Vec2::ZERO);
/// assert_eq!(mouse.pos_change,    Vec2::ZERO);
/// assert_eq!(mouse.scroll,        0.0);
/// assert_eq!(mouse.scroll_change, 0.0);
///
/// assert_eq!(mouse.get_ray().position, Vec3::ZERO);
/// // Warning: No ray if the mouse isn't available!
/// // assert_eq!(mouse.get_ray().direction, Vec3::new(f32::NAN, f32::NAN, f32::NAN));
/// ```
#[derive(Debug, Copy, Clone)]
#[repr(C)]
pub struct Mouse {
    /// Is the mouse available to use? Most MR systems likely won’t have a mouse!
    pub available: Bool32T,
    /// Position of the mouse relative to the window it’s in! This is the number of pixels from the top left corner of
    /// the screen.
    pub pos: Vec2,
    /// How much has the mouse’s position changed in the current frame? Measured in pixels.
    pub pos_change: Vec2,
    /// What’s the current scroll value for the mouse’s scroll wheel? TODO: Units
    pub scroll: f32,
    /// How much has the scroll wheel value changed during this frame? TODO: Units
    pub scroll_change: f32,
}

impl Mouse {
    /// Ray representing the position and orientation that the current Input::get_mouse() is pointing in.
    /// <https://stereokit.net/Pages/StereoKit/Mouse/Ray.html>
    ///
    /// see also [`ray_from_mouse`]
    pub fn get_ray(&self) -> Ray {
        let mut out_ray = Ray::default();
        unsafe { ray_from_mouse(self.pos, &mut out_ray) };
        out_ray
    }

    /// Is the mouse available ?
    /// <https://stereokit.net/Pages/StereoKit/Mouse/Available.html>
    pub fn is_available(&self) -> bool {
        self.available != 0
    }
}

/// A collection of system key codes, representing keyboard characters and mouse buttons. Based on VK codes.
/// <https://stereokit.net/Pages/StereoKit/Key.html>
///
/// see also [`Input::key`] [`Input::key_inject_press`] [`Input::key_inject_release`] [`Input::hand_sim_pose_add`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum Key {
    None = 0,
    MouseLeft = 1,
    MouseRight = 2,
    MouseCenter = 4,
    MouseForward = 5,
    MouseBack = 6,
    Backspace = 8,
    Tab = 9,
    Return = 13,
    Shift = 16,
    Ctrl = 17,
    Alt = 18,
    CapsLock = 20,
    Esc = 27,
    Space = 32,
    End = 35,
    Home = 36,
    Left = 37,
    Right = 39,
    Up = 38,
    Down = 40,
    PageUp = 33,
    PageDown = 34,
    PrintScreen = 42,
    KeyInsert = 45,
    Del = 46,
    Key0 = 48,
    Key1 = 49,
    Key2 = 50,
    Key3 = 51,
    Key4 = 52,
    Key5 = 53,
    Key6 = 54,
    Key7 = 55,
    Key8 = 56,
    Key9 = 57,
    A = 65,
    B = 66,
    C = 67,
    D = 68,
    E = 69,
    F = 70,
    G = 71,
    H = 72,
    I = 73,
    J = 74,
    K = 75,
    L = 76,
    M = 77,
    N = 78,
    O = 79,
    P = 80,
    Q = 81,
    R = 82,
    S = 83,
    T = 84,
    U = 85,
    V = 86,
    W = 87,
    X = 88,
    Y = 89,
    Z = 90,
    Numpad0 = 96,
    Numpad1 = 97,
    Numpad2 = 98,
    Numpad3 = 99,
    Numpad4 = 100,
    Numpad5 = 101,
    Numpad6 = 102,
    Numpad7 = 103,
    Numpad8 = 104,
    Numpad9 = 105,
    F1 = 112,
    F2 = 113,
    F3 = 114,
    F4 = 115,
    F5 = 116,
    F6 = 117,
    F7 = 118,
    F8 = 119,
    F9 = 120,
    F10 = 121,
    F11 = 122,
    F12 = 123,
    Comma = 188,
    Period = 190,
    SlashFwd = 191,
    SlashBack = 220,
    Semicolon = 186,
    Apostrophe = 222,
    BracketOpen = 219,
    BracketClose = 221,
    Minus = 189,
    Equals = 187,
    Backtick = 192,
    LCmd = 91,
    RCmd = 92,
    Multiply = 106,
    Add = 107,
    Subtract = 109,
    Decimal = 110,
    Divide = 111,
}

/// Input from the system come from this class! Hands, eyes, heads, mice and pointers!
/// <https://stereokit.net/Pages/StereoKit/Input.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::{Input, InputSource, Handed},
///                      maths::{Vec2, Vec3, Quat, Pose}};
///
/// let controller = Input::controller(Handed::Left);
/// assert_eq!(controller.is_tracked(), false);
///
/// let hand = Input::hand(Handed::Right);
/// assert_eq!(hand.is_tracked(), false);
///
/// let head = Input::get_head();
/// assert_eq!(head , Pose::IDENTITY);
///
/// let mouse = Input::get_mouse();
/// assert_eq!(mouse.is_available(), false);
///
/// assert_eq!(Input::pointer_count(None), 0);
/// let pointer = Input::pointer(0, Some(InputSource::Hand));
/// assert_eq!(pointer.source, InputSource::None);
/// ```
pub struct Input;

unsafe extern "C" {
    pub fn input_pointer_count(filter: InputSource) -> i32;
    pub fn input_pointer(index: i32, filter: InputSource) -> Pointer;
    pub fn input_hand(hand: Handed) -> *const Hand;
    pub fn input_hand_override(hand: Handed, in_arr_hand_joints: *const HandJoint);
    pub fn input_hand_source(hand: Handed) -> HandSource;
    pub fn input_controller(hand: Handed) -> *const Controller;
    pub fn input_controller_menu() -> BtnState;
    pub fn input_controller_model_set(hand: Handed, model: ModelT);
    pub fn input_controller_model_get(hand: Handed) -> ModelT;
    pub fn input_head() -> Pose;
    pub fn input_eyes() -> Pose;
    pub fn input_eyes_tracked() -> BtnState;
    pub fn input_mouse() -> *const Mouse;
    pub fn input_key(key: Key) -> BtnState;
    pub fn input_key_inject_press(key: Key);
    pub fn input_key_inject_release(key: Key);
    pub fn input_text_consume() -> u32;
    pub fn input_text_reset();
    pub fn input_text_inject_char(character: u32);
    pub fn input_hand_visible(hand: Handed, visible: Bool32T);
    // Deprecated: pub fn input_hand_solid(hand: Handed, solid: Bool32T);
    pub fn input_hand_material(hand: Handed, material: MaterialT);
    pub fn input_get_finger_glow() -> Bool32T;
    pub fn input_set_finger_glow(visible: Bool32T);
    pub fn input_hand_sim_pose_add(
        in_arr_palm_relative_hand_joints_25: *const Pose,
        button1: ControllerKey,
        and_button2: ControllerKey,
        or_hotkey1: Key,
        and_hotkey2: Key,
    ) -> HandSimId;
    pub fn input_hand_sim_pose_remove(id: HandSimId);
    pub fn input_hand_sim_pose_clear();

    #[deprecated(since = "0.4.0", note = "Not working anymore")]
    pub fn input_subscribe(
        source: InputSource,
        input_event: BtnState,
        input_event_callback: Option<
            unsafe extern "C" fn(source: InputSource, input_event: BtnState, in_pointer: *const Pointer),
        >,
    );

    #[deprecated(since = "0.4.0", note = "Not working anymore")]
    pub fn input_unsubscribe(
        source: InputSource,
        input_event: BtnState,
        input_event_callback: Option<
            unsafe extern "C" fn(source: InputSource, input_event: BtnState, in_pointer: *const Pointer),
        >,
    );

    #[deprecated(since = "0.4.0", note = "Not working anymore")]
    pub fn input_fire_event(source: InputSource, input_event: BtnState, pointer: *const Pointer);
}

impl Input {
    /// When StereoKit is rendering the input source, this allows you to override the controller Model SK uses. The
    /// Model SK uses by default may be provided from the OpenXR runtime depending on extension support, but if not, SK
    /// does have a default Model.
    /// Setting this to None will restore SK's default.
    /// <https://stereokit.net/Pages/StereoKit/Input/ControllerModelSet.html>
    /// * `handed` - The hand to assign the Model to.
    /// * `model` - The Model to use to represent the controller.
    ///   None is valid, and will restore SK's default model.
    ///
    ///  see also [`input_controller_model_set`]  [`Input::get_controller_model`]  
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Input, Handed}, model::Model};
    ///
    /// assert_eq!(Input::get_controller_model(Handed::Left).get_id(), "default/model_controller_l");
    ///
    /// let model_left = Model::from_file("center.glb", None)
    ///                     .expect("mobiles.gltf should be a valid model");
    ///
    /// Input::set_controller_model(Handed::Left, Some(&model_left));
    /// assert_eq!(Input::get_controller_model(Handed::Left).get_id(), "center.glb");
    ///
    /// Input::set_controller_model(Handed::Left, None);
    /// assert_eq!(Input::get_controller_model(Handed::Left).get_id(), "default/model_controller_l");
    /// ```
    pub fn set_controller_model(handed: Handed, model: Option<&Model>) {
        match model {
            Some(model) => unsafe { input_controller_model_set(handed, model.0.as_ptr()) },
            None => unsafe { input_controller_model_set(handed, null_mut()) },
        }
    }

    /// Gets raw controller input data from the system. Note that not all buttons provided here are guaranteed to be
    /// present on the user’s physical controller. Controllers are also not guaranteed to be available on the system,
    /// and are never simulated.
    /// <https://stereokit.net/Pages/StereoKit/Input/Controller.html>
    /// * `handed` - The handedness of the controller to get the state of.
    ///
    /// Returns a reference to a class that contains state information  about the indicated controller.
    /// see also [`input_controller`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Input, Handed, TrackState};
    ///
    /// let controller = Input::controller(Handed::Right);
    ///
    /// assert_eq!(controller.tracked_pos, TrackState::Lost);
    /// assert_eq!(controller.tracked_rot, TrackState::Lost);
    /// ```
    pub fn controller(handed: Handed) -> Controller {
        unsafe { *input_controller(handed) }
    }

    /// This function allows you to artifically insert an input event, simulating any device source and event type you
    /// want.
    /// <https://stereokit.net/Pages/StereoKit/Input/FireEvent.html>
    /// * `event_source` - The event source to simulate, this is a bit flag.
    /// * `event_types` - The event type to simulate, this is a bit flag.
    /// * `pointer` - The pointer data to pass along with this simulated input event.
    ///
    /// see also [`input_fire_event`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Input, InputSource, Pointer, BtnState, Handed, TrackState},
    ///                      maths::{Vec3, Quat, Pose, Ray}};
    ///
    /// let pointer = Input::pointer(0, None);
    /// assert_eq!(pointer.source, InputSource::None);
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     assert_eq!(pointer.state, BtnState::Inactive);
    ///     assert_eq!(pointer.tracked, BtnState::Inactive);
    ///     if iter == 0 {    
    ///         Input::fire_event(InputSource::CanPress, BtnState::Active, &pointer);
    ///     } else if iter == 1 {
    ///         Input::fire_event(InputSource::Hand | InputSource::HandLeft, BtnState::JustInactive, &pointer);
    ///     }
    /// );
    /// ```
    #[deprecated(since = "0.4.0", note = "Not working anymore")]
    #[allow(deprecated)]
    pub fn fire_event(event_source: InputSource, event_types: BtnState, pointer: &Pointer) {
        unsafe { input_fire_event(event_source, event_types, pointer) };
    }

    /// Retrieves all the information about the user’s hand! StereoKit will always provide hand information, however
    /// sometimes that information is simulated, like in the case of a mouse, or controllers.
    ///
    /// Note that this is a pointer to the hand information, and it’s a good chunk of data, so it’s a good idea to grab
    /// it once and keep it around for the frame, or at least function, rather than asking for it again and again each
    /// time you want to touch something.
    /// <https://stereokit.net/Pages/StereoKit/Input/Hand.html>
    /// * `handed` - Do you want the left or the right hand? 0 is left, and 1 is right.
    ///
    /// Returns a copy of the entire set of hand data!
    /// see also [`input_hand`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Input, Handed, Hand, HandJoint, FingerId, JointId};
    /// use stereokit_rust::maths::{Vec3, Quat, Pose};
    ///
    /// let hand = Input::hand(Handed::Left);
    /// let thumb_tip = hand.get(FingerId::Thumb, JointId::Tip);
    /// assert_eq!(thumb_tip.position, Vec3 { x: -0.072, y: 0.028, z: -0.055 });
    ///
    /// let hand = Input::hand(Handed::Right);
    /// let thumb_tip = hand.get(FingerId::Thumb, JointId::Tip);
    /// assert_eq!(thumb_tip.position, Vec3 { x: 0.072, y: 0.028, z: -0.055 });
    /// ```
    pub fn hand(handed: Handed) -> Hand {
        unsafe { *input_hand(handed) }
    }

    /// Clear out the override status from Input::hand_override, and restore the user’s control over it again.
    /// <https://stereokit.net/Pages/StereoKit/Input/HandClearOverride.html>
    /// * `hand` - Which hand are we clearing the override on?
    ///
    /// see also [`input_hand_override`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Input, Handed, HandJoint, FingerId, JointId},
    ///                      maths::{Vec3, Quat}};
    ///
    /// let mut hand_joints = [HandJoint { position: Vec3::ZERO, orientation: Quat::IDENTITY, radius: 0.0 }; 25];
    ///
    /// Input::hand_override(Handed::Left, &hand_joints);
    ///
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     if iter == 0 {
    ///         let hand = Input::hand(Handed::Left);
    ///         let thumb_tip = hand.get(FingerId::Thumb, JointId::Tip);
    ///         assert_eq!(thumb_tip.position, Vec3::ZERO);
    ///     } else if iter == 1 {
    ///         Input::hand_clear_override(Handed::Left);
    ///     }
    /// );
    /// ```
    pub fn hand_clear_override(hand: Handed) {
        unsafe { input_hand_override(hand, null()) };
    }

    /// This allows you to completely override the hand’s pose information! It is still treated like the user’s hand,
    /// so this is great for simulating input for testing purposes. It will remain overridden until you call
    /// Input::hand_clear_override.
    /// <https://stereokit.net/Pages/StereoKit/Input/HandOverride.html>
    /// * `hand` - Which hand should be overridden?
    /// * `joints` - A 2D array of 25 joints that should be used as StereoKit's hand information. See `Hand.fingers`
    ///   for more information.
    ///
    /// see also [`input_hand_override`]
    /// see example in [`Input::hand_clear_override`]
    pub fn hand_override(hand: Handed, joints: &[HandJoint]) {
        unsafe { input_hand_override(hand, joints.as_ptr()) };
    }

    /// Set the Material used to render the hand! The default material uses an offset of 10 to ensure it gets drawn
    /// overtop of other elements.
    /// <https://stereokit.net/Pages/StereoKit/Input/HandMaterial.html>
    /// * `hand` - The hand to assign the Material to. If Handed::Max, this will set the value for both hands.
    /// * `material` - The new material. If None, will reset to the default value
    ///
    /// see also [`input_hand_material`] [`Material::hand`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Input, Handed}, util::named_colors,
    ///                      material::Material};
    ///
    /// let mut hand_material = Material::hand().copy();
    /// hand_material.color_tint(named_colors::YELLOW).id("My_hand_material");
    /// Input::hand_material(Handed::Left, Some(hand_material));
    ///
    /// test_steps! ( // !!!! Get a proper main loop !!!!
    ///     if iter == 0 {
    ///         // Of course, Material::hand() is not modified.
    ///         assert_eq!(Material::hand().get_id(), "default/material_hand");
    ///     } else if iter == 1 {
    ///         // The reason why Material::hand() should not be modified:
    ///         Input::hand_material(Handed::Left, None);
    ///     }
    /// );
    /// ```
    pub fn hand_material(hand: Handed, material: Option<Material>) {
        match material {
            Some(material) => unsafe { input_hand_material(hand, material.0.as_ptr()) },
            None => unsafe { input_hand_material(hand, null_mut()) },
        }
    }

    /// StereoKit will use controller inputs to simulate an articulated hand. This function allows you to add new
    /// simulated poses to different controller or keyboard buttons!
    /// <https://stereokit.net/Pages/StereoKit/Input/HandSimPoseAdd.html>
    /// * `hand_joints_palm_relative_25` - 25 joint poses, thumb to pinky, and root to tip with two duplicate poses for
    ///   the thumb root joint. These should be right handed, and relative to the palm joint.
    /// * `button1` - Controller button to activate this pose, can/ be None if this is a keyboard only pose.
    /// * `and_button2` - Second controller button required to activate this pose. First must also be pressed. Can be
    ///   None if it's only a single button pose.
    /// * `or_hotkey1` - Keyboard key to activate this pose, can be None if this is a controller only pose.
    /// * `and_hotkey2` - Second keyboard key required to activatethis pose. First must also be pressed. Can be None if
    ///   it's only a single key pose.
    ///
    /// Returns the id of the hand sim pose, so it can be removed later.
    /// see also [`input_hand_sim_pose_add`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Input, Handed, HandJoint, FingerId, JointId, ControllerKey, Key},
    ///                      maths::{Vec3, Quat, Pose}};
    ///
    /// let hand_joints = [Pose::IDENTITY;25];
    ///
    /// let id = Input::hand_sim_pose_add(&hand_joints, ControllerKey::Trigger, ControllerKey::None_, Key::None, Key::None);
    /// assert_eq!(id, 5);
    ///
    /// let hand = Input::hand(Handed::Left);
    ///
    /// Input::hand_sim_pose_remove(id);
    ///
    /// let id = Input::hand_sim_pose_add(&hand_joints, ControllerKey::Grip, ControllerKey::None_, Key::None, Key::None);
    /// assert_eq!(id, 6);
    ///
    /// Input::hand_sim_pose_clear();
    ///
    /// let id = Input::hand_sim_pose_add(&hand_joints, ControllerKey::X1, ControllerKey::None_, Key::None, Key::None);
    /// assert_eq!(id, 7);
    /// ```
    pub fn hand_sim_pose_add(
        hand_joints_palm_relative_25: &[Pose],
        button1: ControllerKey,
        and_button2: ControllerKey,
        or_hotkey1: Key,
        and_hotkey2: Key,
    ) -> HandSimId {
        unsafe {
            input_hand_sim_pose_add(
                hand_joints_palm_relative_25.as_ptr(),
                button1,
                and_button2,
                or_hotkey1,
                and_hotkey2,
            )
        }
    }

    /// This clears all registered hand simulation poses, including the ones that StereoKit registers by default!
    /// <https://stereokit.net/Pages/StereoKit/Input/HandSimPoseClear.html>
    ///
    /// see also [`input_hand_sim_pose_clear`]   
    /// see example in [`Input::hand_sim_pose_add`]
    pub fn hand_sim_pose_clear() {
        unsafe { input_hand_sim_pose_clear() };
    }

    /// Lets you remove an existing hand pose.
    /// <https://stereokit.net/Pages/StereoKit/Input/HandSimPoseRemove.html>
    /// * `id` - Any valid or invalid hand sim pose id.
    ///
    /// see also [`input_hand_sim_pose_remove`]    
    /// see example in [`Input::hand_sim_pose_add`]
    pub fn hand_sim_pose_remove(id: HandSimId) {
        unsafe { input_hand_sim_pose_remove(id) };
    }

    /// This gets the current source of the hand joints! This allows you to distinguish between fully articulated
    /// joints, and simulated hand joints that may not have the same range of mobility. Note that this may change during
    /// a session, the user may put down their controllers, automatically switching to hands, or visa versa.
    /// <https://stereokit.net/Pages/StereoKit/Input/HandSource.html>
    /// * `hand` - Do  you want the left or right hand?
    ///
    /// Returns information about hand tracking data source.
    /// see also [`input_hand_source`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Input, Handed, HandSource};
    ///
    /// let hand_source = Input::hand_source(Handed::Left);
    /// let hand_source = Input::hand_source(Handed::Right);
    ///
    /// xr_mode_stop_here!();
    /// // These are the expected results for offscreen tests on a PC:
    /// assert_eq!(hand_source, HandSource::None);
    /// ```
    pub fn hand_source(hand: Handed) -> HandSource {
        unsafe { input_hand_source(hand) }
    }

    /// Sets whether or not StereoKit should render the hand for you. Turn this to false if you’re going to render your
    /// own, or don’t need the hand itself to be visible.
    /// <https://stereokit.net/Pages/StereoKit/Input/HandVisible.html>
    /// * `hand` - If Handed.Max, this will set the value for  both hands.
    /// * `visible` - True, StereoKit renders this. False, it doesn't.
    ///
    /// see also [`input_hand_visible`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Input, Handed, HandSource};
    ///
    /// Input::hand_visible(Handed::Right, false);
    /// Input::hand_visible(Handed::Max, false);
    /// Input::hand_visible(Handed::Left, true);
    /// ```
    pub fn hand_visible(hand: Handed, visible: bool) {
        unsafe { input_hand_visible(hand, visible as Bool32T) };
    }

    /// This controls the visibility of StereoKit's finger glow effect on the UI. When true, SK will fill out global
    /// shader variable `sk_fingertip[2]` with the location of the pointer finger's tips. When false, or the hand is
    /// untracked, the location will be set to an unlikely faraway position.
    /// <https://stereokit.net/Pages/StereoKit/Input/FingerGlow.html>
    /// * `visible` - True, StereoKit renders this. False, it doesn't.
    ///
    /// see also [`input_set_finger_glow`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Input, Handed, HandSource};
    ///
    /// assert_eq!(Input::get_finger_glow(), true);
    ///
    /// Input::finger_glow(false);
    ///
    /// assert_eq!(Input::get_finger_glow(), false);
    ///
    /// Input::finger_glow(true);
    /// assert_eq!(Input::get_finger_glow(), true);
    /// ```
    pub fn finger_glow(visible: bool) {
        unsafe { input_set_finger_glow(visible as Bool32T) };
    }

    /// Keyboard key state! On desktop this is super handy, but even standalone MR devices can have bluetooth keyboards,
    /// or even just holographic system keyboards!
    /// <https://stereokit.net/Pages/StereoKit/Input/Key.html>
    /// * `key` - The key to get the state of. Any key!
    ///
    /// Returns a BtnState with a number of different bits of info about whether or not the key was pressed or released
    /// this frame.
    /// see also [`input_key`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Input, Key, BtnState};
    ///
    /// let key_state = Input::key(Key::A);
    ///
    /// assert_eq!(key_state, BtnState::Inactive);
    /// assert_eq!(key_state.is_active(), false);
    /// assert_eq!(key_state.is_just_active(), false);
    /// assert_eq!(key_state.is_just_inactive(), false);
    /// assert_eq!(key_state.is_changed(), false);
    /// ```
    pub fn key(key: Key) -> BtnState {
        unsafe { input_key(key) }
    }

    /// This will inject a key press event into StereoKit’s input event queue. It will be processed at the start of the
    /// next frame, and will be indistinguishable from a physical key press. Remember to release your key as well!
    ///
    /// This will not submit text to StereoKit’s text queue, and will not show up in places like UI.Input. For that, you
    /// must submit a TextInjectChar call.
    /// <https://stereokit.net/Pages/StereoKit/Input/KeyInjectPress.html>
    /// * `key` - The key to press.
    ///
    /// see also [`input_key_inject_press`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Input, Key, BtnState}};
    ///
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     if iter == 0 {    
    ///         assert_eq!(Input::key(Key::A).is_just_active(), false);
    ///         Input::key_inject_press(Key::A);
    ///     } else if iter == 1 {
    ///         assert_eq!(Input::key(Key::A).is_just_active(), true);
    ///         Input::key_inject_release(Key::A);
    ///     } else if iter == 2 {
    ///         Input::key_inject_release(Key::A);
    ///         assert_eq!(Input::key(Key::A).is_just_inactive(), true);
    ///         Input::key_inject_press(Key::A);
    ///     } else if iter == 3 {
    ///         assert_eq!(Input::key(Key::A).is_active(), true);
    ///     }
    /// );
    /// assert_eq!(Input::key(Key::A).is_active(), true);
    /// ```
    pub fn key_inject_press(key: Key) {
        unsafe { input_key_inject_press(key) };
    }

    /// This will inject a key release event into StereoKit’s input event queue. It will be processed at the start of
    /// the next frame, and will be indistinguishable from a physical key release. This should be preceded by a key
    /// press!
    ///
    /// This will not submit text to StereoKit’s text queue, and will not show up in places like UI.Input. For that, you
    /// must submit a TextInjectChar call.
    /// <https://stereokit.net/Pages/StereoKit/Input/KeyInjectRelease.html>
    /// * `key` - The key to release.
    ///
    /// see also [`input_key_inject_release`]    
    /// see example [`Input::key_inject_press`]
    pub fn key_inject_release(key: Key) {
        unsafe { input_key_inject_release(key) };
    }

    /// This gets the pointer by filter based index.
    /// <https://stereokit.net/Pages/StereoKit/Input/Pointer.html>
    /// * `index` - Index of the Pointer.
    /// * `filter` - Filter used to search for the Pointer. If None has default value of ANY.
    ///
    /// Returns the Pointer data.
    /// see also [`input_pointer`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Input, InputSource, Pointer, BtnState, Handed, TrackState},
    ///                      maths::{Vec3, Quat, Pose, Ray}};
    ///
    /// // By default we only have the 2 hands.
    /// assert_eq!(Input::pointer_count(None), 0);
    /// let pointer = Input::pointer(0, None);
    ///
    /// assert_eq!(pointer.source, InputSource::None);
    /// assert_eq!(pointer.state, BtnState::Inactive);
    /// assert_eq!(pointer.tracked, BtnState::Inactive);
    /// assert_eq!(pointer.orientation, Quat::ZERO);
    /// assert_eq!(pointer.ray, Ray::ZERO);
    /// assert_eq!(pointer.get_pose(), Pose::ZERO);
    /// ```
    pub fn pointer(index: i32, filter: Option<InputSource>) -> Pointer {
        let filter = filter.unwrap_or(InputSource::Any);
        unsafe { input_pointer(index, filter) }
    }

    /// The number of Pointer inputs that StereoKit is tracking that match the given filter.
    /// <https://stereokit.net/Pages/StereoKit/Input/PointerCount.html>
    /// * `filter` - You can filter input sources using this bit flat. If None has default value of ANY
    ///
    /// Returns the number of Pointers StereoKit knows about that matches the given filter.
    /// see also [`input_pointer_count`]  
    /// see example in [`Input::pointer`]  
    pub fn pointer_count(filter: Option<InputSource>) -> i32 {
        let filter = filter.unwrap_or(InputSource::Any);
        unsafe { input_pointer_count(filter) }
    }

    /// Returns the next text character from the list of characters that have been entered this frame! Will return `\0`
    /// if there are no more characters left in the list. These are from the system’s text entry system, and so can be
    /// unicode, will repeat if their ‘key’ is held down, and could arrive from something like a copy/paste operation.
    ///
    /// If you wish to reset this function to begin at the start of the read list on the next call, you can call
    /// Input::text_reset.
    /// <https://stereokit.net/Pages/StereoKit/Input/TextConsume.html>
    ///
    /// Returns the next character in this frame's list, or '\0' if none remain, or None if the value doesn't
    /// match char.
    /// see also [`input_text_consume`] [`char::from_u32`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Input;
    ///
    /// // Simulate some text input
    /// Input::text_inject_char('H');
    /// Input::text_inject_char('i');
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     if iter == 0 {
    ///         assert_eq!(Input::text_consume(), Some('H'));
    ///         assert_eq!(Input::text_consume(), Some('i'));
    ///         Input::text_inject_char('!');
    ///         assert_eq!(Input::text_consume(), Some('\0'));
    ///     } else if iter == 1 {
    ///         assert_eq!(Input::text_consume(), Some('!'));
    ///     } else {
    ///         assert_eq!(Input::text_consume(), Some('\0'));
    ///     }
    /// );
    /// ```
    pub fn text_consume() -> Option<char> {
        char::from_u32(unsafe { input_text_consume() })
    }

    /// Resets the Input::text_consume read list back to the start. For example, UI.Input will not call text_reset, so
    /// it effectively will consume those characters, hiding them from any TextConsume calls following it. If you wanted
    /// to check the current frame’s text, but still allow UI.Input to work later on in the frame, you would read
    /// everything with TextConsume, and then TextReset afterwards to reset the read list for the following UI.Input.
    /// <https://stereokit.net/Pages/StereoKit/Input/TextReset.html>
    ///
    /// see also [`input_text_reset`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Input;
    ///
    /// // Simulate some text input
    /// Input::text_inject_char('H');
    /// Input::text_inject_char('i');
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     if iter == 0 {
    ///         assert_eq!(Input::text_consume(), Some('H'));
    ///         assert_eq!(Input::text_consume(), Some('i'));
    ///         Input::text_inject_char('!');
    ///         assert_eq!(Input::text_consume(), Some('\0'));
    ///         Input::text_reset();
    ///         assert_eq!(Input::text_consume(), Some('H'));
    ///         assert_eq!(Input::text_consume(), Some('i'));
    ///         assert_eq!(Input::text_consume(), Some('\0'));
    ///     } else if iter == 1 {
    ///         assert_eq!(Input::text_consume(), Some('!'));
    ///     } else {
    ///         assert_eq!(Input::text_consume(), Some('\0'));
    ///     }
    /// );
    /// ```
    pub fn text_reset() {
        unsafe { input_text_reset() };
    }

    /// This will inject a UTF32 Unicode text character into StereoKit’s text input queue. It will be available at the
    /// start of the next frame, and will be indistinguishable from normal text entry.
    ///
    /// This will not submit key press/release events to StereoKit’s input queue, use key_inject_press/_release
    /// for that.
    /// <https://stereokit.net/Pages/StereoKit/Input/TextInjectChar.html>
    /// * `character` - An unsigned integer representing a single UTF32 character.
    ///
    /// see also [`input_text_inject_char`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Input;
    ///
    /// // Simulate some text input
    /// Input::text_inject_char('H');
    /// Input::text_inject_char('i');
    /// Input::text_inject_char('!');
    /// Input::text_inject_char('😬');
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     if iter == 0 {
    ///         assert_eq!(Input::text_consume(), Some('H'));
    ///         assert_eq!(Input::text_consume(), Some('i'));
    ///         assert_eq!(Input::text_consume(), Some('!'));
    ///         assert_eq!(Input::text_consume(), Some('😬'));
    ///     } else {
    ///         assert_eq!(Input::text_consume(), Some('\0'));
    ///     }
    /// );
    /// ```
    pub fn text_inject_char(character: char) {
        unsafe { input_text_inject_char(character as u32) };
    }

    /// This will convert an str into a number of UTF32 Unicode text characters, and inject them into StereoKit’s
    /// text input queue. It will be available at the start of the next frame, and will be indistinguishable from normal
    /// text entry.
    ///
    /// This will not submit key press/release events to StereoKit’s input queue, use key_inject_press/_release
    /// for that.
    /// <https://stereokit.net/Pages/StereoKit/Input/TextInjectChar.html>
    /// * `chars` - A collection of characters to submit as text input.
    ///
    /// see also [`input_text_inject_char`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Input;
    ///
    /// // Simulate some text input
    /// Input::text_inject_chars("Hi!❤");
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     if iter == 0 {
    ///         assert_eq!(Input::text_consume(), Some('H'));
    ///         assert_eq!(Input::text_consume(), Some('i'));
    ///         assert_eq!(Input::text_consume(), Some('!'));
    ///         assert_eq!(Input::text_consume(), Some('❤'));
    ///     } else {
    ///         assert_eq!(Input::text_consume(), Some('\0'));
    ///     }
    /// );
    /// ```
    pub fn text_inject_chars(str: impl AsRef<str>) {
        for character in str.as_ref().chars() {
            unsafe { input_text_inject_char(character as u32) }
        }
    }

    /// You can subscribe to input events from Pointer sources here. StereoKit will call your callback and pass along a
    /// Pointer that matches the position of that pointer at the moment the event occurred. This can be more accurate
    /// than polling for input data, since polling happens specifically at frame start.
    /// <https://stereokit.net/Pages/StereoKit/Input/Subscribe.html>
    /// * `event_source` - What input sources do we want to listen for. This is a bit flag.
    /// * `event_types` - What events do we want to listen for. This is a bit flag.
    /// * `on_event` - The callback to call when the event occurs!
    ///
    /// see also [`input_subscribe`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Input, InputSource, Pointer, BtnState, Handed};
    ///
    /// let pointer_left  = Input::pointer(0, None);
    ///
    /// unsafe extern "C" fn input_cb (source: InputSource, input_event: BtnState, in_pointer: *const Pointer) {
    ///     let in_pointer = unsafe { *in_pointer };
    ///     assert_eq!(source, InputSource::CanPress);
    ///     assert_eq!(in_pointer.source, InputSource::None);
    ///     assert_eq!(input_event, BtnState::JustActive);
    /// }
    ///
    /// number_of_steps = 8;
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     if iter == 0 {    
    ///         Input::subscribe (InputSource::CanPress, BtnState::JustActive, Some(input_cb));
    ///     } if iter == 1 {
    ///         Input::fire_event(InputSource::CanPress, BtnState::JustActive, &pointer_left);
    ///     } else if iter == 8 {
    ///         Input::unsubscribe(InputSource::Hand | InputSource::HandLeft, BtnState::JustInactive, Some(input_cb));
    ///     }
    /// );
    /// ```
    #[deprecated(since = "0.4.0", note = "Not working anymore")]
    #[allow(deprecated)]
    pub fn subscribe(
        event_source: InputSource,
        event_types: BtnState,
        on_event: Option<unsafe extern "C" fn(source: InputSource, input_event: BtnState, in_pointer: *const Pointer)>,
    ) {
        unsafe { input_subscribe(event_source, event_types, on_event) }
    }

    /// Unsubscribes a listener from input events.
    /// <https://stereokit.net/Pages/StereoKit/Input/Unsubscribe.html>
    /// * `event_source` - The sources this listener was originally registered for.
    /// * `event_types` - The events this listener was originally registered for.
    /// * `on_event` - The callback this lisener originally used.
    ///
    /// see also [`input_unsubscribe`]    
    /// see example in [`Input::subscribe`]
    #[deprecated(since = "0.4.0", note = "Not working anymore")]
    #[allow(deprecated)]
    pub fn unsubscribe(
        event_source: InputSource,
        event_types: BtnState,
        on_event: Option<unsafe extern "C" fn(source: InputSource, input_event: BtnState, in_pointer: *const Pointer)>,
    ) {
        unsafe { input_unsubscribe(event_source, event_types, on_event) }
    }

    /// This retreives the Model currently in use by StereoKit to represent the controller input source. By default,
    /// this will be a Model provided by OpenXR, or SK's fallback Model. This will never be null while SK is
    /// initialized.
    /// <https://stereokit.net/Pages/StereoKit/Input.html>
    /// * `handed` - The hand of the controller Model to retreive.
    ///
    /// Returns the current controller Model. By default, his will be a Model provided by OpenXR, or SK's fallback
    /// Model. This will never be null while SK is initialized.
    /// see also [`input_controller_model_get`]
    /// see example in [`Input::set_controller_model`]
    pub fn get_controller_model(handed: Handed) -> Model {
        match NonNull::new(unsafe { input_controller_model_get(handed) }) {
            Some(model) => Model(model),
            None => Model::new(),
        }
    }

    /// This is the state of the controller’s menu button, this is not attached to any particular hand, so it’s
    /// independent of a left or right controller.
    /// <https://stereokit.net/Pages/StereoKit/Input/ControllerMenuButton.html>
    ///
    /// see also [`input_controller_menu`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Input, BtnState};
    ///
    /// assert_eq!(Input::get_controller_menu_button(), BtnState::Inactive);
    /// assert_eq!(Input::get_controller_menu_button().is_just_active(), false);
    ///
    /// let button_state = Input::get_controller_menu_button();
    /// assert_eq!(button_state.is_active(), false);
    /// assert_eq!(button_state.is_just_active(), false);
    /// assert_eq!(button_state.is_just_inactive(), false);
    /// assert_eq!(button_state.is_changed(), false);
    /// ```
    pub fn get_controller_menu_button() -> BtnState {
        unsafe { input_controller_menu() }
    }

    /// If the device has eye tracking hardware and the app has permission to use it, then this is the most recently
    /// tracked eye pose. Check Input.EyesTracked to see if the pose is up-to date, or if it’s a leftover!
    ///
    /// You can also check Sk::System::eye_tracking_present to see if the hardware is capable of providing eye tracking.
    ///
    /// On Flatscreen when the MR sim is still enabled, then eyes are emulated using the cursor position when the user
    /// holds down Alt.
    /// <https://stereokit.net/Pages/StereoKit/Input/Eyes.html>
    ///
    /// see also [`input_eyes`] [`Input::get_eyes_tracked`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Input, BtnState}, maths::Pose};
    ///
    /// let eyes_pose = Input::get_eyes();
    ///
    /// assert_eq!(eyes_pose, Pose::IDENTITY);
    /// assert_eq!(Input::get_eyes_tracked(), BtnState::Inactive)
    /// ```
    pub fn get_eyes() -> Pose {
        unsafe { input_eyes() }
    }

    /// If eye hardware is available and app has permission, then this is the tracking state of the eyes. Eyes may move
    /// out of bounds, hardware may fail to detect eyes, or who knows what else!
    ///
    /// On Flatscreen when MR sim is still enabled, this will report whether the user is simulating eye input with the
    /// Alt key.
    ///
    /// Permissions:
    /// * You may need to add an entry to your AndroidManifest.xml (or Cargo.toml), refer to your device’s
    ///   documentation for specifics.
    ///
    ///  <https://stereokit.net/Pages/StereoKit/Input/EyesTracked.html>
    ///
    /// see also [`input_eyes_tracked`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Input, BtnState}, maths::Pose};
    ///
    /// let eyes_tracked = Input::get_eyes_tracked();
    ///
    /// assert_eq!(eyes_tracked.is_active(), false);
    /// assert_eq!(eyes_tracked, BtnState::Inactive);
    ///
    /// assert_eq!(Input::get_eyes(),Pose::IDENTITY)
    /// ```
    pub fn get_eyes_tracked() -> BtnState {
        unsafe { input_eyes_tracked() }
    }

    /// The position and orientation of the user’s head! This is the center point between the user’s eyes, NOT the
    /// center of the user’s head. Forward points the same way the user’s face is facing.
    /// <https://stereokit.net/Pages/StereoKit/Input/Head.html>
    ///
    /// see also [`input_head`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Input, maths::Pose};
    ///
    /// let head_pose = Input::get_head();
    ///
    /// assert_eq!(head_pose, Pose::IDENTITY);
    /// ```
    pub fn get_head() -> Pose {
        unsafe { input_head() }
    }

    /// Information about this system’s mouse, or lack thereof!
    /// <https://stereokit.net/Pages/StereoKit/Input/Mouse.html>
    ///
    /// see also [`input_mouse`]    
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Input, maths::{Vec2, Vec3}};
    ///
    /// let mouse = Input::get_mouse();
    ///
    /// assert_eq!(mouse.is_available(),false);
    /// assert_eq!(mouse.pos,           Vec2::ZERO);
    /// assert_eq!(mouse.pos_change,    Vec2::ZERO);
    /// assert_eq!(mouse.scroll,        0.0);
    /// assert_eq!(mouse.scroll_change, 0.0);
    ///
    /// assert_eq!(mouse.get_ray().position, Vec3::ZERO);
    /// // Warning: No ray if the mouse isn't available!
    /// // assert_eq!(mouse.get_ray().direction, Vec3::new(f32::NAN, f32::NAN, f32::NAN));
    /// ```
    pub fn get_mouse() -> Mouse {
        unsafe { *input_mouse() }
    }

    /// This controls the visibility of StereoKit's finger glow effect on the UI. When true, SK will fill out global
    /// shader variable `sk_fingertip[2]` with the location of the pointer finger's tips. When false, or the hand is
    /// untracked, the location will be set to an unlikely faraway position.
    /// <https://stereokit.net/Pages/StereoKit/Input/FingerGlow.html>
    ///
    /// Returns true if StereoKit renders this. False, it doesn't.
    /// see also [`input_set_finger_glow`]
    /// see example in [`Input::finger_glow`]
    pub fn get_finger_glow() -> bool {
        unsafe { input_get_finger_glow() != 0 }
    }
}

/// Used to represent lines for the line drawing functions! This is just a snapshot of information about each individual
/// point on a line.
/// <https://stereokit.net/Pages/StereoKit/LinePoint.html>
/// ### Examples
/// ```
/// use stereokit_rust::{system::LinePoint, util::named_colors};
///
/// let line_point = LinePoint::new( [0.1, 0.2, 0.3], 0.01, named_colors::CYAN);
///
/// assert_eq!(line_point, LinePoint {pt: [0.1, 0.2, 0.3].into(), thickness: 0.01, color: named_colors::CYAN});
/// ```
#[derive(Debug, Copy, Clone, PartialEq)]
#[repr(C)]
pub struct LinePoint {
    pub pt: Vec3,
    pub thickness: f32,
    pub color: Color32,
}

impl LinePoint {
    /// Create a new LinePoint.
    pub fn new(pt: impl Into<Vec3>, thickness: f32, color: Color32) -> Self {
        Self { pt: pt.into(), thickness, color }
    }
}

/// A line drawing class! This is an easy way to visualize lines or relationships between objects. The current
/// implementation uses a quad strip that always faces the user, via vertex shader manipulation.
/// <https://stereokit.net/Pages/StereoKit/Lines.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{maths::{Vec3, Pose, Ray}, system::{Lines, LinePoint},
///                      util::{named_colors}};
///
/// let ray = Ray::new([-0.3, -0.8, 0.2], [1.0, 0.0, 0.0]);
///
/// let axis_pose = Pose::new([0.0, -0.35, 0.0], None);
///
/// filename_scr = "screenshots/lines.jpeg";
/// test_screenshot!( // !!!! Get a proper main loop !!!!
///     Lines::add(token, [0.7, 0.7, 0.2], [ 0.7,-0.7, 0.2], named_colors::LIME, None, 0.06);
///     Lines::add(token, [0.7, 0.7, 0.2], [-0.7, 0.7, 0.2], named_colors::RED, None, 0.03);
///
///     Lines::add_list(token, &[
///        LinePoint {pt: [-0.7,-0.7, 0.2].into(), thickness: 0.08, color: named_colors::FUCHSIA},
///        LinePoint::new([-0.5,-0.1, 0.2], 0.08, named_colors::BLACK),
///        LinePoint::new([-0.7, 0.7, 0.2], 0.01, named_colors::YELLOW),
///     ]);
///
///     Lines::add_ray(token, ray, 0.6, named_colors::RED, None, 0.08 );
///
///     Lines::add_axis(token, axis_pose, Some(0.7), Some(0.04));
/// );
/// ```
/// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/lines.jpeg" alt="screenshot" width="200">
pub struct Lines;

unsafe extern "C" {
    pub fn line_add(start: Vec3, end: Vec3, color_start: Color32, color_end: Color32, thickness: f32);
    pub fn line_addv(start: LinePoint, end: LinePoint);
    pub fn line_add_axis(pose: Pose, size: f32);
    pub fn line_add_list(points: *const Vec3, count: i32, color: Color32, thickness: f32);
    pub fn line_add_listv(in_arr_points: *const LinePoint, count: i32);
}

impl Lines {
    /// Adds a line to the environment for the current frame.
    /// <https://stereokit.net/Pages/StereoKit/Lines/Add.html>
    /// * `start` - The start of the line.
    /// * `end` - The end of the line.
    /// * `color_start` - Color for the start of the line, this is embedded in the vertex color of the line.
    /// * `color_end` - Color for the end of the line, this is embedded in the vertex color of the line. If None,
    ///   uses color_start.
    /// * `thickness` - The thickness of the line.
    ///
    /// see also [line_add]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Vec3, Pose, Ray}, system::{Lines, LinePoint},
    ///                      util::{named_colors}};
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     Lines::add(token, [0.7, 0.7, 0.2], [ 0.7,-0.7, 0.2], named_colors::LIME, None, 0.06);
    ///
    ///     Lines::add(token, [0.7, 0.7, 0.2], [-0.7, 0.7, 0.2], named_colors::RED, None, 0.03);
    /// );
    /// ```
    pub fn add<V: Into<Vec3>>(
        _token: &MainThreadToken,
        start: V,
        end: V,
        color_start: Color32,
        color_end: Option<Color32>,
        thickness: f32,
    ) {
        let color_end = color_end.unwrap_or(color_start);
        unsafe { line_add(start.into(), end.into(), color_start, color_end, thickness) }
    }

    /// Adds a line based on a ray to the environment for the current frame.
    /// <https://stereokit.net/Pages/StereoKit/Lines/Add.html>
    /// * `ray` - The ray we want to visualize!
    /// * `length` - How long should the ray be? Actual length will be ray.direction.Magnitude * length.
    /// * `color_start` - Color for the start of the line, this is embedded in the vertex color of the line.
    /// * `color_end` - Color for the end of the line, this is embedded in the vertex color of the line. If None,
    ///   uses color_start.
    /// * `thickness` - The thickness of the line.
    ///
    /// see also [line_add]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Vec3, Ray}, system::{Lines, LinePoint},
    ///                      util::{named_colors}};
    ///
    /// // axis at the origins:
    /// let ray1 = Ray::new(Vec3::ZERO, Vec3::X);
    /// let ray2 = Ray::new(Vec3::ZERO, Vec3::Y);
    /// let ray3 = Ray::new(Vec3::ZERO, Vec3::Z);
    ///
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     Lines::add_ray(token, ray1, 1.0, named_colors::WHITE, Some(named_colors::RED), 0.03 );
    ///     Lines::add_ray(token, ray2, 1.0, named_colors::WHITE, Some(named_colors::GREEN), 0.03 );
    ///     Lines::add_ray(token, ray2, 1.0, named_colors::WHITE, Some(named_colors::BLUE), 0.03 );
    /// );
    /// ```
    pub fn add_ray<R: Into<Ray>>(
        _token: &MainThreadToken,
        ray: R,
        length: f32,
        color_start: Color32,
        color_end: Option<Color32>,
        thickness: f32,
    ) {
        let color_end = color_end.unwrap_or(color_start);
        let ray: Ray = ray.into();
        unsafe { line_add(ray.position, ray.get_at(length), color_start, color_end, thickness) }
    }

    /// Adds a line from a list of line points to the environment. This does not close the path, so if you want it
    /// closed, you’ll have to add an extra point or two at the end yourself!
    /// <https://stereokit.net/Pages/StereoKit/Lines/Add.html>
    /// * `points` - An array of LinePoint.
    ///
    /// see also [line_add]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Vec3, Pose, Ray}, system::{Lines, LinePoint},
    ///                      util::{named_colors}};
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///
    ///     Lines::add_list(token, &[
    ///        LinePoint {pt: [-0.7,-0.7, 0.2].into(), thickness: 0.08, color: named_colors::FUCHSIA},
    ///        LinePoint::new([-0.5,-0.1, 0.2], 0.08, named_colors::BLACK),
    ///        LinePoint::new([-0.7, 0.7, 0.2], 0.01, named_colors::YELLOW),
    ///     ]);
    ///
    /// );
    /// ```
    pub fn add_list(_token: &MainThreadToken, points: &[LinePoint]) {
        unsafe { line_add_listv(points.as_ptr(), points.len() as i32) }
    }

    /// Displays an RGB/XYZ axis widget at the pose! Each line is extended along the positive direction of each axis, so
    /// the red line is +X, green is +Y, and blue is +Z. A white line is drawn along -Z to indicate the Forward vector
    /// of the pose (-Z is forward in StereoKit).
    /// <https://stereokit.net/Pages/StereoKit/Lines/AddAxis.html>
    /// * `at_pose` - What position and orientation do we want this axis widget at?
    /// * `size` - How long should the widget lines be, in meters? If None, has value of 1 cm
    /// * `thickness` - How thick should the lines be, in meters? If None, will use a faster renderer with a thickness of
    ///   one tenth of the size.
    ///
    /// see also [line_add]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Vec3, Pose, Ray}, system::{Lines, LinePoint},
    ///                      util::{named_colors}};
    ///
    /// // Axis at the origins:
    /// let axis_pose = Pose::IDENTITY;
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///
    ///     Lines::add_axis(token, axis_pose, Some(0.7), Some(0.02));
    ///
    /// );
    /// ```
    pub fn add_axis<P: Into<Pose>>(token: &MainThreadToken, at_pose: P, size: Option<f32>, thickness: Option<f32>) {
        let at_pose: Pose = at_pose.into();
        let size = size.unwrap_or(0.01);
        match thickness {
            Some(thickness) => {
                Self::add(
                    token,
                    at_pose.position,
                    at_pose.orientation.mul_vec3(at_pose.position + Vec3::X) * size,
                    Color32::new(255, 0, 0, 255),
                    None,
                    thickness,
                );
                Self::add(
                    token,
                    at_pose.position,
                    at_pose.orientation.mul_vec3(at_pose.position + Vec3::Y) * size,
                    Color32::new(0, 255, 0, 255),
                    None,
                    thickness,
                );
                Self::add(
                    token,
                    at_pose.position,
                    at_pose.orientation.mul_vec3(at_pose.position + Vec3::Z) * size,
                    Color32::new(0, 0, 255, 255),
                    None,
                    thickness,
                );
                Self::add(
                    token,
                    at_pose.position,
                    at_pose.orientation.mul_vec3(at_pose.position + Vec3::FORWARD) * size * 0.5,
                    Color32::new(255, 255, 255, 255),
                    None,
                    thickness,
                )
            }
            None => unsafe { line_add_axis(at_pose, size) },
        }
    }
}

/// The log tool will write to the console with annotations for console colors, which helps with readability, but isn’t
/// always supported. These are the options available for configuring those colors.
/// <https://stereokit.net/Pages/StereoKit/LogColors.html>
///
/// see also [`Log`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum LogColors {
    /// Use console coloring annotations.
    Ansi = 0,
    ///Scrape out any color annotations, so logs are all completely plain text.
    None = 1,
}

/// Severity of a log item.
/// <https://stereokit.net/Pages/StereoKit/LogLevel.html>
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum LogLevel {
    /// A default log level that indicates it has not yet been set
    None = 0,
    /// This is for diagnostic information, where you need to know details about what -exactly- is going on in the
    /// system. This info doesn’t surface by default.
    Diagnostic = 1,
    /// This is non-critical information, just to let you know what’s going on.
    Inform = 2,
    /// Something bad has happened, but it’s still within the realm of what’s expected.
    Warning = 3,
    /// Danger Will Robinson! Something really bad just happened and needs fixing!
    Error = 4,
}

/// Non canonical structure used for subscribed callback
#[derive(Debug, Clone)]
pub struct LogItem {
    pub level: LogLevel,
    pub text: String,
    pub count: i32,
}

/// A class for logging errors, warnings and information!
/// Different levels of information can be filtered out, and supports
/// coloration via &lt;`~colorCode`&gt; and &lt;`~clr`&gt; tags.
///
/// Text colors can be set with a tag, and reset back to default with
/// &lt;`~clr`&gt;. Color codes are as follows:
///
/// | Dark | Bright | Description |
/// |------|--------|-------------|
/// | DARK | BRIGHT | DESCRIPTION |
/// | blk  | BLK    | Black       |
/// | red  | RED    | Red         |
/// | grn  | GRN    | Green       |
/// | ylw  | YLW    | Yellow      |
/// | blu  | BLU    | Blue        |
/// | mag  | MAG    | Magenta     |
/// | cyn  | cyn    | Cyan        |
/// | grn  | GRN    | Green       |
/// | wht  | WHT    | White       |
///
/// <https://stereokit.net/Pages/StereoKit/Log.html>
///
/// ### Examples
/// ```
/// use stereokit_rust::system::{Log, LogColors, LogLevel};
///
/// Log::colors(LogColors::Ansi);
/// Log::filter(LogLevel::Diagnostic);
///
/// Log::info("model <~GRN>node count<~clr> : <~RED>6589<~clr> !!!");
///
/// let value = 42;
/// Log::diag(format!("My value is {}", value));
///
/// Log::warn("This is not very good!");
///
/// Log::err("This is very bad!!!");
///
/// Log::write(LogLevel::Diagnostic, format!("Again, my value is {}", 2));
/// ```
pub struct Log;

unsafe extern "C" {
    pub fn log_diag(text: *const c_char);
    //pub fn log_diagf(text: *const c_char, ...);
    pub fn log_info(text: *const c_char);
    //pub fn log_infof(text: *const c_char, ...);
    pub fn log_warn(text: *const c_char);
    //pub fn log_warnf(text: *const c_char, ...);
    pub fn log_err(text: *const c_char);
    //pub fn log_errf(text: *const c_char, ...);
    //pub fn log_writef(level: LogLevel, text: *const c_char, ...);
    pub fn log_write(level: LogLevel, text: *const c_char);
    pub fn log_set_filter(level: LogLevel);
    pub fn log_set_colors(colors: LogColors);
    pub fn log_subscribe(
        log_callback: Option<unsafe extern "C" fn(context: *mut c_void, level: LogLevel, text: *const c_char)>,
        context: *mut c_void,
    );
    pub fn log_unsubscribe(
        log_callback: Option<unsafe extern "C" fn(context: *mut c_void, level: LogLevel, text: *const c_char)>,
        context: *mut c_void,
    );
}

/// Log subscribe trampoline
///
/// see also [`Log::subscribe`]
unsafe extern "C" fn log_trampoline<'a, F: FnMut(LogLevel, &str) + 'a>(
    context: *mut c_void,
    log_level: LogLevel,
    text: *const c_char,
) {
    let closure = unsafe { &mut *(context as *mut &mut F) };
    let c_str = unsafe { CStr::from_ptr(text).to_str().unwrap().trim_end() };
    closure(log_level, c_str)
}

impl Log {
    /// What's the lowest level of severity logs to display on the console? Default is LogLevel::Info. This property
    /// can safely be set before SK initialization.
    /// <https://stereokit.net/Pages/StereoKit/Log.html>
    ///
    /// see also [`log_set_filter`]
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::{Log, LogLevel};
    ///
    /// // Set the log filter to only show errors and above.
    /// Log::filter(LogLevel::Error);
    ///
    /// // Set the log filter to only show warnings and above (errors)
    /// Log::filter(LogLevel::Warning);
    ///
    /// // Set the log filter to only show infos and above (wanings and errors)
    /// Log::filter(LogLevel::Inform);
    ///
    /// // Set the log filter to show every logs
    /// Log::filter(LogLevel::Diagnostic);
    /// ```
    pub fn filter(filter: LogLevel) {
        unsafe { log_set_filter(filter) }
    }

    /// Set the colors
    /// <https://stereokit.net/Pages/StereoKit/Log.html>
    ///
    /// see also [`log_set_colors`]
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::{Log, LogColors};
    ///
    /// // Set the log colors to use ANSI color codes.
    /// Log::colors(LogColors::Ansi);
    ///
    /// // Set the log colors to use no color codes.
    /// Log::colors(LogColors::None);
    /// ```
    pub fn colors(colors: LogColors) {
        unsafe { log_set_colors(colors) }
    }

    /// Writes a formatted line to the log using a LogLevel.Error severity level!
    /// <https://stereokit.net/Pages/StereoKit/Log.html>
    ///
    /// see also [`log_err`]
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::Log;
    ///
    /// Log::err("This is very bad!!!");
    ///
    /// let value = 42;
    /// Log::err(format!("My problematic value is {}", value));
    /// ```
    pub fn err<S: AsRef<str>>(text: S) {
        let c_str = CString::new(text.as_ref()).unwrap();
        unsafe { log_err(c_str.as_ptr()) }
    }

    /// Writes a formatted line to the log using a LogLevel.Inform severity level!
    /// <https://stereokit.net/Pages/StereoKit/Log.html>
    ///
    /// see also [`log_info`]
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::Log;
    ///
    /// Log::info("This is good!");
    ///
    /// let value = 42;
    /// Log::info(format!("My value is {}", value));
    /// ```
    pub fn info<S: AsRef<str>>(text: S) {
        let c_str = CString::new(text.as_ref()).unwrap();
        unsafe { log_info(c_str.as_ptr()) }
    }

    /// Writes a formatted line to the log using a LogLevel.Warning severity level!
    /// <https://stereokit.net/Pages/StereoKit/Log.html>
    ///
    /// see also [`log_warn`]
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::Log;
    ///
    /// Log::warn("This is not very good!");
    ///
    /// let value = 42;
    /// Log::warn(format!("My not so good value is {}", value));
    /// ```
    pub fn warn<S: AsRef<str>>(text: S) {
        let c_str = CString::new(text.as_ref()).unwrap();
        unsafe { log_warn(c_str.as_ptr()) }
    }

    /// Writes a formatted line to the log using a LogLevel.Diagnostic severity level!
    /// <https://stereokit.net/Pages/StereoKit/Log.html>
    ///
    /// see also [`log_diag`]
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::Log;
    ///
    /// Log::diag("This is something to check!");
    ///
    /// let value = 42;
    /// Log::diag(format!("My value to check is {}", value));
    /// ```
    pub fn diag<S: AsRef<str>>(text: S) {
        let c_str = CString::new(text.as_ref()).unwrap();
        unsafe { log_diag(c_str.as_ptr()) }
    }

    /// Writes a formatted line to the log with the specified severity level!
    /// <https://stereokit.net/Pages/StereoKit/Log.html>
    ///
    /// see also [`log_write`]
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::{Log, LogLevel};
    ///
    /// Log::write(LogLevel::Diagnostic, "This is something to check!!!");
    ///
    /// let value = 42;
    /// Log::write(LogLevel::Error, format!("My problematic value is {}", value));
    /// ```
    pub fn write<S: AsRef<str>>(level: LogLevel, text: S) {
        let c_str = CString::new(text.as_ref()).unwrap();
        unsafe { log_write(level, c_str.as_ptr()) }
    }

    /// Allows you to listen in on log events! Any callback subscribed here will be called when something is logged.
    /// This does honor the Log.Filter, so filtered logs will not be received here. This method can safely be called
    /// before SK initialization.
    /// <https://stereokit.net/Pages/StereoKit/Log/Subscribe.html>
    ///
    /// see also [`log_subscribe`] [`Log::unsubscribe`]   
    /// ### Examples
    /// ```
    /// use stereokit_rust::system::{Log, LogLevel, LogItem};
    /// use std::sync::{Arc, Mutex};
    ///
    /// /// Somewhere to copy the log
    /// static LOG_LOG: Mutex<Vec<LogItem>> = Mutex::new(vec![]);
    ///
    /// let fn_mut = |level: LogLevel, log_text: &str| {
    ///     let mut items = LOG_LOG.lock().unwrap();
    ///     items.push(LogItem { level, text: log_text.to_owned(), count: 1 });
    /// };
    /// Log::subscribe( fn_mut );
    ///
    /// Log::info("This is an info message");
    /// Log::warn("This is a warning message");
    /// Log::err("This is an error message");
    ///
    /// let messages = LOG_LOG.lock().unwrap();
    /// assert_eq!(messages.len(), 3);
    /// assert_eq!(messages[0].level, LogLevel::Inform);
    /// assert_eq!(messages[1].text, "This is a warning message");
    ///
    /// Log::unsubscribe( fn_mut );
    /// ```
    pub fn subscribe<'a, F: FnMut(LogLevel, &str) + 'a>(mut on_log: F) {
        let mut closure = &mut on_log;
        unsafe { log_subscribe(Some(log_trampoline::<F>), &mut closure as *mut _ as *mut c_void) }
    }

    /// If you subscribed to the log callback, you can unsubscribe that callback here! This method can safely be
    /// called before initialization.
    /// <https://stereokit.net/Pages/StereoKit/Log/Unsubscribe.html>
    ///
    /// see also [`log_unsubscribe`]
    /// see example in [`Log::subscribe`]   
    pub fn unsubscribe<'a, F: FnMut(LogLevel, &str) + 'a>(mut on_log: F) {
        let mut closure = &mut on_log;
        unsafe { log_unsubscribe(Some(log_trampoline::<F>), &mut closure as *mut _ as *mut c_void) }
    }
}

/// This class provides access to the hardware’s microphone, and stores it in a Sound stream. Start and Stop recording,
/// and check the Sound property for the results! Remember to ensure your application has microphone permissions enabled!
/// <https://stereokit.net/Pages/StereoKit/Microphone.html>
///
/// see also: [`Sound`]
/// /// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{maths::{Vec3, Matrix}, mesh::Mesh, material::Material,
///                      sound::Sound, system::Microphone, util::named_colors};
///
/// let sphere = Mesh::generate_cube(Vec3::ONE * 0.5, None);
/// let material = Material::pbr().tex_file_copy("textures/micro.jpeg", true, None)
///                    .expect("sound.jpeg should be there");
/// let mut position = Vec3::new( 0.0, 0.0, 0.5);
/// let transform = Matrix::t(position);
///
/// let micros = Microphone::get_devices();
///
/// if micros.len() > 0 {
///     let first_in_list = micros[0].clone();
///     if Microphone::start(Some(first_in_list)) {
///         assert!(Microphone::is_recording());
///     } else {
///         assert!(!Microphone::is_recording());
///     }
/// }
///
/// filename_scr = "screenshots/microphone.jpeg";
/// test_screenshot!( // !!!! Get a proper main loop !!!!
///     sphere.draw(token, &material, transform, Some(named_colors::LIGHT_BLUE.into()), None  );
///     if iter == 1990 && Microphone::is_recording() {
///         let micro_sound = Microphone::sound().expect("Microphone should be recording");
///         let mut read_samples: Vec<f32> = vec![0.0; 48000];
///         let recorded_data = micro_sound.read_samples(read_samples.as_mut_slice(), None);
///         Microphone::stop();
///         //assert_ne!(recorded_data, 0);
///     }
/// );
/// ```
/// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/microphone.jpeg" alt="screenshot" width="200">
#[repr(C)]
#[derive(Debug, PartialEq)]
pub struct Microphone {
    sound: Sound,
}

unsafe extern "C" {
    pub fn mic_get_stream() -> SoundT;
    pub fn mic_is_recording() -> Bool32T;
    pub fn mic_device_count() -> i32;
    pub fn mic_device_name(index: i32) -> *const c_char;
    pub fn mic_start(device_name: *const c_char) -> Bool32T;
    pub fn mic_stop();
}

impl Microphone {
    /// This is the sound stream of the Microphone when it is recording. This Asset is created the first time it is
    /// accessed via this property, or during Start, and will persist. It is re-used for the Microphone stream if you
    /// start/stop/switch devices.
    /// <https://stereokit.net/Pages/StereoKit/Microphone/Sound.html>
    ///
    /// see also [mic_get_stream]
    pub fn sound() -> Result<Sound, StereoKitError> {
        Ok(Sound(
            NonNull::new(unsafe { mic_get_stream() })
                .ok_or(StereoKitError::SoundCreate("microphone stream".to_string()))?,
        ))
    }

    /// Is the microphone currently recording?
    /// <https://stereokit.net/Pages/StereoKit/Microphone/IsRecording.html>
    ///
    /// see also [`mic_is_recording`]
    pub fn is_recording() -> bool {
        unsafe { mic_is_recording() != 0 }
    }

    /// Constructs a list of valid Microphone devices attached to the system. These names can be passed into Start to
    /// select a specific device to record from. It’s recommended to cache this list if you’re using it frequently, as
    /// this list is constructed each time you call it.
    ///
    /// It’s good to note that a user might occasionally plug or unplug microphone devices from their system, so this
    /// list may occasionally change.
    /// <https://stereokit.net/Pages/StereoKit/Microphone/GetDevices.html>
    ///
    /// see also [`mic_device_count`] [`mic_device_name`]
    pub fn get_devices() -> Vec<String> {
        let mut devices = Vec::new();
        for iter in 0..unsafe { mic_device_count() } {
            let device_name = unsafe { CStr::from_ptr(mic_device_name(iter)) }.to_str().unwrap().to_string();
            devices.push(device_name);
        }
        devices
    }

    /// This begins recording audio from the Microphone! Audio is stored in Microphone.Sound as a stream of audio. If
    /// the Microphone is already recording with a different device, it will stop the previous recording and start again
    /// with the new device.
    ///
    /// If null is provided as the device, then they system’s default input device will be used. Some systems may not
    /// provide access to devices other than the system’s default.
    /// <https://stereokit.net/Pages/StereoKit/Microphone/Start.html>
    /// * `device_name` - The name of the microphone device to use, as seen in the GetDevices list. None will use the
    ///   system’s default device preference.
    ///
    /// see also [`mic_start`] [`Microphone::get_devices`] [`Microphone::stop`]
    pub fn start(device_name: Option<String>) -> bool {
        if let Some(device_name) = device_name
            && !device_name.is_empty()
        {
            let cstr = CString::new(device_name).unwrap();
            return unsafe { mic_start(cstr.as_ptr() as *const c_char) != 0 };
        }
        // Here we call for a null_mut device_name
        unsafe { mic_start(null_mut() as *const c_char) != 0 }
    }

    /// Stops recording audio from the microphone.
    /// <https://stereokit.net/Pages/StereoKit/Microphone/Stop.html>
    ///
    /// see also [mic_stop]
    pub fn stop() {
        unsafe { mic_stop() }
    }
}

/// When rendering to a rendertarget, this tells if and what of the rendertarget gets cleared before rendering. For
/// example, if you are assembling a sheet of images, you may want to clear everything on the first image draw, but not
/// clear on subsequent draws.
/// <https://stereokit.net/Pages/StereoKit/RenderClear.html>
///
/// see also [`Renderer`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum RenderClear {
    /// Don’t clear anything, leave it as it is.
    None = 0,
    /// Clear the rendertarget’s color data.
    Color = 1,
    /// Clear the rendertarget’s depth data, if present.
    Depth = 2,
    /// Clear both color and depth data.
    All = 3,
}

bitflags::bitflags! {
    /// When rendering content, you can filter what you’re rendering by the RenderLayer that they’re on. This allows
    /// you to draw items that are visible in one render, but not another. For example, you may wish to draw a player’s
    /// avatar in a ‘mirror’ rendertarget, but not in the primary display. See Renderer.LayerFilter for configuring
    /// what the primary display renders.
    /// <https://stereokit.net/Pages/StereoKit/RenderLayer.html>
    ///
    /// see also [`Renderer`] [`Mesh::draw`] [`Model::draw`] [`Model::draw_mat`] [`RenderList`]
    #[derive(Debug, Copy, Clone, PartialEq, Eq)]
    #[repr(C)]
    pub struct RenderLayer: u32 {
        /// The default render layer. All Draw use this layer unless otherwise specified.
        const Layer0 = 1 << 0;
        /// Render layer 1.
        const Layer1 = 1 << 1;
        /// Render layer 2.
        const Layer2 = 1 << 2;
        /// Render layer 3.
        const Layer3 = 1 << 3;
        /// Render layer 4.
        const Layer4 = 1 << 4;
        /// Render layer 5.
        const Layer5 = 1 << 5;
        /// Render layer 6.
        const Layer6 = 1 << 6;
        /// Render layer 7.
        const Layer7 = 1 << 7;
        /// Render layer 8.
        const Layer8 = 1 << 8;
        /// Render layer 9.
        const Layer9 = 1 << 9;
        /// The default VFX layer, StereoKit draws some non-standard mesh content using this flag, such as lines.
        const VFX = 10;
        /// For items that should only be drawn from the first person perspective. By default, this is enabled for
        /// renders that are from a 1st person viewpoint.
        const FirstPerson    = 1 << 11;
        /// For items that should only be drawn from the third person perspective. By default, this is enabled for
        /// renders that are from a 3rd person viewpoint.
        const ThirdPerson    = 1 << 12;
        /// This is a flag that specifies all possible layers. If you want to render all layers, then this is the layer
        ///  filter you would use. This is the default for render filtering.
        const All = 0xFFFF;
        /// This is a combination of all layers that are not the VFX layer.
        const AllRegular = Self::Layer0.bits() | Self::Layer1.bits() | Self::Layer2.bits() | Self::Layer3.bits() | Self::Layer4.bits() | Self::Layer5.bits() | Self::Layer6.bits() | Self::Layer7.bits() | Self::Layer8.bits() | Self::Layer9.bits();
        /// All layers except for the third person layer.
        const AllFirstPerson = Self::All.bits() & !Self::ThirdPerson.bits();
        ///All layers except for the first person layer.
        const AllThirdPerson = Self::All.bits() & !Self::FirstPerson.bits();
    }
}

impl Default for RenderLayer {
    /// Layer_all is the default.
    fn default() -> Self {
        RenderLayer::All
    }
}

/// The projection mode used by StereoKit for the main camera! You can use this with Renderer.Projection. These options
/// are only available in flatscreen mode, as MR headsets provide very specific projection matrices.
/// <https://stereokit.net/Pages/StereoKit/Projection.html>
///
/// see also [`Renderer`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum Projection {
    /// This is the default projection mode, and the one you’re most likely to be familiar with! This is where parallel
    /// lines will converge as they go into the distance.
    Perspective = 0,
    /// Orthographic projection mode is often used for tools, 2D rendering, thumbnails of 3D objects, or other similar
    /// cases. In this mode, parallel lines remain parallel regardless of how far they travel.
    Orthographic = 1,
}

/// Do you need to draw something? Well, you’re probably in the right place! This static class includes a variety of
/// different drawing methods, from rendering Models and Meshes, to setting rendering options and drawing to offscreen
/// surfaces! Even better, it’s entirely a static class, so you can call it from anywhere :)
/// <https://stereokit.net/Pages/StereoKit/Renderer.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::{Renderer, RenderLayer}, maths::{Vec3, Matrix, Pose},
///                      render_list::RenderList,
///                      mesh::Mesh, model::Model, material::Material, util::named_colors};
///
/// let sun = Mesh::generate_sphere(5.0, None);
/// let material = Material::pbr();
/// let transform_sun = Matrix::t([-6.0, -4.0, -10.0]);
///
/// let plane = Model::from_file("plane.glb", None).expect("plane.glb should be there");
/// let transform_plane = Matrix::t_r_s([0.0, 0.2, -0.7], [0.0, 120.0, 0.0], [0.15, 0.15, 0.15]);
///
/// // We want to replace the gray background with a dark blue sky:
/// let mut primary = RenderList::primary();
/// assert_eq!(primary.get_count(), 0);
/// Renderer::clear_color(named_colors::BLUE);
///
/// filename_scr = "screenshots/renderer.jpeg";
/// test_steps!( // !!!! Get a proper main loop !!!!
///     
///     primary.clear();
///
///     Renderer::add_mesh(token, &sun, &material, transform_sun,
///         Some(named_colors::RED.into()), None);
///
///     Renderer::add_model(token, &plane, transform_plane,
///         Some(named_colors::PINK.into()), Some(RenderLayer::FirstPerson));
///
///     Renderer::layer_filter(RenderLayer::All);
///  
///     if iter == number_of_steps {
///         // This is the way test_screenshot!() works:
///         Renderer::screenshot(token, filename_scr, 90, Pose::look_at(from_scr, at_scr),
///             width_scr, height_scr, Some(fov_scr) );
///     }
/// );
/// ```
/// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/renderer.jpeg" alt="screenshot" width="200">
pub struct Renderer;

unsafe extern "C" {
    pub fn render_set_clip(near_plane: f32, far_plane: f32);
    pub fn render_get_clip(out_near_plane: *mut f32, out_far_plane: *mut f32);
    pub fn render_set_fov(vertical_field_of_view_degrees: f32);
    pub fn render_get_fov() -> f32;
    pub fn render_set_ortho_clip(near_plane: f32, far_plane: f32);
    pub fn render_set_ortho_size(viewport_height_meters: f32);
    pub fn render_get_ortho_size() -> f32;
    pub fn render_set_projection(proj: Projection);
    pub fn render_get_projection() -> Projection;
    pub fn render_get_cam_root() -> Matrix;
    pub fn render_set_cam_root(cam_root: *const Matrix);
    pub fn render_set_skytex(sky_texture: TexT);
    pub fn render_get_skytex() -> TexT;
    pub fn render_set_skymaterial(sky_material: MaterialT);
    pub fn render_get_skymaterial() -> MaterialT;
    pub fn render_set_skylight(light_info: *const SphericalHarmonics);
    pub fn render_get_skylight() -> SphericalHarmonics;
    pub fn render_set_filter(layer_filter: RenderLayer);
    pub fn render_get_filter() -> RenderLayer;
    pub fn render_set_scaling(display_tex_scale: f32);
    pub fn render_get_scaling() -> f32;
    pub fn render_set_viewport_scaling(viewport_rect_scale: f32);
    pub fn render_get_viewport_scaling() -> f32;
    pub fn render_set_multisample(display_tex_multisample: i32);
    pub fn render_get_multisample() -> i32;
    pub fn render_override_capture_filter(use_override_filter: Bool32T, layer_filter: RenderLayer);
    pub fn render_get_capture_filter() -> RenderLayer;
    pub fn render_has_capture_filter() -> Bool32T;
    pub fn render_set_clear_color(color_gamma: Color128);
    pub fn render_get_clear_color() -> Color128;
    pub fn render_enable_skytex(show_sky: Bool32T);
    pub fn render_enabled_skytex() -> Bool32T;

    pub fn render_global_texture(register_slot: i32, texture: TexT);
    pub fn render_global_buffer(register_slot: i32, buffer: MaterialBufferT);
    pub fn render_add_mesh(
        mesh: MeshT,
        material: MaterialT,
        transform: *const Matrix,
        color_linear: Color128,
        layer: RenderLayer,
    );
    pub fn render_add_model(model: ModelT, transform: *const Matrix, color_linear: Color128, layer: RenderLayer);
    pub fn render_add_model_mat(
        model: ModelT,
        material_override: MaterialT,
        transform: *const Matrix,
        color_linear: Color128,
        layer: RenderLayer,
    );
    pub fn render_blit(to_rendertarget: TexT, material: MaterialT);

    pub fn render_screenshot(
        file_utf8: *const c_char,
        file_quality_100: i32,
        viewpoint: Pose,
        width: i32,
        height: i32,
        field_of_view_degrees: f32,
    );
    pub fn render_screenshot_capture(
        render_on_screenshot_callback: ::std::option::Option<
            unsafe extern "C" fn(color_buffer: *mut Color32, width: i32, height: i32, context: *mut c_void),
        >,
        viewpoint: Pose,
        width: i32,
        height: i32,
        field_of_view_degrees: f32,
        tex_format: TexFormat,
        context: *mut c_void,
    );
    pub fn render_screenshot_viewpoint(
        render_on_screenshot_callback: ::std::option::Option<
            unsafe extern "C" fn(color_buffer: *mut Color32, width: i32, height: i32, context: *mut c_void),
        >,
        camera: Matrix,
        projection: Matrix,
        width: i32,
        height: i32,
        layer_filter: RenderLayer,
        clear: RenderClear,
        viewport: Rect,
        tex_format: TexFormat,
        context: *mut c_void,
    );
    pub fn render_to(
        to_rendertarget: TexT,
        to_target_index: i32,
        camera: *const Matrix,
        projection: *const Matrix,
        layer_filter: RenderLayer,
        material_variant: i32,
        clear: RenderClear,
        viewport: Rect,
    );

    pub fn render_MaterialTo(
        to_rendertarget: TexT,
        override_material: MaterialT,
        camera: *const Matrix,
        projection: *const Matrix,
        layer_filter: RenderLayer,
        clear: RenderClear,
        viewport: Rect,
    );
    pub fn render_get_device(device: *mut *mut c_void, context: *mut *mut c_void);

}

/// screenshot_capture trampoline
///
/// see also [`Renderer::screenshot_capture`]
unsafe extern "C" fn sc_capture_trampoline<F: FnMut(&[Color32], usize, usize)>(
    color_buffer: *mut Color32,
    width: i32,
    height: i32,
    context: *mut c_void,
) {
    let closure = unsafe { &mut *(context as *mut &mut F) };
    closure(
        unsafe { std::slice::from_raw_parts(color_buffer, (width * height) as usize) },
        width as usize,
        height as usize,
    )
}

impl Renderer {
    /// Sets the root transform of the camera! This will be the identity matrix by default. The user’s head
    /// location will then be relative to this point. This is great to use if you’re trying to do teleportation,
    /// redirected walking, or just shifting the floor around.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/CameraRoot.html>
    ///
    /// see also [`render_set_cam_root`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Matrix, Vec3}, system::Renderer};
    ///
    /// let camera_root = Renderer::get_camera_root();
    /// assert_eq!(camera_root, Matrix::IDENTITY);
    ///
    /// let transform = Matrix::t([0.0, 0.0, -1.0]);
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     Renderer::camera_root(transform);
    ///     let camera_root = Renderer::get_camera_root();
    ///     assert_eq!(camera_root, transform);
    /// );
    /// ```
    pub fn camera_root(transform: impl Into<Matrix>) {
        unsafe { render_set_cam_root(&transform.into()) }
    }

    /// This is the gamma space color the renderer will clear the screen to when beginning to draw a new frame.
    /// [`Color128::BLACK_TRANSPARENT`] is the default and is mandatory for some Passthrough solutions.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/ClearColor.html>
    ///
    /// see also [`render_set_clear_color`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Renderer,
    ///                      render_list::RenderList, util::{named_colors, Color128}};
    ///
    /// // We want to replace the gray background with a dark blue sky:
    /// let mut primary = RenderList::primary();
    /// assert_eq!(primary.get_count(), 0);
    ///
    ///
    /// assert_eq!(Renderer::get_clear_color(), Color128::BLACK_TRANSPARENT);
    /// Renderer::clear_color(named_colors::BLUE);
    ///
    /// filename_scr = "screenshots/renderer.jpeg";
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     
    ///     primary.clear();
    ///
    ///     assert_eq!(Renderer::get_clear_color(), named_colors::BLUE.into());
    ///
    /// );
    /// ```
    pub fn clear_color(color_gamma: impl Into<Color128>) {
        unsafe { render_set_clear_color(color_gamma.into()) }
    }

    /// Enables or disables rendering of the skybox texture! It’s enabled by default on Opaque displays, and completely
    /// unavailable for transparent displays.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/EnableSky.html>
    ///
    /// see also [`render_enable_skytex`] [`Renderer::clear_color`] [`crate::tex::SHCubemap`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Renderer;
    ///
    /// assert_eq!(Renderer::get_enable_sky(), true);
    ///
    /// Renderer::enable_sky(false);
    /// assert_eq!(Renderer::get_enable_sky(), false);
    ///
    /// Renderer::enable_sky(true);
    /// assert_eq!(Renderer::get_enable_sky(), true);
    /// ```
    pub fn enable_sky(enable: bool) {
        unsafe { render_enable_skytex(enable as Bool32T) }
    }

    /// By default, StereoKit renders all first-person layers. This is a bit flag that allows you to change which layers
    /// StereoKit renders for the primary viewpoint. To change what layers a visual is on, use a Draw method that
    /// includes a RenderLayer as a parameter.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/LayerFilter.html>
    ///
    /// see also [`render_set_filter`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Renderer, RenderLayer};
    ///
    /// assert_eq!(Renderer::get_layer_filter(), RenderLayer::AllFirstPerson);
    ///
    /// Renderer::layer_filter(RenderLayer::All);
    /// assert_eq!(Renderer::get_layer_filter(), RenderLayer::All);
    ///
    /// Renderer::layer_filter(RenderLayer::AllFirstPerson);
    /// assert_eq!(Renderer::get_layer_filter(), RenderLayer::AllFirstPerson);
    /// ```
    pub fn layer_filter(filter: RenderLayer) {
        unsafe { render_set_filter(filter) }
    }

    /// Allows you to set the multisample (MSAA) level of the render surface. Valid values are 1, 2, 4, 8, 16, though
    /// some OpenXR runtimes may clamp this to lower values. Note that while this can greatly smooth out edges, it also
    /// greatly increases RAM usage and fill rate, so use it sparingly. Only works in XR mode. If known in advance, set
    /// this via [`crate::sk::SkSettings`] in initialization. This is a very costly change to make.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Multisample.html>
    ///
    /// see also [`render_set_multisample`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Renderer;
    ///
    /// assert_eq!(Renderer::get_multisample(), 1);
    ///
    /// Renderer::multisample(4);
    /// assert_eq!(Renderer::get_multisample(), 4);
    ///
    /// Renderer::multisample(1);
    /// assert_eq!(Renderer::get_multisample(), 1);
    /// ```
    pub fn multisample(level: i32) {
        unsafe { render_set_multisample(level) }
    }

    /// For flatscreen applications only! This allows you to change the camera projection between perspective and
    /// orthographic projection. This may be of interest for some category of UI work, but is generally a niche piece of
    /// functionality.
    /// Swapping between perspective and orthographic will also switch the clipping planes and field of view to the
    /// values associated with that mode. See set_clip/set_fov for perspective, and set_ortho_clip/set_ortho_size for
    /// orthographic.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Projection.html>
    ///
    /// see also [`render_set_projection`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{Renderer, Projection};
    ///
    /// assert_eq!(Renderer::get_projection(), Projection::Perspective);
    ///
    /// Renderer::projection(Projection::Orthographic);
    /// assert_eq!(Renderer::get_projection(), Projection::Orthographic);
    ///
    /// Renderer::projection(Projection::Perspective);
    /// assert_eq!(Renderer::get_projection(), Projection::Perspective);
    /// ```
    pub fn projection(projection: Projection) {
        unsafe { render_set_projection(projection) }
    }

    /// OpenXR has a recommended default for the main render surface, this value allows you to set SK’s surface to a
    /// multiple of the recommended size. Note that the final resolution may also be clamped or quantized. Only works in
    /// XR mode. If known in advance, set this via [`crate::sk::SkSettings`] in initialization. This is a very costly change to make.
    /// Consider if Viewport_scaling will work for you instead, and prefer that.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Scaling.html>
    ///
    /// see also [`render_set_scaling`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Renderer;
    ///
    /// assert_eq!(Renderer::get_scaling(), 1.0);
    ///
    /// Renderer::scaling(0.5);
    /// assert_eq!(Renderer::get_scaling(), 0.5);
    ///
    /// Renderer::scaling(1.0);
    /// assert_eq!(Renderer::get_scaling(), 1.0);
    /// ```
    pub fn scaling(scaling: f32) {
        unsafe { render_set_scaling(scaling) }
    }

    /// This allows you to trivially scale down the area of the swapchain that StereoKit renders to! This can be used
    /// to boost performance in situations where full resolution is not needed, or to reduce GPU time. This value is
    /// locked to the 0-1 range
    /// <https://stereokit.net/Pages/StereoKit/Renderer/ViewportScaling.html>
    ///
    /// see also [`render_set_viewport_scaling`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Renderer;
    ///
    /// assert_eq!(Renderer::get_viewport_scaling(), 1.0);
    ///
    /// Renderer::viewport_scaling(0.5);
    /// assert_eq!(Renderer::get_viewport_scaling(), 0.5);
    ///
    /// Renderer::viewport_scaling(1.0);
    /// assert_eq!(Renderer::get_viewport_scaling(), 1.0);
    /// ```
    pub fn viewport_scaling(scaling: f32) {
        unsafe { render_set_viewport_scaling(scaling) }
    }

    /// Sets the lighting information for the scene! You can build one through [`SphericalHarmonics::from_lights`], or grab
    /// one from [`crate::tex::SHCubemap`]
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SkyLight.html>
    ///
    /// see also [`render_set_skylight`] [`crate::tex::SHCubemap`] [`crate::util::SHLight`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Renderer, maths::Vec3,
    ///                      util::{named_colors, SphericalHarmonics, SHLight}};
    ///
    /// let light1 = SHLight::new([0.0, 1.0, 0.0], named_colors::WHITE);
    /// let light2 = SHLight::new([0.0, 0.0, 1.0], named_colors::WHITE);
    ///
    /// let mut sh = SphericalHarmonics::from_lights(&[light1, light2]);
    ///
    /// Renderer::sky_light(sh);
    /// let sky_light = Renderer::get_sky_light();
    ///
    /// assert_eq!(sky_light, sh);
    /// assert_eq!(sh.get_dominent_light_direction(),
    ///            Vec3 { x: -0.0, y: -1.0, z: -1.0 }.get_normalized())
    /// ```
    pub fn sky_light(light_info: SphericalHarmonics) {
        unsafe { render_set_skylight(&light_info) }
    }

    /// Set a cubemap skybox texture for rendering a background! This is only visible on Opaque displays, since
    /// transparent displays have the real world behind them already! StereoKit has a a default procedurally generated
    /// skybox. You can load one with [`crate::tex::SHCubemap`]. If you’re trying to affect the lighting,
    /// see [`Renderer::sky_light`].
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SkyTex.html>
    ///
    /// see also [`render_set_skytex`] [`crate::tex::SHCubemap`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Renderer, Assets}, tex::{Tex, TexType}};
    ///
    /// let sky_tex = Tex::from_file("hdri/sky_dawn.jpeg", true, None)
    ///                        .expect("sky_tex should be created");
    ///
    /// Assets::block_for_priority(i32::MAX);
    ///
    /// Renderer::sky_tex(&sky_tex);
    /// let sky_tex_get = Renderer::get_sky_tex();
    ///
    /// assert_eq!(sky_tex_get, sky_tex);
    /// ```
    pub fn sky_tex(tex: impl AsRef<Tex>) {
        unsafe { render_set_skytex(tex.as_ref().0.as_ptr()) }
    }

    /// This is the Material that StereoKit is currently using to draw the skybox! It needs a special shader that's
    /// tuned for a full-screen quad. If you just want to change the skybox image, try setting [`Renderer::sky_tex`]
    /// instead.
    ///  
    /// This value will never be null! If you try setting this to null, it will assign SK's built-in default sky
    /// material. If you want to turn off the skybox, see [`Renderer::enable_sky`] instead.
    ///  
    /// Recommended Material settings would be:
    /// - DepthWrite: false
    /// - DepthTest: LessOrEq
    /// - QueueOffset: 100
    ///
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SkyMaterial.html>
    ///
    /// see also [`render_set_skymaterial`] [`crate::tex::SHCubemap`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Renderer, material::Material, util::named_colors};
    ///
    /// let material = Material::pbr().copy();
    /// Renderer::sky_material(&material);
    ///
    /// let same_material = Renderer::get_sky_material();
    /// assert_eq!(same_material, material);
    /// ```
    pub fn sky_material(material: impl AsRef<Material>) {
        unsafe { render_set_skymaterial(material.as_ref().0.as_ptr()) }
    }

    /// Adds a mesh to the render queue for this frame! If the Hierarchy has a transform on it, that transform is
    /// combined with the Matrix provided here.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Add.html>
    /// * `mesh` - A valid Mesh you wish to draw.
    /// * `material` - A Material to apply to the Mesh.
    /// * `transform` - A Matrix that will transform the mesh from Model Space into the current Hierarchy Space.
    /// * `color` - A per-instance linear space color value to pass into the shader! Normally this gets used like a
    ///   material tint. If you’re adventurous and don’t need per-instance colors, this is a great spot to pack in
    ///   extra per-instance data for the shader! If None has default value of WHITE
    /// * `layer` - All visuals are rendered using a layer bit-flag. By default, all layers are rendered, but this can be
    ///   useful for filtering out objects for different rendering purposes! For example: rendering a mesh over the
    ///   user’s head from a 3rd person perspective, but filtering it out from the 1st person perspective.If None has
    ///   default value of RenderLayer::Layer0
    ///
    /// see also [`render_add_mesh`] [`Mesh::draw`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Renderer, RenderLayer}, maths::{Vec3, Matrix},
    ///                      mesh::Mesh, material::Material, util::named_colors};
    ///
    /// let sphere = Mesh::generate_sphere(0.5, None);
    /// let material = Material::pbr();
    /// let transform1 = Matrix::t([-0.5, 0.0, 0.0]);
    /// let transform2 = Matrix::t([ 0.5, 0.0, -1.0]);
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///
    ///     Renderer::add_mesh(token, &sphere, &material, transform1,
    ///         Some(named_colors::RED.into()), Some(RenderLayer::Layer0));
    ///
    ///     Renderer::add_mesh(token, &sphere, &material, transform2, None, None);
    /// );
    /// ```
    pub fn add_mesh(
        _token: &MainThreadToken,
        mesh: impl AsRef<Mesh>,
        material: impl AsRef<Material>,
        transform: impl Into<Matrix>,
        color: Option<Color128>,
        layer: Option<RenderLayer>,
    ) {
        let color = color.unwrap_or(Color128::WHITE);
        let layer = layer.unwrap_or(RenderLayer::Layer0);
        unsafe {
            render_add_mesh(mesh.as_ref().0.as_ptr(), material.as_ref().0.as_ptr(), &transform.into(), color, layer)
        }
    }

    /// Adds a Model to the render queue for this frame! If the Hierarchy has a transform on it, that transform is
    /// combined with the Matrix provided here.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Add.html>
    /// * `model` -  A valid Model you wish to draw.
    /// * `transform` - A Matrix that will transform the Model from Model Space into the current Hierarchy Space.
    /// * `color` - A per-instance linear space color value to pass into the shader! Normally this gets used like a
    ///   material tint. If you’re adventurous and don’t need per-instance colors, this is a great spot to pack in
    ///   extra per-instance data for the shader! If None has default value of WHITE
    /// * `layer` - All visuals are rendered using a layer bit-flag. By default, all layers are rendered, but this can
    ///   be useful for filtering out objects for different rendering purposes! For example: rendering a mesh over the
    ///   user’s head from a 3rd person perspective, but filtering it out from the 1st person perspective. If None has
    ///   default value of RenderLayer::Layer0
    ///
    /// see also [`render_add_model`] [`Model::draw`] [`Model::draw_with_material`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Renderer, RenderLayer}, maths::{Vec3, Matrix},
    ///                      model::Model, util::named_colors};
    ///
    /// let model = Model::from_file("plane.glb", None).expect("plane.glb should be there");
    /// let transform1 = Matrix::t([-2.5, 0.0, -5.0]);
    /// let transform2 = Matrix::t([ 2.5, 0.0, -5.0]);
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///
    ///     Renderer::add_model(token, &model, transform1,
    ///         Some(named_colors::RED.into()), Some(RenderLayer::Layer0));
    ///
    ///     Renderer::add_model(token, &model, transform2, None, None);
    /// );
    /// ```
    pub fn add_model(
        _token: &MainThreadToken,
        model: impl AsRef<Model>,
        transform: impl Into<Matrix>,
        color: Option<Color128>,
        layer: Option<RenderLayer>,
    ) {
        let color = color.unwrap_or(Color128::WHITE);
        let layer = layer.unwrap_or(RenderLayer::Layer0);
        unsafe { render_add_model(model.as_ref().0.as_ptr(), &transform.into(), color, layer) }
    }

    /// Renders a Material onto a rendertarget texture! StereoKit uses a 4 vert quad stretched over the surface of the
    /// texture, and renders the material onto it to the texture.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Blit.html>
    /// * `to_render_target` - A texture that’s been set up as a render target!
    /// * `material` - This material is rendered onto the texture! Set it up like you would if you were applying it to
    ///   a plane, or quad mesh.
    ///
    /// see also [`render_blit`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Renderer, material::Material, tex::Tex};
    ///
    /// let material = Material::pbr();
    /// let tex = Tex::render_target(200,200, None, None, None)
    ///                    .expect("RenderTarget should be created");
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     Renderer::blit(&tex, &material);
    /// );
    /// ```
    pub fn blit(to_render_target: impl AsRef<Tex>, material: impl AsRef<Material>) {
        unsafe { render_blit(to_render_target.as_ref().0.as_ptr(), material.as_ref().0.as_ptr()) }
    }

    /// The capture_filter is a layer mask for Mixed Reality Capture, or 2nd person observer rendering. On HoloLens and
    /// WMR, this is the video rendering feature. This allows you to hide, or reveal certain draw calls when rendering
    /// video output.
    ///
    /// By default, the capture_filter will always be the same as [`Renderer::layer_filter`], overriding this will mean this
    /// filter no longer updates with layer_filter.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/OverrideCaptureFilter.html>
    /// * `use_override_filter` - Enables (true) or disables (false) the overridden filter value provided here.
    /// * `override_filter` - The filter for capture rendering to use. This is ignored if useOverrideFilter is false.
    ///
    /// see also [`render_override_capture_filter`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Renderer, RenderLayer},
    ///                      maths::Matrix, mesh::Mesh, material::Material};
    ///
    /// let sphere = Mesh::generate_sphere(0.2, None);
    /// let material = Material::pbr();
    ///
    /// assert_eq!(Renderer::has_capture_filter(), false);
    /// assert_eq!(Renderer::get_capture_filter(), RenderLayer::AllFirstPerson);
    ///
    /// Renderer::override_capture_filter(true, RenderLayer::Layer1);
    ///
    /// assert_eq!(Renderer::has_capture_filter(), true);
    /// assert_eq!(Renderer::get_capture_filter(), RenderLayer::Layer1);
    ///
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     sphere.draw(token, &material, Matrix::IDENTITY, None, Some(RenderLayer::Layer1));
    /// );
    ///
    /// Renderer::override_capture_filter(false, RenderLayer::Layer0);
    /// assert_eq!(Renderer::has_capture_filter(), false);
    /// ```
    pub fn override_capture_filter(use_override_filter: bool, override_filter: RenderLayer) {
        unsafe { render_override_capture_filter(use_override_filter as Bool32T, override_filter) }
    }

    /// This renders the current scene to the indicated rendertarget texture, from the specified viewpoint. This call
    /// enqueues a render that occurs immediately before the screen itself is rendered.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/RenderTo.html>
    /// * `to_render_target` - The texture to which the scene will be rendered to. This must be a Rendertarget type
    ///   texture.
    /// * `to_target_index` - (Optional) Index of the render target's array slice we want to draw to. If None, defaults
    ///   to 0. This is only relevant for array/render target textures with multiple slices.
    /// * `camera` - A TRS matrix representing the location and orientation of the camera. This matrix gets inverted
    ///   later on, so no need to do it yourself.
    /// * `projection` - The projection matrix describes how the geometry is flattened onto the draw surface. Normally,
    ///   you’d use Matrix::perspective, and occasionally Matrix::orthographic might be helpful as well.
    /// * `layer_filter` - This is a bit flag that allows you to change which layers StereoKit renders for this particular
    ///   render viewpoint. To change what layers a visual is on, use a Draw method that includes a RenderLayer as a
    ///   parameter. If None has default value of RenderLayer::ALL
    /// * `material_variant` - Specifies which Material variant should be used for rendering. 0 will be the normal
    ///   default material, any others will generally be application-defined by setting up each Material's Variant with
    ///   specific shaders. If a Material has no corresponding variant, it will not be drawn.
    /// * `clear` - Describes if and how the rendertarget should be cleared before rendering. Note that clearing the
    ///   target is unaffected by the viewport, so this will clean the entire surface! If None has default value of
    ///   RenderClear::All
    /// * `vieport` - Allows you to specify a region of the rendertarget to draw to! This is in normalized coordinates,
    ///   0-1. If the width of this value is zero, then this will render to the entire texture. If None has default value
    ///   of (0, 0, 0, 0)
    ///
    /// see also [`render_to`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Renderer, RenderLayer}, maths::{Vec3, Quat, Matrix},
    ///                      render_list::RenderList, tex::{Tex, TexType, TexFormat},
    ///                      mesh::Mesh, model::Model, material::Material, util::named_colors};
    ///
    /// let sun = Mesh::generate_sphere(5.0, None);
    /// let material = Material::pbr();
    /// let transform_sun = Matrix::t([-6.0, -1.0, -10.0]);
    ///
    /// let plane = Mesh::generate_plane_up([1.0,1.0], None, true);
    /// let mut material = Material::unlit().copy();
    /// let tex = Tex::render_target(200,200, None, None, None)
    ///                    .expect("RenderTarget should be created");
    /// material.diffuse_tex(&tex);
    /// let transform_plane = Matrix::t([0.0, -0.55, 0.0]);
    ///
    /// let camera = Matrix::t_r(Vec3::Z * 2.0, Quat::look_at(Vec3::Z, Vec3::ZERO, None));
    /// let projection = Matrix::perspective(90.0, 1.0, 0.1, 20.0);
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     
    ///     Renderer::add_mesh(token, &sun, &material, transform_sun,
    ///         Some(named_colors::RED.into()), None);
    ///
    ///     Renderer::add_mesh(token, &plane, &material, transform_plane,
    ///         None, None);
    ///
    ///     Renderer::render_to(token, &tex, None, camera, projection, None, None, None, None);
    /// );
    /// ```
    #[allow(clippy::too_many_arguments)]
    pub fn render_to<M: Into<Matrix>>(
        _token: &MainThreadToken,
        to_render_target: impl AsRef<Tex>,
        to_target_index: Option<i32>,
        camera: M,
        projection: M,
        layer_filter: Option<RenderLayer>,
        material_variant: Option<i32>,
        clear: Option<RenderClear>,
        viewport: Option<Rect>,
    ) {
        let to_target_index = to_target_index.unwrap_or(0);
        let layer_filter = layer_filter.unwrap_or(RenderLayer::All);
        let material_variant = material_variant.unwrap_or(0);
        let clear = clear.unwrap_or(RenderClear::All);
        let viewport = viewport.unwrap_or_default();

        unsafe {
            render_to(
                to_render_target.as_ref().0.as_ptr(),
                to_target_index,
                &camera.into(),
                &projection.into(),
                layer_filter,
                material_variant,
                clear,
                viewport,
            )
        }
    }

    /// This attaches a texture resource globally across all shaders. StereoKit uses this to attach the sky cubemap for
    /// use in reflections across all materials (register 11). It can be used for things like shadowmaps, wind data, etc.
    ///  Prefer a higher registers (11+) to prevent conflicting with normal Material textures.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SetGlobalTexture.html>
    /// * `texture_register` - The texture resource register the texture will bind to. SK uses register 11 already, so
    ///   values above that should be fine.
    /// * `tex` - The texture to assign globally. Setting None here will clear any texture that is currently bound.
    ///
    /// see also [`render_global_texture`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Renderer, RenderLayer}, tex::{Tex, TexFormat},
    ///                      maths::Matrix, util::named_colors};
    ///
    /// let tex = Tex::from_file("hdri/sky_dawn.jpeg", true, None)
    ///                    .expect("tex should be created");
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     if iter < 2 {
    ///         Renderer::set_global_texture(token, 12, Some(&tex));
    ///     } else {
    ///         Renderer::set_global_texture(token, 12, None);
    ///     }
    /// );
    /// ```
    pub fn set_global_texture(_token: &MainThreadToken, texture_register: i32, tex: Option<&Tex>) {
        if let Some(tex) = tex {
            unsafe { render_global_texture(texture_register, tex.0.as_ptr()) }
        } else {
            unsafe { render_global_texture(texture_register, null_mut()) }
        }
    }

    /// This attaches a buffer resource globally across all shaders. StereoKit uses this to attach the stereokit
    /// rendering constants. It can be used for things like shadowmaps, wind data, etc.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SetGlobalBuffer.html>
    /// * `buffer_register` - Valid values are 3-16. This is the register id that this data will be bound to. In HLSL,
    ///   you'll see the slot id for '3' indicated like this `: register(b3)`
    /// * `buffer` - The data buffer you would like to bind
    ///
    /// see also [`render_global_buffer`] []
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Renderer, material::MaterialBuffer};
    ///
    /// #[repr(C)]
    /// #[derive(Default, Copy, Clone)]
    /// struct Globals { time: f32, padding: [f32;3] }
    ///
    /// let mut globals = Globals { time: 1.0, ..Default::default() };
    /// let buffer = MaterialBuffer::<Globals>::new();
    /// buffer.set(&mut globals as *mut _);
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///     // Bind the buffer to slot 3 so shaders can read it.
    ///     Renderer::set_global_buffer( 3, &buffer);
    /// );
    /// ```
    pub fn set_global_buffer<T>(buffer_register: i32, buffer: &MaterialBuffer<T>) {
        unsafe {
            render_global_buffer(buffer_register, buffer.as_ref().as_ptr());
        }
    }

    /// Unbinds any global MaterialBuffer previously bound to this register slot (3-16). Equivalent to passing None
    /// to [`Renderer::set_global_buffer`]. Provided as a convenience method.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SetGlobalBuffer.html>
    /// * `buffer_register` - Valid values are 3-16. This is the register id the data was bound to.
    ///
    /// see also [`render_global_buffer`] [`Renderer::set_global_buffer`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Renderer, material::MaterialBuffer};
    ///
    /// #[repr(C)]
    /// #[derive(Default, Copy, Clone)]
    /// struct Globals { value: f32, padding: [f32;3] }
    /// let buffer = MaterialBuffer::<Globals>::new();
    /// test_steps!(
    ///     Renderer::set_global_buffer(4, &buffer);
    ///     // Later we decide to unbind it completely
    ///     if iter == number_of_steps -1 {
    ///         Renderer::unset_global_buffer(4);
    ///     }
    /// );
    /// ```
    pub fn unset_global_buffer(buffer_register: i32) {
        unsafe { render_global_buffer(buffer_register, std::ptr::null_mut()) }
    }

    /// Schedules a screenshot for the end of the frame! The view will be rendered from the given pose, with a
    /// resolution the same size as the screen’s surface. It’ll be saved as a JPEG or PNG file depending on the filename
    /// extension provided.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Screenshot.html>
    /// * `filename` - Filename to write the screenshot to! This will be a PNG if the extension ends with (case
    ///   insensitive) “.png”, and will be a 90 quality JPEG if it ends with anything else.
    /// * `file_quality` - For JPEG files, this is the compression quality of the file from 0-100, 100 being highest
    ///   quality, 0 being smallest size. SK uses a default of 90 here.
    /// * `viewpoint` - is Pose::look_at(from_point, looking_at_point)
    /// * `width` - Size of the screenshot horizontally, in pixels.
    /// * `height`- Size of the screenshot vertically, in pixels
    /// * `field_of_view` - The angle of the viewport, in degrees. If None will use default value of 90°
    ///
    /// see also [`render_screenshot`]
    /// see example in [`Renderer`]
    pub fn screenshot(
        _token: &MainThreadToken,
        filename: impl AsRef<Path>,
        file_quality: i32,
        viewpoint: Pose,
        width: i32,
        height: i32,
        field_of_view: Option<f32>,
    ) {
        let path = filename.as_ref();
        let c_str = CString::new(path.to_str().unwrap_or("!!!path.to_str error!!!").to_owned()).unwrap();
        let field_of_view = field_of_view.unwrap_or(90.0);
        unsafe { render_screenshot(c_str.as_ptr(), file_quality, viewpoint, width, height, field_of_view) }
    }

    /// Schedules a screenshot for the end of the frame! The view will be rendered from the given position at the given
    /// point, with a resolution the same size as the screen’s surface. This overload allows for retrieval of the color
    /// data directly from the render thread! You can use the color data directly by saving/processing it inside your
    /// callback, or you can keep the data alive for as long as it is referenced.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Screenshot.html>
    /// * `on_screenshot` : closure |&[Color32], width:usize, height:usize|
    /// * `viewpoint` - is Pose::look_at(from_point, looking_at_point)
    /// * `width` - Size of the screenshot horizontally, in pixels.
    /// * `height`- Size of the screenshot vertically, in pixels
    /// * `field_of_view` - The angle of the viewport, in degrees. If None will use default value of 90°
    /// * `tex_format` - The pixel format of the color data. If None will use default value of TexFormat::RGBA32
    ///
    /// see also [`render_screenshot_capture`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Renderer, RenderLayer}, maths::{Vec3, Quat, Pose, Matrix},
    ///                      render_list::RenderList, tex::{Tex, TexType, TexFormat},
    ///                      mesh::Mesh, model::Model, material::Material, util::named_colors};
    ///
    /// let sun = Mesh::generate_sphere(7.0, None);
    /// let material_sun = Material::pbr();
    /// let transform_sun = Matrix::t([-6.0, 3.0, -10.0]);
    ///
    /// let plane = Mesh::generate_plane_up([1.0,1.0], None, true);
    /// let mut material = Material::unlit().copy();
    /// let mut tex = Tex::render_target(200,200, None, None, None)
    ///                    .expect("RenderTarget should be created");
    /// tex.id("CAPTURE_TEXTURE_ID");
    /// material.diffuse_tex(&tex);
    /// let transform_plane = Matrix::t([0.0, -0.55, 0.0]);
    ///
    /// let camera_pose = Pose::new([0.0, 0.0, 1.0], None);
    ///
    /// number_of_steps = 20;
    /// filename_scr = "screenshots/screenshot_capture.jpeg";
    /// test_screenshot!( // !!!! Get a proper main loop !!!!
    ///     
    ///     Renderer::add_mesh(token, &sun, &material_sun, transform_sun,
    ///         Some(named_colors::RED.into()), None);
    ///
    ///     Renderer::add_mesh(token, &plane, &material, transform_plane,
    ///         None, None);
    ///
    ///     Renderer::screenshot_capture( token,
    ///         move |dots, width, height| {
    ///             let tex = Tex::find("CAPTURE_TEXTURE_ID").ok();
    ///             match tex {
    ///                 Some(mut tex) => tex.set_colors32(width, height, dots),
    ///                 None => panic!("CAPTURE_TEXTURE_ID not found!"),
    ///             };
    ///         },
    ///         camera_pose, 200, 200, None, None
    ///     );
    /// );
    /// ```
    /// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/screenshot_capture.jpeg" alt="screenshot" width="200">
    pub fn screenshot_capture<F: FnMut(&[Color32], usize, usize)>(
        _token: &MainThreadToken,
        mut on_screenshot: F,
        viewpoint: Pose,
        width: i32,
        height: i32,
        field_of_view: Option<f32>,
        tex_format: Option<TexFormat>,
    ) {
        let field_of_view = field_of_view.unwrap_or(90.0);
        let tex_format = tex_format.unwrap_or(TexFormat::RGBA32);
        let mut closure = &mut on_screenshot;
        unsafe {
            render_screenshot_capture(
                Some(sc_capture_trampoline::<F>),
                viewpoint,
                width,
                height,
                field_of_view,
                tex_format,
                &mut closure as *mut _ as *mut c_void,
            )
        }
    }

    /// Schedules a screenshot for the end of the frame! The view will be rendered from the given position at the given
    /// point, with a resolution the same size as the screen’s surface. This overload allows for retrieval of the color
    /// data directly from the render thread! You can use the color data directly by saving/processing it inside your
    /// callback, or you can keep the data alive for as long as it is referenced.
    ///  <https://stereokit.net/Pages/StereoKit/Renderer/Screenshot.html>
    /// * `on_screenshot` : closure |&[Color32], width:usize, height:usize|
    /// * `camera` - A TRS matrix representing the location and orientation of the camera. This matrix gets inverted
    ///   later on, so no need to do it yourself.
    /// * `projection` - The projection matrix describes how the geometry is flattened onto the draw surface. Normally,
    ///   you’d use [`Matrix::perspective`], and occasionally [`Matrix::orthographic`] might be helpful as well.
    /// * `width` - Size of the screenshot horizontally, in pixels.
    /// * `height`- Size of the screenshot vertically, in pixels
    /// * `render_layer` - This is a bit flag that allows you to change which layers StereoKit renders for this
    ///   particular render viewpoint. To change what layers a visual is on, use a Draw method that includes a
    ///   RenderLayer as a parameter. If None will use default value of All
    /// * `clear` - Describes if and how the rendertarget should be cleared before rendering. Note that clearing the
    ///   target is unaffected by the viewport, so this will clean the entire surface! If None wille use default value
    ///   of All
    /// * `viewport` - Allows you to specify a region of the rendertarget to draw to! This is in normalized coordinates,
    ///   0-1. If the width of this value is zero, then this will render to the entire texture. If None has default value
    ///   of (0, 0, 0, 0)
    /// * `tex_format` - The pixel format of the color data. If None will use default value of TexFormat::RGBA32
    ///
    /// see also [`render_screenshot_viewpoint`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Renderer, RenderLayer}, maths::{Vec3, Quat, Pose, Matrix},
    ///                      render_list::RenderList, tex::{Tex, TexType, TexFormat},
    ///                      mesh::Mesh, model::Model, material::Material, util::named_colors};
    ///
    /// let sun = Mesh::generate_sphere(7.0, None);
    /// let material_sun = Material::pbr();
    /// let transform_sun = Matrix::t([6.0, 3.0, -10.0]);
    ///
    /// let plane = Mesh::generate_plane_up([1.0,1.0], None, true);
    /// let mut material = Material::unlit().copy();
    /// let mut tex = Tex::gen_color(named_colors::VIOLET, 200, 200, TexType::Rendertarget, TexFormat::RGBA32);
    ///
    /// tex.id("CAPTURE_TEXTURE_ID");
    /// material.diffuse_tex(&tex);
    /// let transform_plane = Matrix::t([0.0, -0.55, 0.0]);
    ///
    /// let camera = Matrix::t_r(Vec3::Z * 2.0, Quat::look_at(Vec3::Z, Vec3::ZERO, None));
    /// let projection = Matrix::perspective(90.0, 1.0, 0.1, 20.0);
    ///
    /// number_of_steps = 200;
    /// filename_scr = "screenshots/screenshot_viewpoint.jpeg";
    /// test_screenshot!( // !!!! Get a proper main loop !!!!
    ///     
    ///     Renderer::add_mesh(token, &sun, &material_sun, transform_sun,
    ///         Some(named_colors::RED.into()), None);
    ///
    ///     Renderer::add_mesh(token, &plane, &material, transform_plane,
    ///         None, None);
    ///
    ///     Renderer::screenshot_viewpoint( token,
    ///         move |dots, width, height| {
    ///             let tex = Tex::find("CAPTURE_TEXTURE_ID").ok();
    ///             match tex {
    ///                 Some(mut tex) => tex.set_colors32(width, height, dots),
    ///                 None => panic!("CAPTURE_TEXTURE_ID not found!"),
    ///             };
    ///         },
    ///         camera, projection, 200, 200, None, None, None, None
    ///     );
    /// );
    /// ```
    /// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/screenshot_viewpoint.jpeg" alt="screenshot" width="200">
    #[allow(clippy::too_many_arguments)]
    pub fn screenshot_viewpoint<M: Into<Matrix>, F: FnMut(&[Color32], usize, usize)>(
        _token: &MainThreadToken,
        mut on_screenshot: F,
        camera: M,
        projection: M,
        width: i32,
        height: i32,
        render_layer: Option<RenderLayer>,
        clear: Option<RenderClear>,
        viewport: Option<Rect>,
        tex_format: Option<TexFormat>,
    ) {
        let tex_format = tex_format.unwrap_or(TexFormat::RGBA32);
        let render_layer = render_layer.unwrap_or(RenderLayer::all());
        let clear = clear.unwrap_or(RenderClear::All);
        let viewport = viewport.unwrap_or_default();
        let mut closure = &mut on_screenshot;
        unsafe {
            render_screenshot_viewpoint(
                Some(sc_capture_trampoline::<F>),
                camera.into(),
                projection.into(),
                width,
                height,
                render_layer,
                clear,
                viewport,
                tex_format,
                &mut closure as *mut _ as *mut c_void,
            )
        }
    }

    /// Set the near and far clipping planes of the camera! These are important to z-buffer quality, especially when
    /// using low bit depth z-buffers as recommended for devices like the HoloLens. The smaller the range between the
    /// near and far planes, the better your z-buffer will look! If you see flickering on objects that are overlapping,
    /// try making the range smaller.
    ///
    /// These values only affect perspective mode projection, which is the default projection mode.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SetClip.html>
    /// * `near_plane` - The GPU discards pixels that are too close to the camera, this is that distance! It must be
    ///   larger than zero, due to the projection math, which also means that numbers too close to zero will produce
    ///   z-fighting artifacts. This has an enforced minimum of 0.001, but you should probably stay closer to 0.1.
    /// * `far_plane` - At what distance from the camera does the GPU discard pixel? This is not true distance, but
    ///   rather Z-axis distance from zero in View Space coordinates!
    ///
    /// see also [`render_set_clip`] [`Renderer::get_clip`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Renderer;
    ///
    /// let (near, far) = Renderer::get_clip();
    /// assert_eq!(near, 0.02);
    /// assert_eq!(far, 50.0);
    ///
    /// Renderer::set_clip(0.01, 10.0);
    /// let (near, far) = Renderer::get_clip();
    /// assert_eq!(near, 0.01);
    /// assert_eq!(far, 10.0);
    /// ```
    pub fn set_clip(near_plane: f32, far_plane: f32) {
        unsafe { render_set_clip(near_plane, far_plane) }
    }

    /// Only works for 2D windowed modes! This updates the camera's projection matrix with a new vertical field of view.
    ///
    /// This value only affects perspective mode projection, which is the default projection mode.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SetFOV.html>
    /// * `vertical_field_of_view` - Vertical field of view in degrees.`
    ///
    /// see also [`render_set_fov`] [`Renderer::get_fov`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Renderer;
    /// let fov = Renderer::get_fov();
    /// assert_eq!(fov, 90.0);
    ///
    /// Renderer::set_fov(120.0);
    /// let fov = Renderer::get_fov();
    /// assert_eq!(fov, 120.0);
    /// ```
    pub fn set_fov(vertical_field_of_view: f32) {
        unsafe { render_set_fov(vertical_field_of_view) }
    }

    /// Set the near and far clipping planes of the camera! These are important to z-buffer quality, especially when
    /// using low bit depth z-buffers as recommended for devices like the HoloLens. The smaller the range between the
    /// near and far planes, the better your z-buffer will look! If you see flickering on objects that are overlapping,
    /// try making the range smaller.
    ///
    /// These values only affect orthographic mode projection, which is only available in 2D window modes.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SetOrthoClip.html>
    /// * `near_plane` - The GPU discards pixels that are too close to the camera, this is that distance! It must be
    ///   larger than zero, due to the projection math, which also means that numbers too close to zero will produce
    ///   z-fighting artifacts. This has an enforced minimum of 0.001, but you should probably stay closer to 0.1.
    /// * `far_plane` - At what distance from the camera does the GPU discard pixel? This is not true distance, but
    ///   rather Z-axis distance from zero in View Space coordinates!
    ///
    /// see also [`render_set_ortho_clip`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Renderer;
    ///
    /// Renderer::set_ortho_clip(0.01, 5.0);
    /// ```
    pub fn set_ortho_clip(near_plane: f32, far_plane: f32) {
        unsafe { render_set_ortho_clip(near_plane, far_plane) }
    }

    /// This sets the size of the orthographic projection’s viewport. You can use this feature to zoom in and out of the
    /// scene.
    ///
    /// This value only affects orthographic mode projection, which is only available in 2D window modes.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SetOrthoSize.html>
    /// * `viewport_height_meters` - The vertical size of the projection’s viewport, in meters.
    ///
    /// see also [`render_set_ortho_size`] [`Renderer::get_ortho_size`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::Renderer;
    ///
    /// let ortho_size = Renderer::get_ortho_size();
    /// assert_eq!(ortho_size, 1.0);
    ///
    /// Renderer::set_ortho_size(12.0);
    /// let ortho_size = Renderer::get_ortho_size();
    /// assert_eq!(ortho_size, 12.0);
    /// ```
    pub fn set_ortho_size(view_port_height_meters: f32) {
        unsafe { render_set_ortho_size(view_port_height_meters) }
    }

    /// Gets the root transform of the camera! This will be the identity matrix by default. The user’s head
    /// location will then be relative to this point. This is great to use if you’re trying to do teleportation,
    /// redirected walking, or just shifting the floor around.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/CameraRoot.html>
    ///
    /// see also [`render_get_cam_root`]
    /// see example in [`Renderer::camera_root`]
    pub fn get_camera_root() -> Matrix {
        unsafe { render_get_cam_root() }
    }

    /// This retrieves the current near and far clipping planes for the perspective matrix of the primary draw surface.
    ///
    /// <https://stereokit.net/Pages/StereoKit/Renderer/GetClip.html>
    ///
    /// Returns a tuple (`near_plane`, `far_plane`)
    /// * `near_plane` - The GPU discards pixels that are too close to the camera, this is that distance! It will be larger
    ///   than zero, due to the projection math, which also means that numbers too close to zero will produce z-fighting artifacts. This
    ///   has an enforced minimum of 0.001, but will probably be closer to 0.1.
    /// * `far_plane` - At what distance from the camera does the GPU discard pixel? This is not true distance, but rather Z-axis
    ///   distance from zero in View Space coordinates!
    ///
    /// see also [`render_get_clip`]
    /// see example in [`Renderer::set_clip`]
    pub fn get_clip() -> (f32, f32) {
        let mut near_plane = 0.0;
        let mut far_plane = 0.0;
        unsafe { render_get_clip(&mut near_plane, &mut far_plane) }
        (near_plane, far_plane)
    }

    /// Only works for 2D windowed modes! This retrieves the vertical field of view of the camera's projection matrix when in
    /// perspective projection mode.
    ///
    /// <https://stereokit.net/Pages/StereoKit/Renderer/GetFOV.html>
    ///
    /// see also [`render_get_fov`]
    /// see example in [`Renderer::set_fov`]
    pub fn get_fov() -> f32 {
        unsafe { render_get_fov() }
    }

    /// This retrieves the size the primary render surface's view when using orthographic projection mode.
    ///
    /// <https://stereokit.net/Pages/StereoKit/Renderer/GetOrthoSize.html>
    ///
    /// see also [`render_get_ortho_size`] []
    /// see example in [`Renderer::set_ortho_size`]
    pub fn get_ortho_size() -> f32 {
        unsafe { render_get_ortho_size() }
    }

    /// This is the current render layer mask for Mixed Reality Capture, or 2nd person observer rendering. By default,
    /// this is directly linked to Renderer::layer_filter, but this behavior can be overridden via
    /// Renderer::override_capture_filter.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/CaptureFilter.html>
    ///
    /// see also [`render_get_capture_filter`]
    /// see example in [`Renderer::override_capture_filter`]
    pub fn get_capture_filter() -> RenderLayer {
        unsafe { render_get_capture_filter() }
    }

    /// This is the gamma space color the renderer will clear the screen to when beginning to draw a new frame.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/ClearColor.html>
    ///
    /// see also [`render_get_clear_color`]
    /// see example in [`Renderer::clear_color`]
    pub fn get_clear_color() -> Color128 {
        unsafe { render_get_clear_color() }
    }

    /// Enables or disables rendering of the skybox texture! It’s enabled by default on Opaque displays, and completely
    /// unavailable for transparent displays.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/EnableSky.html>
    ///
    /// see also [`render_enabled_skytex`]
    /// see example in [`Renderer::enable_sky`]
    pub fn get_enable_sky() -> bool {
        unsafe { render_enabled_skytex() != 0 }
    }

    /// This tells if capture_filter has been overridden to a specific value via Renderer::override_capture_filter.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/HasCaptureFilter.html>
    ///
    /// see also [`render_has_capture_filter`]
    /// see example in [`Renderer::override_capture_filter`]
    pub fn has_capture_filter() -> bool {
        unsafe { render_has_capture_filter() != 0 }
    }

    /// By default, StereoKit renders all first-person layers. This is a bit flag that allows you to change which layers
    /// StereoKit renders for the primary viewpoint. To change what layers a visual is on, use a Draw method that
    /// includes a RenderLayer as a parameter.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/LayerFilter.html>
    ///
    /// see also [`render_get_filter`]
    /// see example in [`Renderer::layer_filter`]
    pub fn get_layer_filter() -> RenderLayer {
        unsafe { render_get_filter() }
    }

    /// Get the multisample (MSAA) level of the render surface. Valid values are 1, 2, 4, 8, 16, though
    /// some OpenXR runtimes may clamp this to lower values. Note that while this can greatly smooth out edges, it also
    /// greatly increases RAM usage and fill rate, so use it sparingly. Only works in XR mode. If known in advance, set
    /// this via [`crate::sk::SkSettings`] in initialization. This is a very costly change to make.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Multisample.html>
    ///
    /// see also [`render_get_multisample`]
    /// see example in [`Renderer::multisample`]
    pub fn get_multisample() -> i32 {
        unsafe { render_get_multisample() }
    }

    /// For flatscreen applications only! This allows you to get the camera projection between perspective and
    /// orthographic projection. This may be of interest for some category of UI work, but is generally a niche piece of
    /// functionality.
    /// Swapping between perspective and orthographic will also switch the clipping planes and field of view to the
    /// values associated with that mode. See set_clip/set_fov for perspective, and set_ortho_clip/set_ortho_size for
    /// orthographic.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Projection.html>
    ///
    /// see also [`render_get_projection`]
    /// see example in [`Renderer::projection`]
    pub fn get_projection() -> Projection {
        unsafe { render_get_projection() }
    }

    /// OpenXR has a recommended default for the main render surface, this value allows you to set SK’s surface to a
    /// multiple of the recommended size. Note that the final resolution may also be clamped or quantized. Only works in
    /// XR mode. If known in advance, set this via SKSettings in initialization. This is a very costly change to make.
    /// Consider if viewport_caling will work for you
    /// instead, and prefer that.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/Scaling.html>
    ///
    /// see also [`render_get_scaling`]
    /// see example in [`Renderer::scaling`]
    pub fn get_scaling() -> f32 {
        unsafe { render_get_scaling() }
    }

    /// This allows you to trivially scale down the area of the swapchain that StereoKit renders to! This can be used to
    /// boost performance in situations where full resolution is not needed, or to reduce GPU time. This value is
    /// locked to the 0-1 range
    /// <https://stereokit.net/Pages/StereoKit/Renderer/ViewportScaling.html>
    ///
    /// see also [`render_get_viewport_scaling`]
    /// see example in [`Renderer::viewport_scaling`]
    pub fn get_viewport_scaling() -> f32 {
        unsafe { render_get_viewport_scaling() }
    }

    /// Gets the lighting information for the scene! You can build one through SphericalHarmonics::from_lights, or grab
    /// one from [`crate::tex::SHCubemap`].
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SkyLight.html>
    ///
    /// see also [`render_get_skylight`]
    /// see example in [`Renderer::sky_light`]
    pub fn get_sky_light() -> SphericalHarmonics {
        unsafe { render_get_skylight() }
    }

    /// Get the cubemap skybox texture for rendering a background! This is only visible on Opaque displays, since
    /// transparent displays have the real world behind them already! StereoKit has a a default procedurally generated
    /// skybox. You can load one with [`crate::tex::SHCubemap`]. If you’re trying to affect the lighting,
    /// see Renderer::sky_light.
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SkyTex.html>
    ///
    /// see also [`render_get_skytex`]
    /// see example in [`Renderer::sky_tex`]
    pub fn get_sky_tex() -> Tex {
        let skytex_ptr = unsafe { render_get_skytex() };
        if let Some(nonnull_ptr) = NonNull::new(skytex_ptr) {
            Tex(nonnull_ptr)
        } else {
            // Si render_get_skytex() retourne null, on retourne une texture d'erreur par défaut
            Log::warn("render_get_skytex() returned null, returning error texture");
            Tex::error()
        }
    }

    /// This is the Material that StereoKit is currently using to draw the skybox! It needs a special shader that's
    /// tuned for a full-screen quad. If you just want to change the skybox image, try setting [`Renderer::sky_tex`]
    /// instead.
    ///  
    /// This value will never be null! If you try setting this to null, it will assign SK's built-in default sky
    /// material. If you want to turn off the skybox, see [`Renderer::enable_sky`] instead.
    ///  
    /// Recommended Material settings would be:
    /// - DepthWrite: false
    /// - DepthTest: LessOrEq
    /// - QueueOffset: 100
    ///
    /// <https://stereokit.net/Pages/StereoKit/Renderer/SkyMaterial.html>
    ///
    /// see also [`render_get_skymaterial`]
    /// see example in [`Renderer::sky_material`]
    pub fn get_sky_material() -> Material {
        Material(NonNull::new(unsafe { render_get_skymaterial() }).unwrap())
    }
}

/// A text style is a font plus size/color/material parameters, and are used to keep text looking more consistent
/// through the application by encouraging devs to re-use styles throughout the project. See Text.MakeStyle for making a
/// TextStyle object.
/// <https://stereokit.net/Pages/StereoKit/TextStyle.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::{TextStyle, Pivot, Align, Text, Lines, Hierarchy},
///                      font::Font, material::Material, mesh::Mesh, maths::{Vec3, Matrix},
///                      util::named_colors::{WHITE, GOLD, GREEN, BLUE, RED, BLACK}};
///
/// let font = Font::default();
/// let style = TextStyle::from_font(font, 0.88, WHITE);
/// let text = "ÂjlD;";
/// let size = Text::size_layout(text, Some(style), None);
///
/// let base_line_at   = -style.get_cap_height();
/// let ascender_at    = base_line_at + style.get_ascender();
/// let cap_height_at  = base_line_at + style.get_cap_height();
/// let descender_at   = base_line_at - style.get_descender();
/// let line_height_at = ascender_at - style.get_line_height_pct() * style. get_total_height();
///
/// let sizex = size.x;
///
/// let recenter = Matrix::t(Vec3::Y * 0.6);
///
/// filename_scr = "screenshots/text_style.jpeg"; fov_scr=110.0;
/// test_screenshot!( // !!!! Get a proper main loop !!!!
///    Hierarchy::push(token, recenter, None);
///    Text::add_at(token, text, Matrix::Y_180, Some(style), Some(GOLD.into()),
///             Some(Pivot::TopCenter), Some(Align::TopLeft), None, None, None);
///    
///    Lines::add(token, [sizex, ascender_at, 0.0],    [-sizex, ascender_at, 0.0],    GREEN, None, 0.03  );
///    Lines::add(token, [sizex, base_line_at, 0.0],   [-sizex, base_line_at, 0.0],   WHITE, None, 0.03  );
///    Lines::add(token, [sizex, cap_height_at, 0.0],  [-sizex, cap_height_at, 0.0],  BLACK, None, 0.03  );
///    Lines::add(token, [sizex, descender_at, 0.0],   [-sizex, descender_at, 0.0],   BLUE, None, 0.03  );
///    Lines::add(token, [sizex, line_height_at, 0.0], [-sizex, line_height_at, 0.0], RED, None, 0.03  );
///    Hierarchy::pop(token);
/// );
/// ```
/// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/text_style.jpeg" alt="screenshot" width="200">
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(C)]
pub struct TextStyle {
    _id: u32,
}

unsafe extern "C" {
    pub fn text_make_style(font: FontT, layout_height: f32, color_gamma: Color128) -> TextStyle;
    pub fn text_make_style_shader(font: FontT, layout_height: f32, shader: ShaderT, color_gamma: Color128)
    -> TextStyle;
    pub fn text_make_style_mat(
        font: FontT,
        layout_height: f32,
        material: MaterialT,
        color_gamma: Color128,
    ) -> TextStyle;
    pub fn text_style_get_line_height_pct(style: TextStyle) -> f32;
    pub fn text_style_set_line_height_pct(style: TextStyle, height_percent: f32);
    pub fn text_style_get_layout_height(style: TextStyle) -> f32;
    pub fn text_style_set_layout_height(style: TextStyle, height_meters: f32);
    pub fn text_style_get_total_height(style: TextStyle) -> f32;
    pub fn text_style_set_total_height(style: TextStyle, height_meters: f32);
    pub fn text_style_get_material(style: TextStyle) -> MaterialT;
    pub fn text_style_get_ascender(style: TextStyle) -> f32;
    pub fn text_style_get_descender(style: TextStyle) -> f32;
    pub fn text_style_get_cap_height(style: TextStyle) -> f32;
    pub fn text_style_get_baseline(style: TextStyle) -> f32;
}

impl Default for TextStyle {
    /// This is the default text style used by StereoKit.
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/Default.html>
    fn default() -> Self {
        Self { _id: 0 }
    }
}

impl TextStyle {
    /// Create a text style for use with other text functions! A text style is a font plus size/color/material
    /// parameters, and are used to keep text looking more consistent through the application by encouraging devs to
    /// re-use styles throughout the project.
    ///
    /// This fn will create an unique Material for this style based on Default.ShaderFont.
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/FromFont.html>
    /// * `font` - Font asset you want attached to this style.
    /// * `layout_height_meters` - Height of a text glyph in meters. StereoKit currently bases this on CapHeight.
    /// * `color_gamma` - The gamma space color of the text style. This will be embedded in the vertex color of the
    ///   text mesh.
    ///
    /// see also [`text_make_style`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::TextStyle, font::Font, util::named_colors};
    ///
    /// let font = Font::default();
    ///
    /// let text_style = TextStyle::from_font(&font, 0.02, named_colors::WHITE);
    ///
    /// assert_eq!(text_style.get_material().get_id(), "sk/text_style/2/material");
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    /// ```
    pub fn from_font(font: impl AsRef<Font>, layout_height_meters: f32, color_gamma: impl Into<Color128>) -> Self {
        unsafe { text_make_style(font.as_ref().0.as_ptr(), layout_height_meters, color_gamma.into()) }
    }

    /// Create a text style for use with other text functions! A text style is a font plus size/color/material
    /// parameters, and are used to keep text looking more consistent through the application by encouraging devs to
    /// re-use styles throughout the project.
    ///
    /// This function will create an unique Material for this style based on the provided Shader.
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/FromFont.html>
    /// * `font` - Font asset you want attached to this style.
    /// * `layout_height_meters` - Height of a text glyph in meters. StereoKit currently bases this on CapHeight.
    /// * `shader` - This style will create and use a unique/ Material based on the Shader that you provide here.
    /// * `color_gamma` - The gamma space color of the text style. This will be embedded in the vertex color of the
    ///   text mesh.
    ///
    /// see also [`text_make_style_shader`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::TextStyle, font::Font, util::named_colors, shader::Shader};
    ///
    /// let font = Font::default();
    /// let shader = Shader::from_file("shaders/brick_pbr.hlsl.sks")
    ///                          .expect("Brick_pbr should be a valid shader");
    ///
    /// let text_style = TextStyle::from_font_and_shader(&font, 0.02, shader, named_colors::WHITE);
    ///
    /// assert_eq!(text_style.get_material().get_id(), "sk/text_style/2/material");
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    /// ```
    pub fn from_font_and_shader(
        font: impl AsRef<Font>,
        layout_height_meters: f32,
        shader: impl AsRef<Shader>,
        color_gamma: impl Into<Color128>,
    ) -> Self {
        unsafe {
            text_make_style_shader(
                font.as_ref().0.as_ptr(),
                layout_height_meters,
                shader.as_ref().0.as_ptr(),
                color_gamma.into(),
            )
        }
    }

    /// Create a text style for use with other text functions! A text style is a font plus size/color/material
    /// parameters, and are used to keep text looking more consistent through the application by encouraging devs to
    /// re-use styles throughout the project.
    ///
    /// This overload allows you to set the specific Material that is used. This can be helpful if you’re keeping styles
    /// similar enough to re-use the material and save on draw calls. If you don’t know what that means, then prefer
    /// using the overload that takes a Shader, or takes neither a Shader nor a Material!
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/FromFont.html>
    /// * `font` - Font asset you want attached to this style.
    /// * `layout_height_meters` - Height of a text glyph in meters. StereoKit currently bases this on CapHeight.
    /// * `material` - Which material should be used to render the text with? Note that this does NOT duplicate the
    ///   material, so the text with? Note that this does NOT duplicate the material, so some parameters of this
    ///   Material instance will get overwritten, like the texture used for the glyph atlas. You should either use a new
    ///   Material, or a Material that was already used with this same font.
    /// * `color_gamma` - The gamma space color of the text style. This will be embedded in the vertex color of the
    ///   text mesh.
    ///
    /// see also [`text_make_style_mat`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::TextStyle, font::Font, util::named_colors, material::Material};
    ///
    /// let font = Font::default();
    /// let material = Material::pbr().copy();
    ///
    /// let text_style = TextStyle::from_font_and_material(&font, 0.02, &material, named_colors::WHITE);
    ///
    /// assert_eq!(text_style.get_material(), material);
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    /// ```
    pub fn from_font_and_material(
        font: impl AsRef<Font>,
        layout_height_meters: f32,
        material: impl AsRef<Material>,
        color_gamma: impl Into<Color128>,
    ) -> Self {
        unsafe {
            text_make_style_mat(
                font.as_ref().0.as_ptr(),
                layout_height_meters,
                material.as_ref().0.as_ptr(),
                color_gamma.into(),
            )
        }
    }

    /// Height of a text glyph in meters. StereoKit currently bases this on the letter ‘T’.
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/CharHeight.html>
    ///
    /// see also [`text_style_set_layout_height`]
    #[deprecated(since = "0.40.0", note = "please use TextStyle::layout_height")]
    pub fn char_height(&mut self, char_height: f32) {
        unsafe { text_style_set_layout_height(*self, char_height) }
    }

    /// (meters) Layout height is the height of the font's CapHeight, which is used for calculating the vertical height
    /// of the text when doing text layouts. This does _not_ include the height of the descender , nor
    /// does it represent the maximum possible height a glyph may extend upwards (use Text::size_render).
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/LayoutHeight.html>
    ///
    /// see also [`text_style_set_layout_height`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{font::Font, util::named_colors, system::TextStyle};
    ///
    /// let font = Font::default();
    /// let mut text_style = TextStyle::from_font(font, 0.02, named_colors::WHITE);
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    ///
    /// text_style.layout_height(0.03);
    ///
    /// assert!((text_style.get_layout_height() - 0.03) < 0.0001);
    /// ```
    pub fn layout_height(&mut self, height_meters: f32) {
        unsafe { text_style_set_layout_height(*self, height_meters) }
    }

    /// (meters) Height from the layout descender to the layout ascender. This is most equivalent to the 'font-size' in
    /// CSS or other text layout tools. Since ascender and descenders can vary a lot, using layout_height in many cases
    /// can lead to more consistency in the long run.
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/TotalHeight.html>
    ///
    /// see also [`text_style_set_total_height`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{font::Font, util::named_colors, system::TextStyle};
    ///
    /// let font = Font::default();
    /// let mut text_style = TextStyle::from_font(font, 0.02, named_colors::WHITE);
    ///
    /// text_style.total_height(0.03);
    ///
    /// assert_eq!(text_style.get_total_height(), 0.03);
    /// ```
    pub fn total_height(&mut self, height_meters: f32) {
        unsafe { text_style_set_total_height(*self, height_meters) }
    }

    /// This is the space a full line of text takes, from baseline to baseline, as a 0-1 percentage of the font's
    /// character height. This is similar to CSS line-height, a value of 1.0 means the line takes _only_
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/LineHeightPct.html>
    ///
    /// see also [`text_style_set_line_height_pct`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{font::Font, util::named_colors, system::TextStyle};
    ///
    /// let font = Font::default();
    /// let mut text_style = TextStyle::from_font(font, 0.02, named_colors::WHITE);
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    ///
    /// text_style.line_height_pct(30.0);
    ///
    /// assert_eq!(text_style.get_line_height_pct(), 30.0);
    /// ```
    pub fn line_height_pct(&mut self, height_percent: f32) {
        unsafe { text_style_set_line_height_pct(*self, height_percent) }
    }

    /// This provides a reference to the Material used by this style, so you can override certain features! Note that if
    /// you’re creating TextStyles with manually provided Materials, this Material may not be unique to this style.
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/Material.html>
    ///
    /// see also [`text_style_get_material`]
    /// see example in [`TextStyle::from_font_and material`]
    pub fn get_material(&self) -> Material {
        Material(NonNull::new(unsafe { text_style_get_material(*self) }).unwrap())
    }

    /// Returns the maximum height of a text character using this style, in meters.
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/CharHeight.html>
    ///
    /// see also [`text_style_get_layout_height`]
    #[deprecated(since = "0.40.0", note = "please use get_layout_height")]
    pub fn get_char_height(&self) -> f32 {
        unsafe { text_style_get_layout_height(*self) }
    }

    /// (meters) Layout height is the height of the font's ascender, which is used for calculating the vertical height
    /// of the text when doing text layouts. This does _not_ include the height of the descender (use total_height), nor
    /// does it represent the maximum possible height a glyph may extend upwards (use Text::size_render).
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/LayoutHeight.html>
    ///
    /// see also [`text_style_get_layout_height`]
    /// see example in [`TextStyle::layout_height`]
    pub fn get_layout_height(&self) -> f32 {
        unsafe { text_style_get_layout_height(*self) }
    }

    /// (meters) Height from the layout descender to the layout ascender. This is most equivalent to the 'font-size' in
    /// CSS or other text layout tools. Since ascender and descenders can vary a lot, using layout_height in many cases
    /// can lead to more consistency in the long run.
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/TotalHeight.html>
    ///
    /// see also [`text_style_get_total_height`]
    /// see example in [`TextStyle::total_height`]
    pub fn get_total_height(&self) -> f32 {
        unsafe { text_style_get_total_height(*self) }
    }

    /// This is the space a full line of text takes, from baseline to baseline, as a 0-1 percentage of the font's
    /// character height. This is similar to CSS line-height, a value of 1.0 means the line takes _only_
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/LineHeightPct.html>
    ///
    /// see also [`text_style_get_line_height_pct`]
    /// see example in [`TextStyle::line_height_pct`]
    pub fn get_line_height_pct(&self) -> f32 {
        unsafe { text_style_get_line_height_pct(*self) }
    }
    /// (meters) The height of a standard captial letter, such as 'H' or 'T'
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/CapHeight.html>
    ///
    /// see also [`text_style_get_cap_height`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{font::Font, util::named_colors, system::TextStyle};
    ///
    /// let font = Font::default();
    /// let mut text_style = TextStyle::from_font(font, 0.02, named_colors::WHITE);
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    ///
    /// assert_eq!(text_style.get_cap_height(), 0.02);
    /// ```
    pub fn get_cap_height(&self) -> f32 {
        unsafe { text_style_get_cap_height(*self) }
    }

    /// (meters) The layout ascender of the font, this is the height of the "tallest" glyphs as far as layout is
    /// concerned. Characters such as 'l' typically rise above the CapHeight, and this value usually matches this height.
    /// Some glyphs such as those with hats or umlauts will almost always be taller than this height
    /// (see Text::size_render), but this is not used when laying out characters.
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/Ascender.html>
    ///
    /// see also [`text_style_get_ascender`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{font::Font, util::named_colors, system::TextStyle};
    ///
    /// let font = Font::default();
    /// let mut text_style = TextStyle::from_font(font, 0.02, named_colors::WHITE);
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    ///
    /// //TODO: linux   assert_eq!(text_style.get_ascender(), 0.03);
    /// //TODO: windows assert_eq!(text_style.get_ascender(),  0.021176472);
    /// ```
    pub fn get_ascender(&self) -> f32 {
        unsafe { text_style_get_ascender(*self) }
    }

    /// (meters) The layout descender of the font, this is the positive height below the baseline
    /// <https://stereokit.net/Pages/StereoKit/TextStyle/Descender.html>
    ///
    /// see also [`text_style_get_descender`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{font::Font, util::named_colors, system::TextStyle};
    ///
    /// let font = Font::default();
    /// let mut text_style = TextStyle::from_font(font, 0.02, named_colors::WHITE);
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    ///
    /// assert_ne!(text_style.get_descender(), 0.0);
    /// ```
    pub fn get_descender(&self) -> f32 {
        unsafe { text_style_get_descender(*self) }
    }
}

bitflags::bitflags! {
    /// A bit-flag enum for describing alignment or positioning. Items can be combined using the '|' operator, like so:
    /// `let alignment = Align::YTop | Align::XLeft;`.
    /// Avoid combining multiple items of the same axis. There are also a complete list of valid bit flag combinations!
    /// These are the values without an axis listed in their names, 'TopLeft', 'BottomCenter',
    /// etc.
    /// <https://stereokit.net/Pages/StereoKit/Align.html>
    ///
    /// see also [`Text`] [`crate::ui::Ui`]
    #[derive(Debug, Copy, Clone, PartialEq, Eq)]
    #[repr(C)]
    pub struct Align: u32 {
        /// On the x axis, this item should start on the left.
        const XLeft = 1 << 0;
        /// On the y axis, this item should start at the top.
        const YTop = 1 << 1;
        /// On the x axis, the item should be centered.
        const XCenter = 1 << 2;
        /// On the y axis, the item should be centered.
        const YCenter = 1 << 3;
        /// On the x axis, this item should start on the right.
        const XRight = 1 << 4;
        /// On the y axis, this item should start on the bottom.
        const YBottom = 1 << 5;
        /// Center on both X and Y axes. This is a combination of XCenter and YCenter.
        const Center = Self::XCenter.bits() | Self::YCenter.bits();
        /// Start on the left of the X axis, center on the Y axis. This is a combination of XLeft and YCenter.
        const CenterLeft = Self::XLeft.bits() | Self::YCenter.bits();
        /// Start on the right of the X axis, center on the Y axis. This is a combination of XRight and YCenter.
        const CenterRight = Self::XRight.bits() | Self::YCenter.bits();
        /// Center on the X axis, and top on the Y axis. This is a combination of XCenter and YTop.
        const TopCenter = Self::XCenter.bits() | Self::YTop.bits();
        /// Start on the left of the X axis, and top on the Y axis. This is a combination of XLeft and YTop.
        const TopLeft = Self::XLeft.bits() | Self::YTop.bits();
        /// Start on the right of the X axis, and top on the Y axis. This is a combination of XRight and YTop.
        const TopRight = Self::XRight.bits() | Self::YTop.bits();
        /// Center on the X axis, and bottom on the Y axis. This is a combination of XCenter and YBottom.
        const BottomCenter = Self::XCenter.bits() | Self::YBottom.bits();
        /// Start on the left of the X axis, and bottom on the Y axis. This is a combination of XLeft and YBottom.
        const BottomLeft = Self::XLeft.bits() | Self::YBottom.bits();
        /// Start on the right of the X axis, and bottom on the Y axis.This is a combination of XRight and YBottom.
        const BottomRight = Self::XRight.bits() | Self::YBottom.bits();
    }
}

bitflags::bitflags! {
    /// A bit-flag enum for describing alignment or positioning. Items can be combined using the '|' operator, like so:
    /// `let alignment = Pivot::YTop | Pivot::XLeft;`.
    /// Avoid combining multiple items of the same axis. There are also a complete list of valid bit flag combinations!
    /// These are the values without an axis listed in their names, 'TopLeft', 'BottomCenter',
    /// etc.
    /// <https://stereokit.net/Pages/StereoKit/Pivot.html>
    ///
    /// see also [`Text`] [`Sprite`]
    #[derive(Debug, Copy, Clone, PartialEq, Eq)]
    #[repr(C)]
    pub struct Pivot: u32 {
        /// On the x axis, this item should start on the left.
        const XLeft = 1 << 0;
        /// On the y axis, this item should start at the top.
        const YTop = 1 << 1;
        /// On the x axis, the item should be centered.
        const XCenter = 1 << 2;
        /// On the y axis, the item should be centered.
        const YCenter = 1 << 3;
        /// On the x axis, this item should start on the right.
        const XRight = 1 << 4;
        /// On the y axis, this item should start on the bottom.
        const YBottom = 1 << 5;
        /// Center on both X and Y axes. This is a combination of XCenter and YCenter.
        const Center = Self::XCenter.bits() | Self::YCenter.bits();
        /// Start on the left of the X axis, center on the Y axis. This is a combination of XLeft and YCenter.
        const CenterLeft = Self::XLeft.bits() | Self::YCenter.bits();
        /// Start on the right of the X axis, center on the Y axis. This is a combination of XRight and YCenter.
        const CenterRight = Self::XRight.bits() | Self::YCenter.bits();
        /// Center on the X axis, and top on the Y axis. This is a combination of XCenter and YTop.
        const TopCenter = Self::XCenter.bits() | Self::YTop.bits();
        /// Start on the left of the X axis, and top on the Y axis. This is a combination of XLeft and YTop.
        const TopLeft = Self::XLeft.bits() | Self::YTop.bits();
        /// Start on the right of the X axis, and top on the Y axis. This is a combination of XRight and YTop.
        const TopRight = Self::XRight.bits() | Self::YTop.bits();
        /// Center on the X axis, and bottom on the Y axis. This is a combination of XCenter and YBottom.
        const BottomCenter = Self::XCenter.bits() | Self::YBottom.bits();
        /// Start on the left of the X axis, and bottom on the Y axis. This is a combination of XLeft and YBottom.
        const BottomLeft = Self::XLeft.bits() | Self::YBottom.bits();
        /// Start on the right of the X axis, and bottom on the Y axis.This is a combination of XRight and YBottom.
        const BottomRight = Self::XRight.bits() | Self::YBottom.bits();
    }
}

bitflags::bitflags! {
    /// This enum describes how text layout behaves within the space it is given.
    /// <https://stereokit.net/Pages/StereoKit/TextFit.html>
    ///
    /// see also [`Text`] [`crate::ui::Ui`]
    #[derive(Debug, Copy, Clone, PartialEq, Eq)]
    #[repr(C)]
    pub struct TextFit: u32 {
        /// No particularly special behavior.
        const None = 0;
        /// The text will wrap around to the next line down when it reaches the end of the space on the X axis.
        const Wrap = 1;
        /// When the text reaches the end, it is simply truncated and no longer visible.
        const Clip = 2;
        /// If the text is too large to fit in the space provided, it will be scaled down to fit inside. This will not scale up.
        const Squeeze = 4;
        /// If the text is larger, or smaller than the space provided, it will scale down or up to fill the space.
        const Exact = 8;
        /// The text will ignore the containing space, and just keep on going.
        const Overflow = 16;
    }
}

/// Soft keyboard layouts are often specific to the type of text that they’re editing! This enum is a collection of
/// common text contexts that SK can pass along to the OS’s soft keyboard for a more optimal layout.
/// <https://stereokit.net/Pages/StereoKit/TextContext.html>
///
/// see also [`crate::ui::Ui::input`] [`crate::ui::Ui::input_at`] [`crate::util::Platform::keyboard_show`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum TextContext {
    /// General text editing, this is the most common type of text, and would result in a ‘standard’ keyboard layout.
    Text = 0,
    /// Numbers and numerical values.
    Number = 1,
    /// This text specifically represents some kind of URL/URI address.
    Uri = 2,
    /// This is a password, and should not be visible when typed!
    Password = 3,
}

/// A collection of functions for rendering and working with text. These are a lower level access to text rendering than
/// the UI text functions, and are completely unaware of the UI code.
/// <https://stereokit.net/Pages/StereoKit/Text.html>
///
/// ### Examples
/// ```
/// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
/// use stereokit_rust::{system::{ Pivot, Align, TextFit, Text, Lines, Hierarchy },
///                      font::Font, material::Material, mesh::Mesh, maths::{Vec3, Matrix},
///                      util::named_colors::{WHITE, GOLD, GREEN, RED}};
///
/// let font = Font::default();
/// let style = Text::make_style(font, 0.28, WHITE);
/// let transform1 = Matrix::t([0.7, 0.7, 0.0]) * Matrix::Y_180;
/// let transform2 = Matrix::t([0.3, 0.1, 0.0]) * Matrix::Y_180;
/// let transform3 = Matrix::t([-0.1,-0.5, 0.0]) * Matrix::Y_180;
///
/// filename_scr = "screenshots/text.jpeg"; fov_scr=110.0;
/// test_screenshot!( // !!!! Get a proper main loop !!!!
///    Text::add_at(token, "Many", transform1, Some(style), Some(GOLD.into()),
///             Some(Pivot::TopCenter), Some(Align::TopLeft), None, None, None);
///    
///    let size = Text::add_in(token, "Texts!", transform2, [0.6, 0.6], TextFit::Squeeze,
///             Some(style), Some(GREEN.into()), Some(Pivot::Center), Some(Align::TopLeft),
///             None, Some(-0.3), Some(-0.3));
///    assert_ne!(size , 0.0);
///
///    Text::add_at(token, "----/****", transform3, Some(style), None,
///             None, None, None, None, None);
/// );
/// ```
/// <img src="https://raw.githubusercontent.com/mvvvv/StereoKit-rust/refs/heads/master/screenshots/text.jpeg" alt="screenshot" width="200">
pub struct Text;

unsafe extern "C" {
    pub fn text_add_at(
        text_utf8: *const c_char,
        transform: *const Matrix,
        style: TextStyle,
        position: Pivot,
        align: Align,
        off_x: f32,
        off_y: f32,
        off_z: f32,
        vertex_tint_linear: Color128,
    );
    pub fn text_add_at_16(
        text_utf16: *const c_ushort,
        transform: *const Matrix,
        style: TextStyle,
        position: Pivot,
        align: Align,
        off_x: f32,
        off_y: f32,
        off_z: f32,
        vertex_tint_linear: Color128,
    );
    pub fn text_add_in(
        text_utf8: *const c_char,
        transform: *const Matrix,
        size: Vec2,
        fit: TextFit,
        style: TextStyle,
        position: Pivot,
        align: Align,
        off_x: f32,
        off_y: f32,
        off_z: f32,
        vertex_tint_linear: Color128,
    ) -> f32;
    pub fn text_add_in_16(
        text_utf16: *const c_ushort,
        transform: *const Matrix,
        size: Vec2,
        fit: TextFit,
        style: TextStyle,
        position: Pivot,
        align: Align,
        off_x: f32,
        off_y: f32,
        off_z: f32,
        vertex_tint_linear: Color128,
    ) -> f32;
    pub fn text_size_layout(text_utf8: *const c_char, style: TextStyle) -> Vec2;
    pub fn text_size_layout_constrained(text_utf8: *const c_char, style: TextStyle, max_width: f32) -> Vec2;
    pub fn text_size_layout_16(text_utf16: *const c_ushort, style: TextStyle) -> Vec2;
    pub fn text_size_layout_constrained_16(text_utf16: *const c_ushort, style: TextStyle, max_width: f32) -> Vec2;
    pub fn text_size_render(layout_size: Vec2, style: TextStyle, y_offset: *mut f32) -> Vec2;
    pub fn text_char_at(
        text_utf8: *const c_char,
        style: TextStyle,
        char_index: i32,
        opt_size: *mut Vec2,
        fit: TextFit,
        position: Pivot,
        align: Align,
    ) -> Vec2;
    pub fn text_char_at_16(
        text_utf16: *const c_ushort,
        style: TextStyle,
        char_index: i32,
        opt_size: *mut Vec2,
        fit: TextFit,
        position: Pivot,
        align: Align,
    ) -> Vec2;
}

impl Text {
    /// Create a text style for use with other text functions! A text style is a font plus size/color/material
    /// parameters, and are used to keep text looking more consistent through the application by encouraging devs to
    /// re-use styles throughout the project.
    ///
    /// This fn will create an unique Material for this style based on Default.ShaderFont.
    /// <https://stereokit.net/Pages/StereoKit/Text/MakeStyle.html>
    /// * `font` - Font asset you want attached to this style.
    /// * `layout_height_meters`- Height of a text glyph in meters. StereoKit currently bases this on CapHeight.
    /// * `color_gamma` - The gamma space color of the text style. This will be embedded in the vertex color of the
    ///   text mesh.
    ///
    /// Returns a text style id for use with text rendering functions.
    ///
    /// see also [`text_make_style`] same as [`TextStyle::from_font`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Text, font::Font, util::named_colors};
    ///
    /// let font = Font::default();
    ///
    /// let text_style = Text::make_style(&font, 0.02, named_colors::WHITE);
    ///
    /// assert_eq!(text_style.get_material().get_id(), "sk/text_style/2/material");
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    /// ```
    pub fn make_style(
        font: impl AsRef<Font>,
        layout_height_meters: f32,
        color_gamma: impl Into<Color128>,
    ) -> TextStyle {
        unsafe { text_make_style(font.as_ref().0.as_ptr(), layout_height_meters, color_gamma.into()) }
    }

    /// Create a text style for use with other text functions! A text style is a font plus size/color/material
    /// parameters, and are used to keep text looking more consistent through the application by encouraging devs to
    /// re-use styles throughout the project.
    ///
    /// This function will create an unique Material for this style based on the provided Shader.
    /// <https://stereokit.net/Pages/StereoKit/Text/MakeStyle.html>
    /// * `font` - Font asset you want attached to this style.
    /// * `layout_height_meters`- Height of a text glyph in meters. StereoKit currently bases this on CapHeight.
    /// * `shader` - This style will create and use a unique Material based on the Shader that you provide here
    /// * `color_gamma` - The gamma space color of the text style. This will be embedded in the vertex color of the
    ///   text mesh.
    ///
    /// Returns a text style id for use with text rendering functions.
    ///
    /// see also [`text_make_style_shader`] same as [`TextStyle::from_font_and_shader`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Assets, Text}, font::Font,
    ///                      util::named_colors, shader::Shader};
    ///
    /// let font = Font::default();
    /// let shader = Shader::from_file("shaders/water_pbr.hlsl.sks")
    ///                          .expect("Brick_pbr should be a valid shader");
    /// Assets::block_for_priority(i32::MAX);
    ///
    /// let text_style = Text::make_style_with_shader(&font, 0.02, shader, named_colors::WHITE);
    ///
    /// assert_eq!(text_style.get_material().get_id(), "sk/text_style/2/material");
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    /// ```
    pub fn make_style_with_shader(
        font: impl AsRef<Font>,
        layout_height_meters: f32,
        shader: impl AsRef<Shader>,
        color_gamma: impl Into<Color128>,
    ) -> TextStyle {
        unsafe {
            text_make_style_shader(
                font.as_ref().0.as_ptr(),
                layout_height_meters,
                shader.as_ref().0.as_ptr(),
                color_gamma.into(),
            )
        }
    }

    /// Create a text style for use with other text functions! A text style is a font plus size/color/material
    /// parameters, and are used to keep text looking more consistent through the application by encouraging devs to
    /// re-use styles throughout the project.
    ///
    /// This overload allows you to set the specific Material that is used. This can be helpful if you’re keeping styles
    /// similar enough to re-use the material and save on draw calls. If you don’t know what that means, then prefer
    /// using the overload that takes a Shader, or takes neither a Shader nor a Material!
    /// <https://stereokit.net/Pages/StereoKit/Text/MakeStyle.html>
    /// * `font` - Font asset you want attached to this style.
    /// * `layout_height_meters`- Height of a text glyph in meters. StereoKit currently bases this on CapHeight.
    /// * `material` - Which material should be used to render the text with? Note that this does NOT duplicate the
    ///   material, so some parameters of this Material instance will get overwritten, like the texture used for the
    ///   glyph atlas. You should either use a new Material, or a Material that was already used with this same font.
    /// * `color_gamma` - The gamma space color of the text style. This will be embedded in the vertex color of the
    ///   text mesh.
    ///
    /// Returns a text style id for use with text rendering functions.
    ///
    /// see also [`text_make_style_mat`]
    /// same as [`TextStyle::from_font_and_material`] same as [TextStyle::from_font_and_material]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::Text, font::Font, util::named_colors, material::Material};
    ///
    /// let font = Font::default();
    /// let material = Material::pbr().copy();
    ///
    /// let text_style = Text::make_style_with_material(&font, 0.02, &material, named_colors::WHITE);
    ///
    /// assert_eq!(text_style.get_material(), material);
    /// assert_eq!(text_style.get_layout_height(), 0.02);
    /// ```
    pub fn make_style_with_material(
        font: impl AsRef<Font>,
        layout_height_meters: f32,
        material: impl AsRef<Material>,
        color_gamma: impl Into<Color128>,
    ) -> TextStyle {
        unsafe {
            text_make_style_mat(
                font.as_ref().0.as_ptr(),
                layout_height_meters,
                material.as_ref().0.as_ptr(),
                color_gamma.into(),
            )
        }
    }

    /// Renders text at the given location! Must be called every frame you want this text to be visible.
    /// <https://stereokit.net/Pages/StereoKit/Text/Add.html>
    /// * `text` - What text should be drawn?
    /// * `transform` - A Matrix representing the transform of the text mesh! Try Matrix::t_r_s().
    /// * `text_style` - Style information for rendering, see Text.MakeStyle or the TextStyle object. If None will use
    ///   the TextStyle::default()
    /// * `vertex_tint_linear` - The vertex color of the text gets multiplied by this color. This is a linear color
    ///   value, not a gamma corrected color value. If None will use Color128::WHITE
    /// * `position` - How should the text’s bounding rectangle be positioned relative to the transform? If None will
    ///   use Pivot::Center.
    /// * `align` - How should the text be aligned within the text’s bounding rectangle? If None will use
    ///   Align::Center.
    /// * `off_?` - An additional offset on the given axis. If None will use 0.0.
    ///
    /// see also [`text_add_at`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Pivot, Align, TextFit, Text},
    ///                      font::Font, maths::{Vec3, Matrix},
    ///                      util::named_colors::{WHITE, GOLD, GREEN}};
    ///
    /// let font = Font::default();
    /// let style = Text::make_style(font, 0.28, WHITE);
    /// let transform1 = Matrix::t([0.7, 0.7, 0.0])  * Matrix::Y_180;
    /// let transform2 = Matrix::t([0.3, 0.1, 0.0])  * Matrix::Y_180;
    /// let transform3 = Matrix::t([-0.1,-0.5, 0.0]) * Matrix::Y_180;
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///    Text::add_at(token, "Many", transform1, Some(style), Some(GOLD.into()),
    ///             Some(Pivot::TopCenter), Some(Align::TopLeft), None, None, None);
    ///    
    ///    Text::add_at(token, "Texts!", transform2, Some(style), Some(GREEN.into()),
    ///             Some(Pivot::Center), Some(Align::TopLeft), None, None, Some(-0.3));
    ///
    ///    Text::add_at(token, "----/****", transform3, Some(style), None,
    ///             None, None, None, None, None);
    /// );
    /// ```
    #[allow(clippy::too_many_arguments)]
    pub fn add_at(
        _token: &MainThreadToken,
        text: impl AsRef<str>,
        transform: impl Into<Matrix>,
        text_style: Option<TextStyle>,
        vertex_tint_linear: Option<Color128>,
        position: Option<Pivot>,
        align: Option<Align>,
        off_x: Option<f32>,
        off_y: Option<f32>,
        off_z: Option<f32>,
    ) {
        let c_str = CString::new(text.as_ref()).unwrap();
        let style = text_style.unwrap_or_default();
        let vertex_tint_linear = vertex_tint_linear.unwrap_or(Color128::WHITE);
        let position = position.unwrap_or(Pivot::Center);
        let align = align.unwrap_or(Align::Center);
        let off_x = off_x.unwrap_or(0.0);
        let off_y = off_y.unwrap_or(0.0);
        let off_z = off_z.unwrap_or(0.0);
        unsafe {
            text_add_at(
                c_str.as_ptr(),
                &transform.into(),
                style,
                position,
                align,
                off_x,
                off_y,
                off_z,
                vertex_tint_linear,
            )
        }
    }

    /// Renders text at the given location! Must be called every frame you want this text to be visible.
    /// <https://stereokit.net/Pages/StereoKit/Text/Add.html>
    /// * `text` - What text should be drawn?
    /// * `transform` - A Matrix representing the transform of the text mesh! Try Matrix::t_r_s().
    /// * `size` - This is the Hierarchy space rectangle that the text should try to fit inside of. This allows for text
    ///   wrapping or scaling based on the value provided to the ‘fit’ parameter.
    /// * `text_fit` - Describe how the text should behave when one of its size dimensions conflicts with the provided
    ///   ‘size’ parameter.
    /// * `text_style` - Style information for rendering, see Text.MakeStyle or the TextStyle object. If None will use
    ///   the TextStyle::default()
    /// * `vertex_tint_linear` - The vertex color of the text gets multiplied by this color. This is a linear color
    ///   value, not a gamma corrected color value. If None will use Color128::WHITE
    /// * `position` - How should the text’s bounding rectangle be positioned relative to the transform? If None will
    ///   use Pivot::Center.
    /// * `align` - How should the text be aligned within the text’s bounding rectangle? If None will use
    ///   Align::Center.
    /// * `off_?` - An additional offset on the given axis. If None will use 0.0.
    ///
    /// Returns the vertical space used by this text.
    ///
    /// see also [`text_add_in`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{ Align, Pivot, TextFit, Text},
    ///                      font::Font, maths::{Vec3, Matrix},
    ///                      util::named_colors::{WHITE, GOLD, GREEN}};
    ///
    /// let font = Font::default();
    /// let style = Text::make_style(font, 0.28, WHITE);
    /// let transform1 = Matrix::Y_180;
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///    let size = Text::add_in(token, "Many", transform1, [1.1, 1.0], TextFit::Wrap,
    ///             Some(style), Some(GOLD.into()), Some(Pivot::BottomRight),
    ///             Some(Align::TopLeft), None, None, None);
    ///    
    ///    let size = Text::add_in(token, "Texts!", transform1, [1.0, 1.0-size], TextFit::Clip,
    ///             Some(style),None, None,
    ///             None, None, None, None);
    ///
    ///    Text::add_in(token, "----/****", transform1, [0.3, 1.0-size], TextFit::Squeeze,
    ///             Some(style), Some(GREEN.into()), Some(Pivot::YTop),
    ///             Some(Align::Center),None, None, Some(-0.7));
    /// );
    /// ```
    #[allow(clippy::too_many_arguments)]
    pub fn add_in(
        _token: &MainThreadToken,
        text: impl AsRef<str>,
        transform: impl Into<Matrix>,
        size: impl Into<Vec2>,
        fit: TextFit,
        text_style: Option<TextStyle>,
        vertex_tint_linear: Option<Color128>,
        position: Option<Pivot>,
        align: Option<Align>,
        off_x: Option<f32>,
        off_y: Option<f32>,
        off_z: Option<f32>,
    ) -> f32 {
        let c_str = CString::new(text.as_ref()).unwrap();
        let style = text_style.unwrap_or_default();
        let vertex_tint_linear = vertex_tint_linear.unwrap_or(Color128::WHITE);
        let position = position.unwrap_or(Pivot::Center);
        let align = align.unwrap_or(Align::Center);
        let off_x = off_x.unwrap_or(0.0);
        let off_y = off_y.unwrap_or(0.0);
        let off_z = off_z.unwrap_or(0.0);
        unsafe {
            text_add_in(
                c_str.as_ptr(),
                &transform.into(),
                size.into(),
                fit,
                style,
                position,
                align,
                off_x,
                off_y,
                off_z,
                vertex_tint_linear,
            )
        }
    }

    /// Sometimes you just need to know how much room some text takes up! This finds the size of the text in meters when
    /// using the indicated style!
    /// <https://stereokit.net/Pages/StereoKit/Text/Size.html>
    /// * text_style - if None will use the TextStyle::default()
    /// * max_width - Width of the available space in meters.
    ///
    /// Returns size of the text in meters
    ///
    /// see also [`text_size_layout`] [`text_size_layout_constrained`]
    #[deprecated(since = "0.40.0", note = "please Text::use size_layout")]
    pub fn size(text: impl AsRef<str>, text_style: Option<TextStyle>, max_width: Option<f32>) -> Vec2 {
        let c_str = CString::new(text.as_ref()).unwrap();
        let style = text_style.unwrap_or_default();
        if let Some(max_width) = max_width {
            unsafe { text_size_layout_constrained(c_str.as_ptr(), style, max_width) }
        } else {
            unsafe { text_size_layout(c_str.as_ptr(), style) }
        }
    }

    /// Sometimes you just need to know how much room some text takes up! This finds the layout size of the text in
    /// meters when using the indicated style!  This does not include ascender and descender size, so rendering using
    /// this as a clipping size will result in ascenders and descenders getting clipped.
    /// <https://stereokit.net/Pages/StereoKit/Text/SizeLayout.html>
    /// * `text` - Text you want to find the size of.
    /// * `text_style` - if None will use the TextStyle::default()
    /// * `max_width` - Width of the available space in meters if you need to know how much layout space text will take
    ///   when constrained to a certain width? This will find it using the indicated text style!
    ///
    /// Returns size of the text in meters
    ///
    /// see also [`text_size_layout`] [`text_size_layout_constrained`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Text, TextStyle}, font::Font,
    ///                      util::named_colors::{WHITE, GOLD, GREEN},
    ///                      mesh::Mesh, material::{Material, Cull}, maths::Matrix};
    ///
    /// let font = Font::default();
    /// let style = Text::make_style(font, 0.70, WHITE);
    /// let transform1 = Matrix::Y_180;
    /// let text = "Yo!";
    ///
    /// let size = Text::size_layout(text, Some(style), None);
    /// let cube = Mesh::generate_cube([size.x, size.y, size.y], None);
    /// let mut material = Material::pbr().copy();
    /// material.face_cull(Cull::Front);
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///    Text::add_at(token, text, transform1, Some(style), Some(GOLD.into()),
    ///             None, None, None, None, None);
    ///    
    ///    cube.draw(token, &material, transform1, Some(GREEN.into()), None);
    /// );
    /// ```
    pub fn size_layout(text: impl AsRef<str>, text_style: Option<TextStyle>, max_width: Option<f32>) -> Vec2 {
        let c_str = CString::new(text.as_ref()).unwrap();
        let style = text_style.unwrap_or_default();
        if let Some(max_width) = max_width {
            unsafe { text_size_layout_constrained(c_str.as_ptr(), style, max_width) }
        } else {
            unsafe { text_size_layout(c_str.as_ptr(), style) }
        }
    }

    /// This modifies a text layout size to include the tallest and lowest possible values for the glyphs in this font.
    /// This is for when you need to be careful about avoiding clipping that would happen if you only used the layout size.
    /// <https://stereokit.net/Pages/StereoKit/Text/SizeRender.html>
    /// * `size_layout` - A size previously calculated using `Text.SizeLayout`.
    /// * `text_style` -The same style as used for calculating the sizeLayout. If None will use the TextStyle::default()
    /// * `y_offset` - Since the render size will ascend from the initial position, this will be the offset from the
    ///   initial position upwards. You should add it to your Y position.
    ///
    /// Returns the sizeLayout modified to account for the size of the most extreme glyphs.
    ///
    /// see also [`text_size_layout`] [`text_size_layout_constrained`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Text, TextStyle}, font::Font,
    ///                      util::named_colors::{WHITE, GOLD, GREEN},
    ///                      mesh::Mesh, material::{Material, Cull}, maths::Matrix};
    ///
    /// let font = Font::default();
    /// let style = Text::make_style(font, 0.45, WHITE);
    /// let transform_text = Matrix::Y_180;
    /// let text = "Yo!";
    ///
    /// let size = Text::size_layout(text, Some(style), None);
    /// let mut render_yoff = 0.0;
    /// let render_size = Text::size_render(size, Some(style), &mut render_yoff);
    /// let cube = Mesh::generate_cube([render_size.x, render_size.y, render_size.y], None);
    /// let transform_cube = Matrix::t([0.0, render_yoff/2.0, 0.0]);
    /// let mut material = Material::pbr().copy();
    /// material.face_cull(Cull::Front);
    ///
    /// test_steps!( // !!!! Get a proper main loop !!!!
    ///    Text::add_at(token, text, transform_text, Some(style), Some(GOLD.into()),
    ///             None, None, None, None, None);
    ///    
    ///    cube.draw(token, &material, transform_cube, Some(GREEN.into()), None);
    /// );
    /// ```
    pub fn size_render(size_layout: impl Into<Vec2>, text_style: Option<TextStyle>, y_offset: &mut f32) -> Vec2 {
        let style = text_style.unwrap_or_default();
        unsafe { text_size_render(size_layout.into(), style, y_offset) }
    }
}

/// A settings flag that lets you describe the behavior of how StereoKit will refresh data about the world mesh, if
/// applicable. This is used with World.RefreshType.
/// <https://stereokit.net/Pages/StereoKit/WorldRefresh.html>
///
/// see also [`World`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum WorldRefresh {
    /// Refreshing occurs when the user leaves the area that was most recently scanned. This area is a sphere that is
    /// 0.5 of the World::refresh_radius.
    Area = 0,
    /// Refreshing happens at timer intervals. If an update doesn’t happen in time, the next update will happen as soon
    /// as possible. The timer interval is configurable via World::refresh_nterval.
    Timer = 1,
}

/// For use with World::from_spatial_node, this indicates the type of
/// node that's being bridged with OpenXR.
/// <https://stereokit.net/Pages/StereoKit/SpatialNodeType.html>
///
/// see also [`World`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(u32)]
pub enum SpatialNodeType {
    /// Static spatial nodes track the pose of a fixed location in
    /// the world relative to reference spaces. The tracking of static
    /// nodes may slowly adjust the pose over time for better accuracy but
    /// the pose is relatively stable in the short term, such as between
    /// rendering frames. For example, a QR code tracking library can use a
    /// static node to represent the location of the tracked QR code.
    Static = 0,
    /// Dynamic spatial nodes track the pose of a physical object
    /// that moves continuously relative to reference spaces. The pose of
    /// dynamic spatial nodes can be very different within the duration of
    /// a rendering frame. It is important for the application to use the
    /// correct timestamp to query the space location. For example, a color
    /// camera mounted in front of a HMD is also tracked by the HMD so a
    /// web camera library can use a dynamic node to represent the camera
    /// location.
    Dynamic = 1,
}

/// World contains information about the real world around the user. This includes things like play boundaries, scene
/// understanding, and other various things.
/// <https://stereokit.net/Pages/StereoKit/World.html>
pub struct World;

unsafe extern "C" {
    pub fn world_has_bounds() -> Bool32T;
    pub fn world_get_bounds_size() -> Vec2;
    pub fn world_get_bounds_pose() -> Pose;
    pub fn world_from_spatial_graph(spatial_graph_node_id: *mut u8, dynamic: SpatialNodeType, qpc_time: i64) -> Pose;
    pub fn world_from_perception_anchor(perception_spatial_anchor: *mut c_void) -> Pose;
    pub fn world_try_from_spatial_graph(
        spatial_graph_node_id: *mut u8,
        dynamic: SpatialNodeType,
        qpc_time: i64,
        out_pose: *mut Pose,
    ) -> Bool32T;
    pub fn world_try_from_perception_anchor(perception_spatial_anchor: *mut c_void, out_pose: *mut Pose) -> Bool32T;
    pub fn world_raycast(ray: Ray, out_intersection: *mut Ray) -> Bool32T;
    pub fn world_set_occlusion_enabled(enabled: Bool32T);
    pub fn world_get_occlusion_enabled() -> Bool32T;
    pub fn world_set_raycast_enabled(enabled: Bool32T);
    pub fn world_get_raycast_enabled() -> Bool32T;
    pub fn world_set_occlusion_material(material: MaterialT);
    pub fn world_get_occlusion_material() -> MaterialT;
    pub fn world_set_refresh_type(refresh_type: WorldRefresh);
    pub fn world_get_refresh_type() -> WorldRefresh;
    pub fn world_set_refresh_radius(radius_meters: f32);
    pub fn world_get_refresh_radius() -> f32;
    pub fn world_set_refresh_interval(every_seconds: f32);
    pub fn world_get_refresh_interval() -> f32;
    pub fn world_get_tracked() -> BtnState;
    pub fn world_get_origin_mode() -> OriginMode;
    pub fn world_get_origin_offset() -> Pose;
    pub fn world_set_origin_offset(offset: Pose);
}

impl World {
    /// Off by default. This tells StereoKit to load up and display an occlusion surface that allows the real world to
    /// occlude the application’s digital content! Most systems may allow you to customize the visual appearance of this
    /// occlusion surface via the World::occlusion_material. Check [`crate::sk::SystemInfo::get_world_occlusion_present`] to see if
    /// occlusion can be enabled. This will reset itself to false if occlusion isn’t possible. Loading occlusion data
    /// is asynchronous, so occlusion may not occur immediately after setting this flag.
    /// <https://stereokit.net/Pages/StereoKit/World/OcclusionEnabled.html>
    ///
    /// see also [world_set_occlusion_enabled]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::World};
    ///
    /// let occlusion_is_present = sk.get_system().get_world_occlusion_present();
    ///
    /// // By default, occlusion is disabled.
    /// assert_eq!(World::get_occlusion_enabled(), false);
    ///
    /// World::occlusion_enabled(true);
    /// if occlusion_is_present {
    ///     assert_eq!(World::get_occlusion_enabled(), true);
    /// } else {
    ///     assert_eq!(World::get_occlusion_enabled(), false);
    /// }
    ///
    /// World::occlusion_enabled(false);
    /// assert_eq!(World::get_occlusion_enabled(), false);
    /// ```
    pub fn occlusion_enabled(enabled: bool) {
        unsafe { world_set_occlusion_enabled(enabled as Bool32T) }
    }

    /// By default, this is a black(0,0,0,0) opaque unlit material that will occlude geometry, but won’t show up as
    /// visible anywhere. You can override this with whatever material you would like.
    /// <https://stereokit.net/Pages/StereoKit/World/OcclusionMaterial.html>
    ///
    /// see also [world_set_occlusion_material]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::World, util::named_colors, material::Material};
    ///
    /// let occlusion_is_present = sk.get_system().get_world_occlusion_present();
    ///
    /// assert_eq!(World::get_occlusion_material().get_id(), "sk/world/material");
    ///
    /// let mut material = Material::unlit().copy();
    /// material.color_tint(named_colors::RED);
    ///
    /// World::occlusion_enabled(true);
    /// World::occlusion_material(&material);
    ///
    /// if occlusion_is_present {
    ///     assert_eq!(World::get_occlusion_enabled(), true);
    ///     assert_eq!(World::get_occlusion_material(), material);
    /// } else {
    ///     assert_eq!(World::get_occlusion_enabled(), false);
    ///     assert_eq!(World::get_occlusion_material(), material);
    /// }
    /// ```
    pub fn occlusion_material(material: impl AsRef<Material>) {
        unsafe { world_set_occlusion_material(material.as_ref().0.as_ptr()) }
    }

    /// This is relative to the base reference point and is NOT in world space! The origin StereoKit uses is actually a
    /// base reference point combined with an offset! You can use this to read or set the offset from the OriginMode
    /// reference point.
    /// <https://stereokit.net/Pages/StereoKit/World/OriginOffset.html>
    ///
    /// see also [world_set_origin_offset] [`crate::sk::SkSettings::origin`]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{maths::{Vec3, Pose}, system::World};
    ///
    /// let origin_offset = World::get_origin_offset();
    ///
    /// xr_mode_stop_here!();
    /// // These are the expected results for offscreen tests on a PC:
    /// assert_eq!(origin_offset, Pose::ZERO);
    ///
    /// let offset = Pose::new([0.0, 0.0, 0.01], None);
    /// if false {World::origin_offset(offset);}
    /// ```
    pub fn origin_offset(offset: impl Into<Pose>) {
        unsafe { world_set_origin_offset(offset.into()) }
    }

    /// Off by default. This tells StereoKit to load up collision meshes for the environment, for use with
    /// World::raycast. Check [`crate::sk::SystemInfo::get_world_raycast_present`] to see if raycasting can be enabled. This will reset
    /// itself to false if raycasting isn’t possible. Loading raycasting data is asynchronous, so collision surfaces may
    /// not be available immediately after setting this flag.
    /// <https://stereokit.net/Pages/StereoKit/World/RaycastEnabled.html>
    ///
    /// see also [world_set_raycast_enabled]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::World;
    ///
    /// let raycast_is_present = sk.get_system().get_world_raycast_present();
    ///
    /// assert_eq!(World::get_raycast_enabled(), false);
    ///
    /// World::raycast_enabled(true);
    ///
    /// if raycast_is_present {
    ///     assert_eq!(World::get_raycast_enabled(), true);
    /// } else {
    ///     assert_eq!(World::get_raycast_enabled(), false);
    /// }
    /// World::raycast_enabled(false);
    /// assert_eq!(World::get_raycast_enabled(), false);
    ///
    /// ```
    pub fn raycast_enabled(enabled: bool) {
        unsafe { world_set_raycast_enabled(enabled as Bool32T) }
    }

    /// The refresh interval speed, in seconds. This is only applicable when using WorldRefresh::Timer for the refresh
    /// type. Note that the system may not be able to refresh as fast as you wish, and in that case, StereoKit will
    /// always refresh as soon as the previous refresh finishes.
    /// <https://stereokit.net/Pages/StereoKit/World/RefreshInterval.html>
    ///
    /// see also [world_set_refresh_interval]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::World;
    ///
    /// let occlusion_is_present = sk.get_system().get_world_occlusion_present();
    ///
    /// World::occlusion_enabled(true);
    /// World::refresh_interval(0.01);
    ///
    /// let occlusion_enabled = World::get_occlusion_enabled();
    /// let refresh_interval  = World::get_refresh_interval();
    ///
    /// offscreen_mode_stop_here!();
    /// // These are the expected results for OpenXR tests on a PC:
    /// assert_eq!(refresh_interval, 0.01);
    /// if occlusion_is_present {
    ///     assert_eq!(occlusion_enabled, true);
    /// } else {
    ///     assert_eq!(occlusion_enabled, false);
    /// }
    /// ```
    pub fn refresh_interval(speed: f32) {
        unsafe { world_set_refresh_interval(speed) }
    }

    /// Radius, in meters, of the area that StereoKit should scan for world data. Default is 4. When using the
    /// WorldRefresh::Area refresh type, the world data will refresh when the user has traveled half this radius from
    /// the center of where the most recent refresh occurred.
    /// <https://stereokit.net/Pages/StereoKit/World/RefreshRadius.html>
    ///
    /// see also [world_set_refresh_radius]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::World;
    ///
    /// World::refresh_radius(3.5);
    ///
    /// let refresh_radius  = World::get_refresh_radius();
    ///
    /// offscreen_mode_stop_here!();
    /// // These are the expected results for OpenXR tests on a PC:
    /// assert_eq!(refresh_radius, 3.5);
    /// ```
    pub fn refresh_radius(distance: f32) {
        unsafe { world_set_refresh_radius(distance) }
    }

    /// What information should StereoKit use to determine when the next world data refresh happens? See the
    /// WorldRefresh enum for details.
    /// <https://stereokit.net/Pages/StereoKit/World/RefreshType.html>
    ///
    /// see also [world_set_refresh_type]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{World, WorldRefresh};
    ///
    /// World::refresh_type(WorldRefresh::Timer);
    ///
    /// let refresh_type  = World::get_refresh_type();
    ///
    /// offscreen_mode_stop_here!();
    /// // These are the expected results for OpenXR tests on a PC:
    /// assert_eq!(refresh_type, WorldRefresh::Timer);
    /// ```
    pub fn refresh_type(refresh_type: WorldRefresh) {
        unsafe { world_set_refresh_type(refresh_type) }
    }

    /// Converts a Windows.Perception.Spatial.SpatialAnchor’s pose into SteroKit’s coordinate system. This can be great
    /// for interacting with some of the UWP spatial APIs such as WorldAnchors.
    ///
    /// This method only works on UWP platforms, check Sk.System.perception_bridge_present to see if this is available.
    /// <https://stereokit.net/Pages/StereoKit/World/FromPerceptionAnchor.html>
    ///
    /// see also [world_from_perception_anchor]
    #[allow(clippy::not_unsafe_ptr_arg_deref)]
    pub fn from_perception_anchor(perception_spatial_anchor: *mut c_void) -> Option<Pose> {
        let mut pose = Pose::IDENTITY;
        if unsafe { world_try_from_perception_anchor(perception_spatial_anchor, &mut pose) != 0 } {
            Some(pose)
        } else {
            None
        }
    }
    // TODO : Ask for the non try version

    /// Converts a Windows Mirage spatial node GUID into a Pose based on its current position and rotation! Check
    /// Sk::System::spatial_bridge_present to see if this is available to use. Currently only on HoloLens, good for use
    /// with the Windows QR code package.
    /// <https://stereokit.net/Pages/StereoKit/World/FromSpatialNode.html>
    /// * `spatial_graph_node_id` - A Windows Mirage spatial node GUID acquired from a windows MR API call.
    /// * `spatial_node_type` - Type of spatial node to locate.
    /// * `qpc_time` : A windows performance counter timestamp at which the node should be located, obtained from
    ///   another API or with System.Diagnostics.Stopwatch.GetTimestamp().
    ///
    /// see also [world_try_from_spatial_graph]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{World, SpatialNodeType};
    ///
    /// let spatial_bridge_is_present = sk.get_system().get_spatial_bridge_present();
    ///
    /// World::refresh_radius(3.5);
    ///
    /// if spatial_bridge_is_present {
    ///     World::from_spatial_node("A test", SpatialNodeType::Static, 0);
    /// }
    /// ```
    pub fn from_spatial_node(
        spatial_graph_node_id: impl AsRef<str>,
        spatial_node_type: SpatialNodeType,
        qpc_time: i64,
    ) -> Option<Pose> {
        let c_str = CString::new(spatial_graph_node_id.as_ref()).unwrap();
        let mut pose = Pose::IDENTITY;
        if unsafe {
            world_try_from_spatial_graph(c_str.as_ptr() as *mut u8, spatial_node_type, qpc_time, &mut pose) != 0
        } {
            Some(pose)
        } else {
            None
        }
    }

    /// World::raycast_enabled must be set to true first! Sk::System::world_raycast_present must also be true.
    /// This does a ray intersection with whatever represents the environment at the moment! In this case, it’s a
    /// watertight collection of low resolution meshes calculated by the Scene Understanding extension, which is only
    /// provided by the Microsoft HoloLens runtime.
    /// <https://stereokit.net/Pages/StereoKit/World/Raycast.html>
    /// * `ray` - A world space ray that you’d like to try intersecting with the world mesh.
    ///
    /// Returns The location of the intersection, and direction of the world’s surface at that point if found.
    /// see also [world_raycast]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::{Assets, World}, maths::{Vec3,Ray}};
    /// Assets::block_for_priority(i32::MAX);
    ///
    /// let raycast_is_present = sk.get_system().get_world_raycast_present();
    ///
    /// assert_eq!(World::get_raycast_enabled(), false);
    ///
    /// World::raycast_enabled(true);
    /// let ray = Ray::new(Vec3::ZERO, Vec3::ONE);
    ///
    /// if raycast_is_present {
    ///     assert_eq!(World::raycast(ray), None);
    /// } else {
    ///     assert_eq!(World::raycast(ray), None);
    /// }
    /// ```
    pub fn raycast(ray: impl Into<Ray>) -> Option<Ray> {
        let mut intersection = Ray::default();
        if unsafe { world_raycast(ray.into(), &mut intersection) != 0 } { Some(intersection) } else { None }
    }

    /// This is the orientation and center point of the system’s boundary/guardian. This can be useful to find the floor
    /// height! Not all systems have a boundary, so be sure to check [`World::has_bounds`] first.
    /// <https://stereokit.net/Pages/StereoKit/World/BoundsPose.html>
    ///
    /// see also [world_get_bounds_pose]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::World, maths::Pose};
    ///
    /// let bounds_pose = World::get_bounds_pose();
    ///
    /// xr_mode_stop_here!();
    /// // These are the expected results for offscreen tests on a PC:
    /// if World::has_bounds(){
    ///     // These are results for a non OpenXR environment:
    ///     assert_eq!(bounds_pose, Pose::IDENTITY);
    /// } else {
    ///     // These are results for a non OpenXR environment:
    ///     assert_eq!(bounds_pose, Pose::IDENTITY);
    /// }
    /// ```
    pub fn get_bounds_pose() -> Pose {
        unsafe { world_get_bounds_pose() }
    }

    /// This is the size of a rectangle within the play boundary/guardian’s space, in meters if one exists. Check
    /// [`World::get_bounds_pose`] for the center point and orientation of the boundary, and check [`World::has_bounds`] to see if it
    /// exists at all!
    /// <https://stereokit.net/Pages/StereoKit/World/BoundsSize.html>
    ///
    /// see also [world_get_bounds_size]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::{system::World, maths::Vec2};
    ///
    /// let bounds_size = World::get_bounds_size();
    ///
    /// if World::has_bounds(){
    ///     // These are results for a non OpenXR environment:
    ///     // Sometime it's ZERO (Monado/simulator) and sometimes it's a valid size (real OpenXR):
    /// } else {
    ///     // These are results for a non OpenXR environment:
    ///     assert_eq!(bounds_size, Vec2::ZERO);
    /// }
    /// ```
    pub fn get_bounds_size() -> Vec2 {
        unsafe { world_get_bounds_size() }
    }

    /// This refers to the play boundary, or guardian system that the system may have! Not all systems have this, so
    /// it’s always a good idea to check this first!
    /// <https://stereokit.net/Pages/StereoKit/World/HasBounds.html>
    ///
    /// see also [world_has_bounds]
    /// see example in [`World::get_bounds_size`] [`World::get_bounds_pose`]
    pub fn has_bounds() -> bool {
        unsafe { world_has_bounds() != 0 }
    }

    /// Off by default. This tells StereoKit to load up and display an occlusion surface that allows the real world to
    /// occlude the application’s digital content! Most systems may allow you to customize the visual appearance of this
    /// occlusion surface via the World::occlusion_material. Check SK::System::world_occlusion_present to see if
    /// occlusion can be enabled. This will reset itself to false if occlusion isn’t possible. Loading occlusion data
    /// is asynchronous, so occlusion may not occur immediately after setting this flag.
    /// <https://stereokit.net/Pages/StereoKit/World/OcclusionEnabled.html>
    ///
    /// see also [world_get_occlusion_enabled]
    /// see example in [`World::occlusion_enabled`]
    pub fn get_occlusion_enabled() -> bool {
        unsafe { world_get_occlusion_enabled() != 0 }
    }

    /// By default, this is a black(0,0,0,0) opaque unlit material that will occlude geometry, but won’t show up as
    /// visible anywhere. You can override this with whatever material you would like.
    /// <https://stereokit.net/Pages/StereoKit/World/OcclusionMaterial.html>
    ///
    /// see also [world_get_occlusion_material]
    /// see example in [`World::occlusion_material`]
    pub fn get_occlusion_material() -> Material {
        Material(NonNull::new(unsafe { world_get_occlusion_material() }).unwrap())
    }

    /// The mode or “reference space” that StereoKit uses for determining its base origin. This is determined by the
    /// initial value provided in [`crate::sk::SkSettings.origin`], as well as by support from the underlying runtime. The mode
    /// reported here will not necessarily be the one requested in initialization, as fallbacks are implemented using
    /// different available modes.
    /// <https://stereokit.net/Pages/StereoKit/World/OriginMode.html>
    ///
    /// see also [world_get_origin_mode]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::World;
    ///
    /// let origin_mode_init = sk.get_settings().origin;
    ///
    /// let origin_mode = World::get_origin_mode();
    ///
    /// assert_eq!(origin_mode_init, origin_mode);
    /// ```
    pub fn get_origin_mode() -> OriginMode {
        unsafe { world_get_origin_mode() }
    }

    /// This reports the status of the device's positional tracking. If the room is too dark, or a hand is covering
    /// tracking sensors, or some other similar 6dof tracking failure, this would report as not tracked.
    ///
    /// Note that this does not factor in the status of rotational tracking. Rotation is typically done via
    /// gyroscopes/accelerometers, which don't really fail the same way positional tracking system can.
    /// <https://stereokit.net/Pages/StereoKit/World/Tracked.html>
    ///
    /// see also [world_get_tracked]
    /// ### Examples
    /// ```
    /// # stereokit_rust::test_init_sk!(); // !!!! Get a proper way to initialize sk !!!!
    /// use stereokit_rust::system::{World, BtnState};
    ///
    /// let is_tracked = World::get_tracked();
    ///
    /// xr_mode_stop_here!();
    /// // These are the expected results for offscreen tests on a PC:
    /// assert_eq!(is_tracked, BtnState::Active);
    /// ```
    pub fn get_tracked() -> BtnState {
        unsafe { world_get_tracked() }
    }

    /// This is relative to the base reference point and is NOT in world space! The origin StereoKit uses is actually a
    /// base reference point combined with an offset! You can use this to read or set the offset from the OriginMode
    /// reference point.
    /// <https://stereokit.net/Pages/StereoKit/World/OriginOffset.html>
    ///
    /// see also [world_get_origin_offset]
    /// see example in [`World::origin_offset`]
    pub fn get_origin_offset() -> Pose {
        unsafe { world_get_origin_offset() }
    }

    /// Off by default. This tells StereoKit to load up collision meshes for the environment, for use with
    /// World::raycast. Check SK::System::world_raycast_present to see if raycasting can be enabled. This will reset
    /// itself to false if raycasting isn’t possible. Loading raycasting data is asynchronous, so collision surfaces may
    /// not be available immediately after setting this flag.
    /// <https://stereokit.net/Pages/StereoKit/World/RaycastEnabled.html>
    ///
    /// see also [world_get_raycast_enabled]
    /// see example in [`World::raycast_enabled`]
    pub fn get_raycast_enabled() -> bool {
        unsafe { world_get_raycast_enabled() != 0 }
    }

    /// The refresh interval speed, in seconds. This is only applicable when using WorldRefresh::Timer for the refresh
    /// type. Note that the system may not be able to refresh as fast as you wish, and in that case, StereoKit will
    /// always refresh as soon as the previous refresh finishes.
    /// <https://stereokit.net/Pages/StereoKit/World/RefreshInterval.html>
    ///
    /// see also [world_get_refresh_interval]
    /// see example in [`World::refresh_interval`]
    pub fn get_refresh_interval() -> f32 {
        unsafe { world_get_refresh_interval() }
    }

    /// Radius, in meters, of the area that StereoKit should scan for world data. Default is 4. When using the
    /// WorldRefresh::Area refresh type, the world data will refresh when the user has traveled half this radius from
    /// the center of where the most recent refresh occurred.
    /// <https://stereokit.net/Pages/StereoKit/World/RefreshRadius.html>
    ///
    /// see also [world_get_refresh_radius]
    /// see example in [`World::refresh_radius`]
    pub fn get_refresh_radius() -> f32 {
        unsafe { world_get_refresh_radius() }
    }

    /// What information should StereoKit use to determine when the next world data refresh happens? See the
    /// WorldRefresh enum for details.
    /// <https://stereokit.net/Pages/StereoKit/World/RefreshType.html>
    ///
    /// see also [world_get_refresh_type]
    /// see example in [`World::refresh_type`]
    pub fn get_refresh_type() -> WorldRefresh {
        unsafe { world_get_refresh_type() }
    }
}