694c06f3d0
# Objective Currently the `missing_docs` lint is allowed-by-default and enabled at crate level when their documentations is complete (see #3492). This PR proposes to inverse this logic by making `missing_docs` warn-by-default and mark crates with imcomplete docs allowed. ## Solution Makes `missing_docs` warn at workspace level and allowed at crate level when the docs is imcomplete.
92 lines
2.8 KiB
Rust
92 lines
2.8 KiB
Rust
#![allow(
|
|
unsafe_op_in_unsafe_fn,
|
|
clippy::all,
|
|
clippy::undocumented_unsafe_blocks
|
|
)]
|
|
// FIXME(3492): remove once docs are ready
|
|
#![allow(missing_docs)]
|
|
|
|
use glam::{Vec2, Vec3};
|
|
|
|
mod generated;
|
|
|
|
/// The interface by which mikktspace interacts with your geometry.
|
|
pub trait Geometry {
|
|
/// Returns the number of faces.
|
|
fn num_faces(&self) -> usize;
|
|
|
|
/// Returns the number of vertices of a face.
|
|
fn num_vertices_of_face(&self, face: usize) -> usize;
|
|
|
|
/// Returns the position of a vertex.
|
|
fn position(&self, face: usize, vert: usize) -> [f32; 3];
|
|
|
|
/// Returns the normal of a vertex.
|
|
fn normal(&self, face: usize, vert: usize) -> [f32; 3];
|
|
|
|
/// Returns the texture coordinate of a vertex.
|
|
fn tex_coord(&self, face: usize, vert: usize) -> [f32; 2];
|
|
|
|
/// Sets the generated tangent for a vertex.
|
|
/// Leave this function unimplemented if you are implementing
|
|
/// `set_tangent_encoded`.
|
|
fn set_tangent(
|
|
&mut self,
|
|
tangent: [f32; 3],
|
|
_bi_tangent: [f32; 3],
|
|
_f_mag_s: f32,
|
|
_f_mag_t: f32,
|
|
bi_tangent_preserves_orientation: bool,
|
|
face: usize,
|
|
vert: usize,
|
|
) {
|
|
let sign = if bi_tangent_preserves_orientation {
|
|
1.0
|
|
} else {
|
|
-1.0
|
|
};
|
|
self.set_tangent_encoded([tangent[0], tangent[1], tangent[2], sign], face, vert);
|
|
}
|
|
|
|
/// Sets the generated tangent for a vertex with its bi-tangent encoded as the 'W' (4th)
|
|
/// component in the tangent. The 'W' component marks if the bi-tangent is flipped. This
|
|
/// is called by the default implementation of `set_tangent`; therefore, this function will
|
|
/// not be called by the crate unless `set_tangent` is unimplemented.
|
|
fn set_tangent_encoded(&mut self, _tangent: [f32; 4], _face: usize, _vert: usize) {}
|
|
}
|
|
|
|
/// Generates tangents for the input geometry.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// Returns `false` if the geometry is unsuitable for tangent generation including,
|
|
/// but not limited to, lack of vertices.
|
|
pub fn generate_tangents<I: Geometry>(geometry: &mut I) -> bool {
|
|
unsafe { generated::genTangSpace(geometry, 180.0) }
|
|
}
|
|
|
|
fn get_position<I: Geometry>(geometry: &mut I, index: usize) -> Vec3 {
|
|
let (face, vert) = index_to_face_vert(index);
|
|
geometry.position(face, vert).into()
|
|
}
|
|
|
|
fn get_tex_coord<I: Geometry>(geometry: &mut I, index: usize) -> Vec3 {
|
|
let (face, vert) = index_to_face_vert(index);
|
|
let tex_coord: Vec2 = geometry.tex_coord(face, vert).into();
|
|
let val = tex_coord.extend(1.0);
|
|
val
|
|
}
|
|
|
|
fn get_normal<I: Geometry>(geometry: &mut I, index: usize) -> Vec3 {
|
|
let (face, vert) = index_to_face_vert(index);
|
|
geometry.normal(face, vert).into()
|
|
}
|
|
|
|
fn index_to_face_vert(index: usize) -> (usize, usize) {
|
|
(index >> 2, index & 0x3)
|
|
}
|
|
|
|
fn face_vert_to_index(face: usize, vert: usize) -> usize {
|
|
face << 2 | vert & 0x3
|
|
}
|