8000 Remove `Arc` around `wgpu::ShaderModule` by a1phyr · Pull Request #1305 · ggez/ggez · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Remove Arc around wgpu::ShaderModule #1305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 24, 2025
Merged

Remove Arc around wgpu::ShaderModule #1305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
79b709b
Remove `Arc` around `wgpu::ShaderModule`
a1phyr Jan 23, 2025
c59774a
Factor initial shader loading
a1phyr Jan 23, 2025
1b3b52e
Avoid a few clones
a1phyr Jan 23, 2025
ae0cdae
Avoid an allocation in pipeline cache
a1phyr Jan 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ obj = ["obj-rs", "3d"]
bitflags = "2.1"
zip = { version = "0.6", default-features = false, features = ["deflate"] }
directories = "5.0"
wgpu = "24"
wgpu = "24.0.1"
glyph_brush = "0.7"
winit = { version = "0.30", features = ["serde"] }
image = { version = "0.25", default-features = false, features = ["gif", "png", "pnm", "tga", "tiff", "webp", "bmp", "jpeg"] }
Expand Down
92 changes: 26 additions & 66 deletions src/graphics/context.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,19 +74,19 @@ pub struct GraphicsContext {
pub(crate) staging_belt: wgpu::util::StagingBelt,
pub(crate) uniform_arena: GrowingBufferArena,

pub(crate) draw_shader: Arc<wgpu::ShaderModule>,
pub(crate) draw_shader: wgpu::ShaderModule,

#[cfg(feature = "3d")]
pub(crate) draw_shader_3d: Arc<wgpu::ShaderModule>,
pub(crate) draw_shader_3d: wgpu::ShaderModule,
#[cfg(feature = "3d")]
pub(crate) instance_shader_3d: Arc<wgpu::ShaderModule>,
pub(crate) instance_shader_3d: wgpu::ShaderModule,
#[cfg(feature = "3d")]
pub(crate) instance_unordered_shader_3d: Arc<wgpu::ShaderModule>,
pub(crate) instance_unordered_shader_3d: wgpu::ShaderModule,

pub(crate) instance_shader: Arc<wgpu::ShaderModule>,
pub(crate) instance_unordered_shader: Arc<wgpu::ShaderModule>,
pub(crate) text_shader: Arc<wgpu::ShaderModule>,
pub(crate) copy_shader: Arc<wgpu::ShaderModule>,
pub(crate) instance_shader: wgpu::ShaderModule,
pub(crate) instance_unordered_shader: wgpu::ShaderModule,
pub(crate) text_shader: wgpu::ShaderModule,
pub(crate) copy_shader: wgpu::ShaderModule,
pub(crate) rect_mesh: Mesh,
pub(crate) white_image: Image,
pub(crate) instance_bind_layout: wgpu::BindGroupLayout,
Expand Down Expand Up @@ -334,68 +334,28 @@ impl GraphicsContext {
},
);

let draw_shader = Arc::new(wgpu.device.create_shader_module(
wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(include_str!("shader/draw.wgsl").into()),
},
));
let load_shader = |source: &str| {
wgpu.device
.create_shader_module(wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(source.into()),
})
};

#[cfg(feature = "3d")]
let draw_shader_3d = Arc::new(wgpu.device.create_shader_module(
wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(include_str!("shader/draw3d.wgsl").into()),
},
));
let draw_shader = load_shader(include_str!("shader/draw.wgsl"));

#[cfg(feature = "3d")]
let instance_shader_3d = Arc::new(wgpu.device.create_shader_module(
wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(include_str!("shader/instance3d.wgsl").into()),
},
));

let draw_shader_3d = load_shader(include_str!("shader/draw3d.wgsl"));
#[cfg(feature = "3d")]
let instance_unordered_shader_3d = Arc::new(wgpu.device.create_shader_module(
wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(
include_str!("shader/instance_unordered3d.wgsl").into(),
),
},
));

let instance_shader = Arc::new(wgpu.device.create_shader_module(
wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(include_str!("shader/instance.wgsl").into()),
},
));

let instance_unordered_shader = Arc::new(wgpu.device.create_shader_module(
wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(
include_str!("shader/instance_unordered.wgsl").into(),
),
},
));

let text_shader = Arc::new(wgpu.device.create_shader_module(
wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(include_str!("shader/text.wgsl").into()),
},
));
let instance_shader_3d = load_shader(include_str!("shader/instance3d.wgsl"));
#[cfg(feature = "3d")]
let instance_unordered_shader_3d =
load_shader(include_str!("shader/instance_unordered3d.wgsl"));

let copy_shader = Arc::new(wgpu.device.create_shader_module(
wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(include_str!("shader/copy.wgsl").into()),
},
));
let instance_shader = load_shader(include_str!("shader/instance.wgsl"));
let instance_unordered_shader = load_shader(include_str!("shader/instance_unordered.wgsl"));
let text_shader = load_shader(include_str!("shader/text.wgsl"));
let copy_shader = load_shader(include_str!("shader/copy.wgsl"));

