mittens-engine 0.6.0

A Vulkan and OpenXR scene engine with ECS, reactive signals, and Meow Meow scripting
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

pub mod bounds;
pub mod mesh;
pub mod pipeline_descriptor_set_layouts;
pub mod post_processing;
pub mod primitives;
pub mod render_assets;
pub mod render_info;
pub mod skin;
pub mod visual_world;
pub mod vulkano_renderer;
pub(crate) mod vulkano_swapchain;
pub mod xr_renderer;
pub mod xr_swapchain;

pub use mesh::{CpuMesh, CpuVertex, MeshFactory};
pub use post_processing::{
    BloomConfig, BloomSource, BlurPassConfig, BokehConfig, EmissivePassConfig,
    PostProcessingConfig, PostProcessingRenderer,
};
#[allow(unused_imports)]
pub use primitives::{
    GpuRenderable, Material, MaterialHandle, MeshHandle, Renderable, TextureHandle, Transform,
    TransformMatrix,
};

pub use render_assets::{BuiltinMeshType, RenderAssets};
pub use skin::{Skin, SkinId};
pub use visual_world::TextureFiltering;
pub use visual_world::VisualWorld;
pub use visual_world::{CameraData, CameraTarget, VisualCamera};
pub(crate) mod vulkano_texture_upload;
pub use vulkano_renderer::VulkanoRenderer;
pub use xr_swapchain::XRSwapchain;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MsaaMode {
    Off,
    Msaa4x,
}

impl Default for MsaaMode {
    fn default() -> Self {
        Self::Msaa4x
    }
}

/// Minimal Vulkan handle bundle for OpenXR session creation.
///
/// OpenXR wants raw Vulkan handles as opaque pointers.
#[derive(Debug, Clone, Copy)]
pub struct XrVulkanGraphics {
    pub vk_instance: openxr::sys::platform::VkInstance,
    pub vk_physical_device: openxr::sys::platform::VkPhysicalDevice,
    pub vk_device: openxr::sys::platform::VkDevice,
    pub vk_queue: *const std::ffi::c_void,
    pub queue_family_index: u32,
    pub queue_index: u32,
}

pub use render_info::RenderInfo;
/// Trait for uploading CPU meshes to GPU.
/// This abstraction allows different renderer implementations
/// to provide mesh uploading functionality without exposing renderer-specific details.
pub trait MeshUploader {
    fn upload_mesh(&mut self, mesh: &CpuMesh) -> Result<MeshHandle, Box<dyn std::error::Error>>;
}

/// Trait for uploading decoded textures to the GPU.
///
/// Textures are provided as RGBA8 pixels.
pub trait TextureUploader {
    fn upload_texture_rgba8(
        &mut self,
        rgba: &[u8],
        width: u32,
        height: u32,
    ) -> Result<TextureHandle, Box<dyn std::error::Error>>;

    fn upload_texture_bc7(
        &mut self,
        bc7_blocks: &[u8],
        width: u32,
        height: u32,
        srgb: bool,
    ) -> Result<TextureHandle, Box<dyn std::error::Error>>;
}

/// Convenience super-trait for types that can upload both meshes and textures.
pub trait RenderUploader: MeshUploader + TextureUploader {}

impl<T> RenderUploader for T where T: MeshUploader + TextureUploader {}

/// Graphics/Vulkan placeholder.
pub struct Graphics;

impl Graphics {
    pub fn new() -> Self {
        Self
    }
}