- Add overlay example as a official example and add to cargo

- Moved `vec` allocation for per-frame pass to a bump allocator; huge speed improvement.
- Change shaders to be precompiled by default, removing `shader-compiler` feature requirement, reduces build times/removes shaderc requirement
- bump version for publish

Author: jaynus

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "amethyst-imgui"
-version = "0.5.1"
+version = "0.5.2"
 description = "imgui library for amethyst"
 license = "CC0-1.0"
 authors = ["Awpteamoose <cargo@awpteamoose.my.to>", "Walter Pearce <jaynus@gmail.com>"]
@@ -10,22 +10,32 @@ edition = "2018"
 
 [features]
 default = ["amethyst/vulkan"]
+shader-compiler = ["amethyst/shader-compiler"]
 docking = []
 
 [dependencies]
 imgui = { version = "0.2" }
 imgui-winit-support = { version = "0.2" }
-amethyst = { version = "0.13", features = ["shader-compiler"] }
-#amethyst = { path = "../amethyst", features = ["nightly", "saveload", "vulkan", "gltf", "experimental-spirv-reflection", "shader-compiler", "tiles"] }
+amethyst = { version = "0.13" }
 
-# For docking support
-#imgui = { git = "https://github.com/jaynus/imgui-rs", branch"="docking" }
-#imgui-winit-support = { git = "https://github.com/jaynus/imgui-rs", branch"="docking" }
+# Development dependencies
+#amethyst = { path = "../amethyst", features = ["saveload", "vulkan", "gltf", "experimental-spirv-reflection", "shader-compiler", "tiles"] }
+#imgui = { path = "../imgui-rs" }
+#imgui-winit-support = { path = "../imgui-rs/imgui-winit-support" }
+
+# Docking dependencies
+#imgui = { git = "https://github.com/jaynus/imgui-rs.git" }
+#imgui-winit-support = { git = "https://github.com/jaynus/imgui-rs.git" }
 
 lazy_static = "1.3"
 derivative = "1.0"
 failure = "0.1"
+bumpalo = "2.6"
 
 [[example]]
 name = "demo_window"
 path = "examples/demo_window.rs"
+
+[[example]]
+name = "demo_overlay"
+path = "examples/demo_overlay.rs"

Makefile

