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 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
//! Visualization of shape and polygon mesh based on platform
#![cfg_attr(not(debug_assertions), deny(warnings))]
#![deny(clippy::all, rust_2018_idioms)]
#![warn(
missing_docs,
missing_debug_implementations,
trivial_casts,
trivial_numeric_casts,
unsafe_code,
unstable_features,
unused_import_braces,
unused_qualifications
)]
use bytemuck::{Pod, Zeroable};
use image::DynamicImage;
use std::sync::Arc;
use truck_platform::{wgpu::*, *};
/// Re-exports `truck_polymesh`.
pub mod polymesh {
pub use truck_polymesh::*;
}
pub use polymesh::*;
/// Material information.
///
/// Each instance is rendered based on the microfacet theory.
#[derive(Debug, Clone, Copy)]
pub struct Material {
/// albedo, base color, [0, 1]-normalized rgba. Default is `Vector4::new(1.0, 1.0, 1.0, 1.0)`.
/// Transparent by alpha is not yet supported in the current standard shader.
pub albedo: Vector4,
/// roughness of the surface: [0, 1]. Default is 0.5.
pub roughness: f64,
/// ratio of specular: [0, 1]. Default is 0.25.
pub reflectance: f64,
/// ratio of ambient: [0, 1]. Default is 0.02.
pub ambient_ratio: f64,
/// ratio of blending background color: [0, 1]. Default is 0.0.
pub background_ratio: f64,
/// alpha blend flag
pub alpha_blend: bool,
}
/// Configures of instances.
#[derive(Clone, Debug)]
pub struct PolygonState {
/// instance matrix
pub matrix: Matrix4,
/// material of instance
pub material: Material,
/// texture of instance
pub texture: Option<Arc<Texture>>,
/// If this parameter is true, the backface culling will be activated.
pub backface_culling: bool,
}
/// Configures of `WireFrameInstance`.
#[derive(Clone, Debug)]
pub struct WireFrameState {
/// instance matrix
pub matrix: Matrix4,
/// color of instance
pub color: Vector4,
}
/// shaders for rendering polygons
#[derive(Debug, Clone)]
pub struct PolygonShaders {
vertex_module: Arc<ShaderModule>,
vertex_entry: &'static str,
fragment_module: Arc<ShaderModule>,
fragment_entry: &'static str,
tex_fragment_module: Arc<ShaderModule>,
tex_fragment_entry: &'static str,
}
/// shaders for rendering wireframes
#[derive(Debug, Clone)]
pub struct WireShaders {
vertex_module: Arc<ShaderModule>,
vertex_entry: &'static str,
fragment_module: Arc<ShaderModule>,
fragment_entry: &'static str,
}
/// Instance of polygon
///
/// One can duplicate polygons with different postures and materials
/// that have the same mesh data.
/// To save memory, mesh data on the GPU can be used again.
///
/// The duplicated polygon by `Clone::clone` has the same mesh data and descriptor
/// with original, however, its render id is different from the one of original.
#[derive(Debug)]
pub struct PolygonInstance {
polygon: (Arc<BufferHandler>, Arc<BufferHandler>),
state: PolygonState,
shaders: PolygonShaders,
id: RenderID,
}
/// Wire frame rendering
#[derive(Debug)]
pub struct WireFrameInstance {
vertices: Arc<BufferHandler>,
strips: Arc<BufferHandler>,
state: WireFrameState,
shaders: WireShaders,
id: RenderID,
}
/// Constroctor for instances
#[derive(Debug, Clone)]
pub struct InstanceCreator {
handler: DeviceHandler,
polygon_shaders: PolygonShaders,
wire_shaders: WireShaders,
}
/// for creating `InstanceCreator`
pub trait CreatorCreator {
/// create `InstanceCreator`
fn instance_creator(&self) -> InstanceCreator;
}
/// The trait for Buffer Objects.
pub trait CreateBuffers {
/// Creates buffer handlers of attributes and indices.
fn buffers(
&self,
vertex_usage: BufferUsages,
index_usage: BufferUsages,
device: &Device,
) -> (BufferHandler, BufferHandler);
}
/// The trait for generating `Instance` from `Self`.
pub trait ToInstance<I: Instance> {
/// Configuration descriptor for instance.
type State;
/// Creates `Instance` from `self`.
fn to_instance(&self, handler: &DeviceHandler, shaders: &I::Shaders, desc: &Self::State) -> I;
}
/// Instance for rendering
pub trait Instance {
#[doc(hidden)]
type Shaders;
/// Get standard shaders from instance creator.
#[doc(hidden)]
fn standard_shaders(creator: &InstanceCreator) -> Self::Shaders;
}
#[repr(C)]
#[derive(Debug, Clone, Copy, Zeroable, Pod)]
struct AttrVertex {
pub position: [f32; 3],
pub uv_coord: [f32; 2],
pub normal: [f32; 3],
}
/// utility for creating `Texture`
pub mod image2texture;
mod instance_creator;
mod instance_descriptor;
mod polygon_instance;
mod polyrend;
mod wireframe_instance;