let rect_mesh = Mesh::from_data_wgpu(
&wgpu,
Expand Down Expand Up @@ -726,7 +686,7 @@ impl GraphicsContext {

let (bind, layout) = self.bind_group(fcx.present.view, sampler.clone());

let layout = self.pipeline_cache.layout(&self.wgpu.device, &[layout]);
let layout = self.pipeline_cache.layout(&self.wgpu.device, &[&layout]);
let copy = self.pipeline_cache.render_pipeline(
&self.wgpu.device,
RenderPipelineInfo {
Expand Down
15 changes: 6 additions & 9 deletions src/graphics/gpu/pipeline.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
use std::{
collections::{hash_map::DefaultHasher, HashMap},
sync::Arc,
};
use std::collections::{hash_map::DefaultHasher, HashMap};

/// Hashable representation of a render pipeline, used as a key in the HashMap cache.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RenderPipelineInfo {
pub layout: wgpu::PipelineLayout,
pub vs: Arc<wgpu::ShaderModule>,
pub fs: Arc<wgpu::ShaderModule>,
pub vs: wgpu::ShaderModule,
pub fs: wgpu::ShaderModule,
pub vs_entry: String,
pub fs_entry: String,
pub samples: u32,
Expand Down Expand Up @@ -96,12 +93,12 @@ impl PipelineCache {
pub fn layout(
&mut self,
device: &wgpu::Device,
bind_groups: &[wgpu::BindGroupLayout],
bind_group_layouts: &[&wgpu::BindGroupLayout],
) -> wgpu::PipelineLayout {
let key = {
use std::hash::{Hash, Hasher};
let mut h = DefaultHasher::new();
for bg in bind_groups {
for bg in bind_group_layouts {
bg.hash(&mut h);
}
h.finish()
Expand All @@ -111,7 +108,7 @@ impl PipelineCache {
.or_insert_with(|| {
device.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor {
label: None,
bind_group_layouts: &bind_groups.iter().collect::<Vec<_>>(),
bind_group_layouts,
push_constant_ranges: &[],
})
})
Expand Down
28 changes: 14 additions & 14 deletions src/graphics/internal_canvas.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use super::{
use crate::{GameError, GameResult};
use crevice::std140::AsStd140;
use glam::{Mat4, Vec2, Vec4};
use std::{collections::HashMap, hash::Hash, sync::Arc};
use std::{collections::HashMap, hash::Hash};

/// A canvas represents a render pass and is how you render primitives such as meshes and text onto images.
#[allow(missing_debug_implementations)]
Expand Down Expand Up @@ -44,10 +44,10 @@ pub struct InternalCanvas<'a> {
format: wgpu::TextureFormat,
text_uniforms: ArenaAllocation,

draw_sm: Arc<wgpu::ShaderModule>,
instance_sm: Arc<wgpu::ShaderModule>,
instance_unordered_sm: Arc<wgpu::ShaderModule>,
text_sm: Arc<wgpu::ShaderModule>,
draw_sm: &'a wgpu::ShaderModule,
instance_sm: &'a wgpu::ShaderModule,
instance_unordered_sm: &'a wgpu::ShaderModule,
text_sm: &'a wgpu::ShaderModule,

transform: glam::Mat4,
curr_image: Option<wgpu::TextureView>,
Expand Down Expand Up @@ -216,10 +216,10 @@ impl<'a> InternalCanvas<'a> {
format,
text_uniforms,

draw_sm: gfx.draw_shader.clone(),
instance_sm: gfx.instance_shader.clone(),
instance_unordered_sm: gfx.instance_unordered_shader.clone(),
text_sm: gfx.text_shader.clone(),
draw_sm: &gfx.draw_shader,
instance_sm: &gfx.instance_shader,
instance_unordered_sm: &gfx.instance_unordered_shader,
text_sm: &gfx.text_shader,

transform,
curr_image: None,
Expand Down Expand Up @@ -552,13 +552,13 @@ impl<'a> InternalCanvas<'a> {
let (dummy_group, dummy_layout) =
BindGroupBuilder::new().create(&self.wgpu.device, self.bind_group_cache);

let mut groups = vec![uniform_layout, texture_layout];
let mut groups = vec![&uniform_layout, &texture_layout];

if let ShaderType::Instance { .. } = ty {
groups.push(instance_layout);
groups.push(&instance_layout);
} else {
// the dummy group ensures the user's bind group is at index 3
groups.push(dummy_layout);
groups.push(&dummy_layout);
self.pass
.set_bind_group(2, &*self.arenas.bind_groups.alloc(dummy_group), &[]);
}
Expand All @@ -569,7 +569,7 @@ impl<'a> InternalCanvas<'a> {
self.shader_bind_group
{
self.pass.set_bind_group(3, bind_group, &[offset]);
groups.push(bind_group_layout.clone());
groups.push(bind_group_layout);
}

&self.shader
Expand All @@ -579,7 +579,7 @@ impl<'a> InternalCanvas<'a> {
self.text_shader_bind_group
{
self.pass.set_bind_group(3, bind_group, &[offset]);
groups.push(bind_group_layout.clone());
groups.push(bind_group_layout);
}

&self.text_shader
Expand Down
22 changes: 11 additions & 11 deletions src/graphics/internal_canvas3d.rs
View file
Open in desktop
10000
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use super::{
use crate::{GameError, GameResult};
use crevice::std140::AsStd140;
use glam::{Mat4, Vec4};
use std::{hash::Hash, sync::Arc};
use std::hash::Hash;

/// A canvas represents a render pass and is how you render meshes .
#[allow(missing_debug_implementations)]
Expand All @@ -38,9 +38,9 @@ pub struct InternalCanvas3d<'a> {
samples: u32,
format: wgpu::TextureFormat,

draw_sm: Arc<wgpu::ShaderModule>,
instance_sm: Arc<wgpu::ShaderModule>,
instance_unordered_sm: Arc<wgpu::ShaderModule>,
draw_sm: &'a wgpu::ShaderModule,
instance_sm: &'a wgpu::ShaderModule,
instance_unordered_sm: &'a wgpu::ShaderModule,

transform: glam::Mat4,
curr_image: Option<wgpu::TextureView>,
Expand Down Expand Up @@ -204,9 +204,9 @@ impl<'a> InternalCanvas3d<'a> {
samples,
format,

draw_sm: gfx.draw_shader_3d.clone(),
instance_sm: gfx.instance_shader_3d.clone(),
instance_unordered_sm: gfx.instance_unordered_shader_3d.clone(),
draw_sm: &gfx.draw_shader_3d,
instance_sm: &gfx.instance_shader_3d,
instance_unordered_sm: &gfx.instance_unordered_shader_3d,

transform,
curr_image: None,
Expand Down Expand Up @@ -429,13 +429,13 @@ impl<'a> InternalCanvas3d<'a> {
let (dummy_group, dummy_layout) =
BindGroupBuilder::new().create(&self.wgpu.device, self.bind_group_cache);

let mut groups = vec![uniform_layout, texture_layout];
let mut groups = vec![&uniform_layout, &texture_layout];

if let ShaderType3d::Instance { .. } = ty {
groups.push(instance_layout);
groups.push(&instance_layout);
} else {
// the dummy group ensures the user's bind group is at index 3
groups.push(dummy_layout);
groups.push(&dummy_layout);
self.pass
.set_bind_group(2, &*self.arenas.bind_groups.alloc(dummy_group), &[]);
}
Expand All @@ -446,7 +446,7 @@ impl<'a> InternalCanvas3d<'a> {
self.shader_bind_group
{
self.pass.set_bind_group(3, bind_group, &[offset]);
groups.push(bind_group_layout.clone());
groups.push(bind_group_layout);
}

&self.shader
Expand Down
25 changes: 13 additions & 12 deletions src/graphics/shader.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
use std::marker::PhantomData;
use std::{io::Read, sync::Arc};
use std::{io::Read, marker::PhantomData};

use crate::{context::Has, Context, GameError, GameResult};

Expand Down Expand Up @@ -89,21 +88,23 @@ impl<'a> ShaderBuilder<'a> {
pub fn build(self, gfx: &impl Has<GraphicsContext>) -> GameResult<Shader> {
let gfx = gfx.retrieve();
let load = |s: &str| {
Some(Arc::new(gfx.wgpu.device.create_shader_module(
wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(s.into()),
},
)))
Some(
gfx.wgpu
.device
.create_shader_module(wgpu::ShaderModuleDescriptor {
label: None,
source: wgpu::ShaderSource::Wgsl(s.into()),
}),
)
};
let load_resource = |path: &str| -> GameResult<Option<Arc<wgpu::ShaderModule>>> {
let load_resource = |path: &str| -> GameResult<Option<wgpu::ShaderModule>> {
let mut encoded = Vec::new();
_ = gfx.fs.open(path)?.read_to_end(&mut encoded)?;
Ok(load(
&String::from_utf8(encoded).map_err(GameError::ShaderEncodingError)?,
))
};
let load_any = |source| -> GameResult<Option<Arc<wgpu::ShaderModule>>> {
let load_any = |source| -> GameResult<Option<wgpu::ShaderModule>> {
Ok(match source {
ShaderSource::Code(source) => load(source),
ShaderSource::Path(source) => load_resource(source)?,
Expand Down Expand Up @@ -185,8 +186,8 @@ impl Default for ShaderBuilder<'_> {
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Shader {
pub(crate) vs_module: Option<Arc<wgpu::ShaderModule>>,
pub(crate) fs_module: Option<Arc<wgpu::ShaderModule>>,
pub(crate) vs_module: Option<wgpu::ShaderModule>,
pub(crate) fs_module: Option<wgpu::ShaderModule>,
}

impl Shader {
Expand Down
Loading
0