@@ -0,0 +1,29 @@
+# This Makefile is meant for shader compilation only.
+# Use cargo to compile the rust part of the project.
+
+GLSLC = $(shell ./find_glslc.sh)
+ifeq "$(GLSLC)" ""
+	break;
+endif
+
+FLAGS = -c -g
+
+SHADERS=$(wildcard src/shaders/*)
+COMP_SHADERS = $(patsubst src/shaders/%,compiled/%.spv,$(SHADERS))
+COMP_DISASMS = $(patsubst src/shaders/%,compiled/%.spvasm,$(SHADERS))
+
+
+all: $(COMP_SHADERS) $(COMP_DISASMS)
+
+compiled/%.spv: src/shaders/%
+	mkdir -p $(dir $@)
+	$(GLSLC) -MD -c -O -o $@ $<
+
+compiled/%.spvasm: src/shaders/%
+	mkdir -p $(dir $@)
+	$(GLSLC) -MD -S -g -O -o $@ $<
+
+clean:
+	rm compiled/*.spv compiled/*.spvasm compiled/*.d
+
+.PHONY: all clean

compiled/.gitignore

@@ -0,0 +1,2 @@
+*.spvasm
+*.d

compiled/imgui.frag.spv

@@ -7,7 +7,11 @@ use amethyst::{
 	renderer::{bundle::RenderingBundle, types::DefaultBackend, RenderToWindow},
 	utils::application_root_dir,
 };
-use amethyst_imgui::{imgui, imgui::im_str, RenderImgui};
+use amethyst_imgui::{
+	imgui,
+	imgui::{im_str, ImString},
+	RenderImgui,
+};
 use std::sync::{Arc, Mutex};
 
 const DISTANCE: f32 = 10.0;

compiled/imgui.vert.spv

@@ -0,0 +1,16 @@
+cd "${0%/*}"
+set -e
+
+BIN=""
+
+if [ -e "$(which glslc)" ]; then
+    BIN="$(which glslc)"
+elif [ -e "$(which glslc.exe)" ]; then
+    # support WSL
+    BIN="$(which glslc.exe)"
+else
+    >&2 echo "Cannot find glslc binary. Make sure you have VulkanSDK installed and added to PATH."
+    exit 1
+fi
+
+echo "$BIN"

examples/demo_overlay.rs

@@ -112,8 +112,6 @@ impl<'a, 'b, T: BindingTypes> SystemDesc<'a, 'b, ImguiInputSystem<T>> for ImguiI
 	}
 }
 
-/// Ui is actually Ui<'a>
-/// This implies 'static
 static mut CURRENT_UI: Option<imgui::Ui<'static>> = None;
 
 pub fn with(f: impl FnOnce(&imgui::Ui)) {
@@ -124,7 +122,6 @@ pub fn with(f: impl FnOnce(&imgui::Ui)) {
 	}
 }
 
-// what lifeimtes go here? how do I use transmute here?
 pub unsafe fn current_ui<'a>() -> Option<&'a imgui::Ui<'a>> { CURRENT_UI.as_ref() }
 
 /// A [RenderPlugin] for rendering Imgui elements.

find_glslc.sh

@@ -24,7 +24,7 @@ use amethyst::{
 				pso,
 			},
 			mesh::{AsAttribute, AsVertex, Color, TexCoord, VertexFormat},
-			shader::{PathBufShaderInfo, Shader, ShaderKind, SourceLanguage, SpirvShader},
+			shader::{Shader, SpirvShader},
 			texture::TextureBuilder,
 		},
 		submodules::{DynamicIndexBuffer, DynamicVertexBuffer, TextureId, TextureSub},
@@ -36,17 +36,25 @@ use amethyst::{
 	window::Window,
 	winit::Event,
 };
+use bumpalo::{collections::Vec as BumpVec, Bump};
+
 use derivative::Derivative;
 use imgui::{internal::RawWrapper, DrawCmd, DrawCmdParams};
 use std::{
 	borrow::Cow,
-	path::PathBuf,
 	sync::{Arc, Mutex},
 };
 
 use crate::ImguiContextWrapper;
-use imgui_winit_support::{WinitPlatform};
+use imgui_winit_support::WinitPlatform;
+
+#[cfg(feature = "shader-compiler")]
+use amethyst::renderer::rendy::shader::{PathBufShaderInfo, ShaderKind, SourceLanguage};
+
+#[cfg(feature = "shader-compiler")]
+use std::path::PathBuf;
 
+#[cfg(feature = "shader-compiler")]
 lazy_static::lazy_static! {
 	static ref VERTEX_SRC: SpirvShader = PathBufShaderInfo::new(
 		PathBuf::from(concat!(env!("CARGO_MANIFEST_DIR"), "/src/shaders/imgui.vert")),
@@ -73,12 +81,25 @@ lazy_static::lazy_static! {
 		(*FRAGMENT_SRC).stage(),
 		"main",
 	);
+}
 
-	static ref TIME: std::sync::Mutex<std::time::Instant> = std::sync::Mutex::new(std::time::Instant::now());
+#[cfg(not(feature = "shader-compiler"))]
+lazy_static::lazy_static! {
+	static ref VERTEX: SpirvShader = SpirvShader::new(
+		include_bytes!("../compiled/imgui.vert.spv").to_vec(),
+		pso::ShaderStageFlags::VERTEX,
+		"main",
+	);
 
-//static ref SHADERS: ShaderSetBuilder = ShaderSetBuilder::default()
-//		.with_vertex(&*VERTEX).unwrap()
-//		.with_fragment(&*FRAGMENT).unwrap();
+	static ref FRAGMENT: SpirvShader = SpirvShader::new(
+		include_bytes!("../compiled/imgui.frag.spv").to_vec(),
+		pso::ShaderStageFlags::FRAGMENT,
+		"main",
+	);
+}
+
+lazy_static::lazy_static! {
+	static ref TIME: std::sync::Mutex<std::time::Instant> = std::sync::Mutex::new(std::time::Instant::now());
 }
 
 #[repr(transparent)]
@@ -220,10 +241,8 @@ impl<B: Backend> RenderGroupDesc<B, World> for DrawImguiDesc {
 		_buffers: Vec<NodeBuffer>,
 		_images: Vec<NodeImage>,
 	) -> Result<Box<dyn RenderGroup<B, World>>, failure::Error> {
-		let (context_mutex, mut winit_events) = <(
-			ReadExpect<'_, Arc<Mutex<ImguiContextWrapper>>>,
-			Write<'_, EventChannel<Event>>,
-		)>::fetch(world);
+		let (context_mutex, mut winit_events) =
+			<(ReadExpect<'_, Arc<Mutex<ImguiContextWrapper>>>, Write<'_, EventChannel<Event>>)>::fetch(world);
 
 		let context = &mut context_mutex.lock().unwrap().0;
 
@@ -251,6 +270,7 @@ impl<B: Backend> RenderGroupDesc<B, World> for DrawImguiDesc {
 			batches: Default::default(),
 			imgui_textures,
 			reader_id: winit_events.register_reader(),
+			bump: Mutex::new(Bump::default()),
 		}))
 	}
 }
@@ -276,6 +296,7 @@ pub struct DrawImgui<B: Backend> {
 	constant: ImguiPushConstant,
 	imgui_textures: Vec<Handle<Texture>>,
 	reader_id: ReaderId<Event>,
+	bump: Mutex<Bump>,
 }
 
 impl<B: Backend> DrawImgui<B> {}
@@ -297,6 +318,9 @@ impl<B: Backend> RenderGroup<B, World> for DrawImgui<B> {
 			Read<'_, EventChannel<Event>>,
 		)>::fetch(world);
 
+		let mut bump = self.bump.lock().unwrap();
+		bump.reset();
+
 		let state = &mut context.lock().unwrap().0;
 
 		for texture in &self.imgui_textures {
@@ -324,8 +348,8 @@ impl<B: Backend> RenderGroup<B, World> for DrawImgui<B> {
 				&*(imgui::sys::igGetDrawData() as *mut imgui::DrawData)
 			};
 
-			let mut vertices: Vec<ImguiArgs> = Vec::with_capacity(draw_data.total_vtx_count as usize);
-			let mut indices: Vec<u16> = Vec::with_capacity(draw_data.total_idx_count as usize);
+			let mut vertices: BumpVec<ImguiArgs> = BumpVec::with_capacity_in(draw_data.total_vtx_count as usize, &bump);
+			let mut indices: BumpVec<u16> = BumpVec::with_capacity_in(draw_data.total_idx_count as usize, &bump);
 
 			self.commands.reserve(draw_data.draw_lists().count());