Replace cgmath bindings by mint (#1301)

* Replace `cgmath-types` by `mint`

User needs manually set `mint` feature in his dependencies if he
wants to use mint types in constant buffers and/or uniforms for shaders.

* Replace `cgmath` by mint in constant buffers.

Now supports both column-major and row-major matrices.

* Replace `cgmath` by `mint` in uniforms.

* Fix imports & appveyor build settings

Author: vitvakatu

.travis.yml

@@ -54,7 +54,7 @@ script:
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then cargo build --features metal; else cargo build; fi
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then HEADLESS_FEATURE="--features headless"; fi
   - cargo test --all
-  - cargo test -p gfx -p gfx_core --features "cgmath-types serialize"
+  - cargo test -p gfx -p gfx_core --features "mint serialize"
   - cargo test -p gfx_window_sdl
   - cargo test -p gfx_device_gl
   - cargo test -p gfx_window_glutin $HEADLESS_FEATURE

Cargo.toml

@@ -10,7 +10,7 @@ documentation = "https://docs.rs/gfx_app"
 
 [features]
 default = []
-cgmath-types = ["gfx/cgmath-types", "gfx_core/cgmath-types"]
+mint = ["gfx/mint", "gfx_core/mint"]
 metal = ["gfx_device_metal", "gfx_window_metal", "gfx_device_metalll"]
 vulkan = ["gfx_device_vulkan", "gfx_device_vulkanll", "gfx_window_vulkan"]
 sdl = ["gfx_window_sdl"]

appveyor.yml

@@ -18,4 +18,4 @@ build_script:
   - cargo build --features vulkan
 test_script:
   - cargo test --all --features vulkan
-  - cargo test -p gfx -p gfx_core --features "cgmath-types serialize"
+  - cargo test -p gfx -p gfx_core --features "mint serialize"

src/core/Cargo.toml

@@ -29,14 +29,13 @@ path = "src/lib.rs"
 
 [dependencies]
 bitflags = "0.8"
-cgmath = { version = "0.14", optional = true }
+mint = { version = "0.4.1", optional = true }
 derivative = "1.0"
 draw_state = "0.7"
 log = "0.3"
 serde = { version = "1.0", optional = true }
 serde_derive = { version = "1.0", optional = true }
 
 [features]
-cgmath-types = ["cgmath"]
 serialize = ["serde", "serde_derive", "draw_state/serialize"]
 unstable = []

src/core/src/lib.rs

@@ -24,8 +24,8 @@ extern crate derivative;
 extern crate draw_state;
 extern crate log;
 
-#[cfg(feature = "cgmath-types")]
-extern crate cgmath;
+#[cfg(feature = "mint")]
+extern crate mint;
 
 #[cfg(feature = "serialize")]
 extern crate serde;
@@ -209,7 +209,7 @@ pub enum IndexType {
     U32,
 }
 
-/// Different types of a specific API. 
+/// Different types of a specific API.
 #[allow(missing_docs)]
 pub trait Resources:          Clone + Hash + Debug + Eq + PartialEq + Any {
     type Buffer:              Clone + Hash + Debug + Eq + PartialEq + Any + Send + Sync + Copy;
@@ -254,7 +254,7 @@ impl Error for SubmissionError {
 #[allow(missing_docs)]
 pub type SubmissionResult<T> = Result<T, SubmissionError>;
 
-/// A `Device` is responsible for submitting `CommandBuffer`s to the GPU. 
+/// A `Device` is responsible for submitting `CommandBuffer`s to the GPU.
 pub trait Device: Sized {
     /// Associated `Resources` type.
     type Resources: Resources;
@@ -285,7 +285,7 @@ pub trait Device: Sized {
     /// Stalls the current thread until the fence is satisfied
     fn wait_fence(&mut self, &handle::Fence<Self::Resources>);
 
-    /// Cleanup unused resources. This should be called between frames. 
+    /// Cleanup unused resources. This should be called between frames.
     fn cleanup(&mut self);
 }
 
@@ -298,7 +298,7 @@ pub trait Adapter: Sized {
     /// Associated `QueueFamily` type.
     type QueueFamily: QueueFamily;
 
-    /// Enumerate all available adapters supporting this backend 
+    /// Enumerate all available adapters supporting this backend
     fn enumerate_adapters() -> Vec<Self>;
 
     /// Create a new device and command queues.

src/core/src/shade.rs

@@ -21,8 +21,8 @@ use std::error::Error;
 use {Resources};
 use {AttributeSlot, ColorSlot, ConstantBufferSlot, ResourceViewSlot, SamplerSlot, UnorderedViewSlot};
 
-#[cfg(feature = "cgmath-types")]
-use cgmath::{Deg, Matrix2, Matrix3, Matrix4, Point2, Point3, Rad, Vector2, Vector3, Vector4};
+#[cfg(feature = "mint")]
+use mint;
 
 /// Number of components in a container type (vectors/matrices)
 pub type Dimension = u8;
@@ -252,11 +252,11 @@ macro_rules! impl_const_matrix {
     }
 }
 
-#[cfg(feature = "cgmath-types")]
-macro_rules! impl_const_vector_cgmath {
+#[cfg(feature = "mint")]
+macro_rules! impl_const_vector_mint {
     ( $( $name:ident = $num:expr, )* ) => {
         $(
-            impl<T: BaseTyped> Formatted for $name<T> {
+            impl<T: BaseTyped> Formatted for mint::$name<T> {
                 fn get_format() -> ConstFormat {
                     (T::get_base_type(), ContainerType::Vector($num))
                 }
@@ -265,13 +265,13 @@ macro_rules! impl_const_vector_cgmath {
     }
 }
 
-#[cfg(feature = "cgmath-types")]
-macro_rules! impl_const_matrix_cgmath {
-    ( $( $name:ident = $size:expr, )* ) => {
+#[cfg(feature = "mint")]
+macro_rules! impl_const_matrix_mint {
+    ( $( $name:ident = $format:ident $size:expr, )* ) => {
         $(
-            impl<T: BaseTyped> Formatted for $name<T> {
+            impl<T: BaseTyped> Formatted for mint::$name<T> {
                 fn get_format() -> ConstFormat {
-                    let mf = MatrixFormat::ColumnMajor;
+                    let mf = MatrixFormat::$format;
                     (T::get_base_type(), ContainerType::Matrix(mf, $size, $size))
                 }
             }
@@ -286,12 +286,6 @@ impl_base_type! {
     bool = Bool,
 }
 
-#[cfg(feature = "cgmath-types")]
-impl_base_type! {
-    Deg<f32> = F32,
-    Rad<f32> = F32,
-}
-
 impl<T: BaseTyped> Formatted for T {
     fn get_format() -> ConstFormat {
         (T::get_base_type(), ContainerType::Single)
@@ -301,20 +295,23 @@ impl<T: BaseTyped> Formatted for T {
 impl_const_vector!(2, 3, 4);
 impl_const_matrix!([2,2], [3,3], [4,4], [4,3]);
 
-#[cfg(feature = "cgmath-types")]
-impl_const_vector_cgmath! {
+#[cfg(feature = "mint")]
+impl_const_vector_mint! {
     Point2 = 2,
     Point3 = 3,
     Vector2 = 2,
     Vector3 = 3,
     Vector4 = 4,
 }
 
-#[cfg(feature = "cgmath-types")]
-impl_const_matrix_cgmath! {
-    Matrix2 = 2,
-    Matrix3 = 3,
-    Matrix4 = 4,
+#[cfg(feature = "mint")]
+impl_const_matrix_mint! {
+    ColumnMatrix2 = ColumnMajor 2,
+    ColumnMatrix3 = ColumnMajor 3,
+    ColumnMatrix4 = ColumnMajor 4,
+    RowMatrix2 = RowMajor 2,
+    RowMatrix3 = RowMajor 3,
+    RowMatrix4 = RowMajor 4,
 }
 
 bitflags!(

src/render/Cargo.toml

@@ -30,12 +30,11 @@ name = "gfx"
 path = "src/lib.rs"
 
 [features]
-cgmath-types = ["gfx_core/cgmath-types", "cgmath"]
 serialize = ["gfx_core/serialize", "draw_state/serialize"]
 unstable = []
 
 [dependencies]
-cgmath = { version = "0.14", optional = true }
+mint = { version = "0.4.1", optional = true }
 derivative = "1.0"
 draw_state = "0.7"
 gfx_core = { path = "../core", version = "0.7.1" }

src/render/src/lib.rs

@@ -17,8 +17,8 @@
 //! An efficient, low-level, bindless graphics API for Rust. See [the
 //! blog](http://gfx-rs.github.io/) for explanations and annotated examples.
 
-#[cfg(feature = "cgmath-types")]
-extern crate cgmath;
+#[cfg(feature = "mint")]
+extern crate mint;
 
 extern crate log;
 #[macro_use]

src/render/src/shade.rs

@@ -14,8 +14,8 @@
 
 //! Shader parameter handling.
 
-#[cfg(feature = "cgmath-types")]
-use cgmath::{Deg, Matrix2, Matrix3, Matrix4, Rad, Point2, Point3, Vector2, Vector3, Vector4};
+#[cfg(feature = "mint")]
+use mint;
 
 use std::error::Error;
 use std::fmt;
@@ -52,30 +52,16 @@ impl_uniforms! {
     [[f32; 4]; 4] = F32Matrix4,
 }
 
-#[cfg(feature = "cgmath-types")]
-impl ToUniform for Deg<f32> {
-    fn convert(self) -> core::UniformValue {
-        core::UniformValue::F32(self.0)
-    }
-}
-
-#[cfg(feature = "cgmath-types")]
-impl ToUniform for Rad<f32> {
-    fn convert(self) -> core::UniformValue {
-        core::UniformValue::F32(self.0)
-    }
-}
-
-#[cfg(feature = "cgmath-types")]
+#[cfg(feature = "mint")]
 impl_uniforms! {
-    Point2<f32> = F32Vector2,
-    Point3<f32> = F32Vector3,
-    Vector2<f32> = F32Vector2,
-    Vector3<f32> = F32Vector3,
-    Vector4<f32> = F32Vector4,
-    Matrix2<f32> = F32Matrix2,
-    Matrix3<f32> = F32Matrix3,
-    Matrix4<f32> = F32Matrix4,
+    mint::Point2<f32> = F32Vector2,
+    mint::Point3<f32> = F32Vector3,
+    mint::Vector2<f32> = F32Vector2,
+    mint::Vector3<f32> = F32Vector3,
+    mint::Vector4<f32> = F32Vector4,
+    mint::ColumnMatrix2<f32> = F32Matrix2,
+    mint::ColumnMatrix3<f32> = F32Matrix3,
+    mint::ColumnMatrix4<f32> = F32Matrix4,
 }
 
 /// Program linking error