Update egui + disable egui by default (asny#270)

* Almost working

* Use released egui (ContextRef + fix fonts)

* Revert example changes

* Fix examples

* Fixes

* Fix web

* egui-gui feature is no longer default

* Update rust.yml

* Avoid ContextRef (Context again impl Send+Sync)

* Avoid changes to canvas

* docs

* Remove unused shaders

* gui module + Readme description

.github/workflows/rust.yml

@@ -2,6 +2,8 @@ name: build
 
 on:
   push:
+    branches:
+      - master
   pull_request:
     branches:
       - master

Cargo.toml

@@ -17,16 +17,17 @@ rustdoc-args = ["--cfg", "docsrs"]
 targets = ["x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc", "wasm32-unknown-unknown"]
 
 [features]
-default = ["window", "egui-gui"]
+default = ["window"]
 window = ["glutin"] # Window module
-egui-gui = ["egui"] # Additional GUI features 
+egui-gui = ["egui_glow", "egui"] # Additional GUI features 
 
 [dependencies]
 glow = "0.11"
 cgmath = "0.18"
 three-d-asset = "0.3"
 thiserror = "1"
-egui = { version = "0.13", optional = true }
+egui = { version = "0.18", optional = true }
+egui_glow = { version = "0.18", optional = true }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 glutin = { version = "0.29", optional = true }
@@ -51,6 +52,7 @@ path = "examples/triangle/src/main.rs"
 [[example]]
 name = "screen"
 path = "examples/screen/src/main.rs"
+required-features = ["egui-gui"]
 
 [[example]]
 name = "mandelbrot"
@@ -75,6 +77,7 @@ path = "examples/texture/src/main.rs"
 [[example]]
 name = "volume"
 path = "examples/volume/src/main.rs"
+required-features = ["egui-gui"]
 
 [[example]]
 name = "picking"
@@ -83,22 +86,27 @@ path = "examples/picking/src/main.rs"
 [[example]]
 name = "environment"
 path = "examples/environment/src/main.rs"
+required-features = ["egui-gui"]
 
 [[example]]
 name = "pbr"
 path = "examples/pbr/src/main.rs"
+required-features = ["egui-gui"]
 
 [[example]]
 name = "lighting"
 path = "examples/lighting/src/main.rs"
+required-features = ["egui-gui"]
 
 [[example]]
 name = "lights"
 path = "examples/lights/src/main.rs"
+required-features = ["egui-gui"]
 
 [[example]]
 name = "image"
 path = "examples/image/src/main.rs"
+required-features = ["egui-gui"]
 
 [[example]]
 name = "fog"
@@ -111,6 +119,7 @@ path = "examples/fireworks/src/main.rs"
 [[example]]
 name = "statues"
 path = "examples/statues/src/main.rs"
+required-features = ["egui-gui"]
 
 [[example]]
 name = "wireframe"

README.md

@@ -27,14 +27,15 @@ A OpenGL/WebGL/OpenGL ES renderer which seeks to make graphics simple but still
 - tools (2D or 3D)
 - games (2D or 3D)
 
-The crate consist of three main modules for drawing, `context`, `core` and `renderer`, and an optional `window` module for easy setup:
+The crate consist of three main modules for drawing, `context`, `core` and `renderer`, and an optional `window` module for easy setup and an optional `gui` integration module:
 
 | Module           | Description                   
 | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 
 | [`context`](https://docs.rs/three-d/0/three_d/context/) | Low-level rendering module - requires a solid understanding of graphics concepts. Gives you complete control over both setup and rendering.                             
 | [`core`](https://docs.rs/three-d/0/three_d/core/) | Mid-level rendering module - requires at least some knowledge about graphics concepts. Use this if you want to write your own shaders and but don't want to spend time on setup and error handling. Can be combined with low-level functionality in the `context` module.                                                                                                                           
 | [`renderer`](https://docs.rs/three-d/0/three_d/renderer/)  | High-level rendering module - requires no knowledge about graphics concepts. Use this if you just want to draw something on the screen. Features include methods for rendering different types of standard objects with different types of shading. Can be combined seamlessly with the mid-level features in the `core` module as well as functionality in the `context` module.             |
 | [`window`](https://docs.rs/three-d/0/three_d/window/) (requires the `"window"` feature) | Contains functionality for creating a window on both cross-platform native and web. Also contain render loop, event handling and camera control functionality. Can be replaced by anything that provides an OpenGL or WebGL2 graphics context, for example [eframe](https://github.com/emilk/egui/tree/master/eframe) as shown in [this](https://github.com/emilk/egui/blob/master/eframe/examples/custom_3d_three-d.rs) example.
+| [`gui`](https://docs.rs/three-d/0/three_d/gui/) | Contains functionality for using the immediate mode GUI [egui](https://crates.io/crates/egui) (requires the `"egui-gui"` feature).
 
 In addition, the [three-d-asset](https://github.com/asny/three-d-asset) crate enables loading, deserializing, serializing and saving 3D assets, for example 3D models, textures etc. 
 

examples/environment/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../" }
+three-d = { path = "../../", features=["egui-gui"] }
 three-d-asset = {version = "0.3", features = ["hdr", "http"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

examples/headless/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../", default-features = false, features=["window"] }
+three-d = { path = "../../" }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 log = "0.4"

examples/image/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../" }
+three-d = { path = "../../", features=["egui-gui"] }
 three-d-asset = {version = "0.3", features = ["hdr", "http"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

examples/lighting/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../" }
+three-d = { path = "../../", features=["egui-gui"] }
 three-d-asset = {version = "0.3", features = ["gltf", "jpeg", "http"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

examples/lights/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../" }
+three-d = { path = "../../", features=["egui-gui"] }
 three-d-asset = {version = "0.3", features = ["gltf", "png", "jpeg", "http"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

examples/pbr/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../" }
+three-d = { path = "../../", features=["egui-gui"] }
 three-d-asset = {version = "0.3", features = ["gltf", "hdr", "jpeg", "http"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

examples/screen/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../", default-features = false, features=["window", "egui-gui"] }
+three-d = { path = "../../", features=["egui-gui"] }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 log = "0.4"

examples/shapes/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../", default-features = false, features=["window"] }
+three-d = { path = "../../" }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 log = "0.4"

examples/shapes2d/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../", default-features = false, features=["window"] }
+three-d = { path = "../../" }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 log = "0.4"

examples/statues/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../" }
+three-d = { path = "../../", features=["egui-gui"] }
 three-d-asset = {version = "0.3", features = ["obj", "png", "http"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

examples/triangle/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../", default-features = false, features=["window"] }
+three-d = { path = "../../" }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 log = "0.4"

examples/volume/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-three-d = { path = "../../" }
+three-d = { path = "../../", features=["egui-gui"] }
 three-d-asset = {version = "0.3", features = ["vol", "http"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

src/core/context.rs

@@ -381,7 +381,7 @@ impl std::fmt::Debug for Context {
 }
 
 impl std::ops::Deref for Context {
-    type Target = crate::context::Context;
+    type Target = Arc<crate::context::Context>;
     fn deref(&self) -> &Self::Target {
         &self.context
     }