Skip to content

[Merged by Bors] - Added buffer usage field to buffers #7423

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

Closed
wants to merge 8 commits into from
Closed

[Merged by Bors] - Added buffer usage field to buffers #7423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
24152f5
Added buffer usage field to buffers
SpeedRoll Jan 30, 2023
ce3ae64
Change label_changed to changed and update changed when set_usage is …
SpeedRoll Jan 30, 2023
7755ef4
Added doc comments and added UNIFORM and STORAGE flags in write_buffer
SpeedRoll Feb 4, 2023
324d8e9
Revert previous change and added more doc comments
SpeedRoll Feb 6, 2023
f36d20b
fix ci
SpeedRoll Feb 6, 2023
8fae902
change set_usage to add_usages
SpeedRoll Feb 6, 2023
14f3c5c
doc comment changes
SpeedRoll Feb 6, 2023
6710376
doc comment changes
SpeedRoll Feb 6, 2023
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
51 changes: 38 additions & 13 deletions crates/bevy_render/src/render_resource/storage_buffer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ pub struct StorageBuffer<T: ShaderType> {
buffer: Option<Buffer>,
capacity: usize,
label: Option<String>,
label_changed: bool,
changed: bool,
buffer_usage: BufferUsages,
}

impl<T: ShaderType> From<T> for StorageBuffer<T> {
Expand All @@ -44,7 +45,8 @@ impl<T: ShaderType> From<T> for StorageBuffer<T> {
buffer: None,
capacity: 0,
label: None,
label_changed: false,
changed: false,
buffer_usage: BufferUsages::COPY_DST | BufferUsages::STORAGE,
}
}
}
Expand All @@ -57,7 +59,8 @@ impl<T: ShaderType + Default> Default for StorageBuffer<T> {
buffer: None,
capacity: 0,
label: None,
label_changed: false,
changed: false,
buffer_usage: BufferUsages::COPY_DST | BufferUsages::STORAGE,
}
}
}
Expand Down Expand Up @@ -91,7 +94,7 @@ impl<T: ShaderType + WriteInto> StorageBuffer<T> {
let label = label.map(str::to_string);

if label != self.label {
self.label_changed = true;
self.changed = true;
}

self.label = label;
Expand All @@ -101,6 +104,16 @@ impl<T: ShaderType + WriteInto> StorageBuffer<T> {
self.label.as_deref()
}

/// Add more [`BufferUsages`] to the buffer.
///
/// This method only allows addition of flags to the default usage flags.
///
/// The default values for buffer usage are `BufferUsages::COPY_DST` and `BufferUsages::STORAGE`.
pub fn add_usages(&mut self, usage: BufferUsages) {
self.buffer_usage |= usage;
self.changed = true;
}

/// Queues writing of data from system RAM to VRAM using the [`RenderDevice`](crate::renderer::RenderDevice)
/// and the provided [`RenderQueue`](crate::renderer::RenderQueue).
///
Expand All @@ -111,14 +124,14 @@ impl<T: ShaderType + WriteInto> StorageBuffer<T> {

let size = self.scratch.as_ref().len();

if self.capacity < size || self.label_changed {
if self.capacity < size || self.changed {
self.buffer = Some(device.create_buffer_with_data(&BufferInitDescriptor {
label: self.label.as_deref(),
usage: BufferUsages::COPY_DST | BufferUsages::STORAGE,
usage: self.buffer_usage,
contents: self.scratch.as_ref(),
}));
self.capacity = size;
self.label_changed = false;
self.changed = false;
} else if let Some(buffer) = &self.buffer {
queue.write_buffer(buffer, 0, self.scratch.as_ref());
}
Expand Down Expand Up @@ -152,7 +165,8 @@ pub struct DynamicStorageBuffer<T: ShaderType> {
buffer: Option<Buffer>,
capacity: usize,
label: Option<String>,
label_changed: bool,
changed: bool,
buffer_usage: BufferUsages,
}

impl<T: ShaderType> Default for DynamicStorageBuffer<T> {
Expand All @@ -163,7 +177,8 @@ impl<T: ShaderType> Default for DynamicStorageBuffer<T> {
buffer: None,
capacity: 0,
label: None,
label_changed: false,
changed: false,
buffer_usage: BufferUsages::COPY_DST | BufferUsages::STORAGE,
}
}
}
Expand Down Expand Up @@ -204,7 +219,7 @@ impl<T: ShaderType + WriteInto> DynamicStorageBuffer<T> {
let label = label.map(str::to_string);

if label != self.label {
self.label_changed = true;
self.changed = true;
}

self.label = label;
Expand All @@ -214,18 +229,28 @@ impl<T: ShaderType + WriteInto> DynamicStorageBuffer<T> {
self.label.as_deref()
}

/// Add more [`BufferUsages`] to the buffer.
///
/// This method only allows addition of flags to the default usage flags.
///
/// The default values for buffer usage are `BufferUsages::COPY_DST` and `BufferUsages::STORAGE`.
pub fn add_usages(&mut self, usage: BufferUsages) {
self.buffer_usage |= usage;
self.changed = true;
}

#[inline]
pub fn write_buffer(&mut self, device: &RenderDevice, queue: &RenderQueue) {
let size = self.scratch.as_ref().len();

if self.capacity < size || self.label_changed {
if self.capacity < size || self.changed {
self.buffer = Some(device.create_buffer_with_data(&BufferInitDescriptor {
label: self.label.as_deref(),
usage: BufferUsages::COPY_DST | BufferUsages::STORAGE,
usage: self.buffer_usage,
contents: self.scratch.as_ref(),
}));
self.capacity = size;
self.label_changed = false;
self.changed = false;
} else if let Some(buffer) = &self.buffer {
queue.write_buffer(buffer, 0, self.scratch.as_ref());
}
Expand Down
51 changes: 38 additions & 13 deletions crates/bevy_render/src/render_resource/uniform_buffer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ pub struct UniformBuffer<T: ShaderType> {
scratch: UniformBufferWrapper<Vec<u8>>,
buffer: Option<Buffer>,
label: Option<String>,
label_changed: bool,
changed: bool,
buffer_usage: BufferUsages,
}

impl<T: ShaderType> From<T> for UniformBuffer<T> {
Expand All @@ -42,7 +43,8 @@ impl<T: ShaderType> From<T> for UniformBuffer<T> {
scratch: UniformBufferWrapper::new(Vec::new()),
buffer: None,
label: None,
label_changed: false,
changed: false,
buffer_usage: BufferUsages::COPY_DST | BufferUsages::UNIFORM,
}
}
}
Expand All @@ -54,7 +56,8 @@ impl<T: ShaderType + Default> Default for UniformBuffer<T> {
scratch: UniformBufferWrapper::new(Vec::new()),
buffer: None,
label: None,
label_changed: false,
changed: false,
buffer_usage: BufferUsages::COPY_DST | BufferUsages::UNIFORM,
}
}
}
Expand Down Expand Up @@ -89,7 +92,7 @@ impl<T: ShaderType + WriteInto> UniformBuffer<T> {
let label = label.map(str::to_string);

if label != self.label {
self.label_changed = true;
self.changed = true;
}

self.label = label;
Expand All @@ -99,6 +102,16 @@ impl<T: ShaderType + WriteInto> UniformBuffer<T> {
self.label.as_deref()
}

/// Add more [`BufferUsages`] to the buffer.
///
/// This method only allows addition of flags to the default usage flags.
///
/// The default values for buffer usage are `BufferUsages::COPY_DST` and `BufferUsages::UNIFORM`.
pub fn add_usages(&mut self, usage: BufferUsages) {
self.buffer_usage |= usage;
self.changed = true;
}

/// Queues writing of data from system RAM to VRAM using the [`RenderDevice`](crate::renderer::RenderDevice)
/// and the provided [`RenderQueue`](crate::renderer::RenderQueue), if a GPU-side backing buffer already exists.
///
Expand All @@ -107,13 +120,13 @@ impl<T: ShaderType + WriteInto> UniformBuffer<T> {
pub fn write_buffer(&mut self, device: &RenderDevice, queue: &RenderQueue) {
self.scratch.write(&self.value).unwrap();

if self.label_changed || self.buffer.is_none() {
if self.changed || self.buffer.is_none() {
self.buffer = Some(device.create_buffer_with_data(&BufferInitDescriptor {
label: self.label.as_deref(),
usage: BufferUsages::COPY_DST | BufferUsages::UNIFORM,
usage: self.buffer_usage,
contents: self.scratch.as_ref(),
}));
self.label_changed = false;
self.changed = false;
} else if let Some(buffer) = &self.buffer {
queue.write_buffer(buffer, 0, self.scratch.as_ref());
}
Expand Down Expand Up @@ -145,7 +158,8 @@ pub struct DynamicUniformBuffer<T: ShaderType> {
buffer: Option<Buffer>,
capacity: usize,
label: Option<String>,
label_changed: bool,
changed: bool,
buffer_usage: BufferUsages,
}

impl<T: ShaderType> Default for DynamicUniformBuffer<T> {
Expand All @@ -156,7 +170,8 @@ impl<T: ShaderType> Default for DynamicUniformBuffer<T> {
buffer: None,
capacity: 0,
label: None,
label_changed: false,
changed: false,
buffer_usage: BufferUsages::COPY_DST | BufferUsages::UNIFORM,
}
}
}
Expand Down Expand Up @@ -198,7 +213,7 @@ impl<T: ShaderType + WriteInto> DynamicUniformBuffer<T> {
let label = label.map(str::to_string);

if label != self.label {
self.label_changed = true;
self.changed = true;
}

self.label = label;
Expand All @@ -208,6 +223,16 @@ impl<T: ShaderType + WriteInto> DynamicUniformBuffer<T> {
self.label.as_deref()
}

/// Add more [`BufferUsages`] to the buffer.
///
/// This method only allows addition of flags to the default usage flags.
///
/// The default values for buffer usage are `BufferUsages::COPY_DST` and `BufferUsages::UNIFORM`.
pub fn add_usages(&mut self, usage: BufferUsages) {
self.buffer_usage |= usage;
self.changed = true;
}

/// Queues writing of data from system RAM to VRAM using the [`RenderDevice`](crate::renderer::RenderDevice)
/// and the provided [`RenderQueue`](crate::renderer::RenderQueue).
///
Expand All @@ -217,14 +242,14 @@ impl<T: ShaderType + WriteInto> DynamicUniformBuffer<T> {
pub fn write_buffer(&mut self, device: &RenderDevice, queue: &RenderQueue) {
let size = self.scratch.as_ref().len();

if self.capacity < size || self.label_changed {
if self.capacity < size || self.changed {
self.buffer = Some(device.create_buffer_with_data(&BufferInitDescriptor {
label: self.label.as_deref(),
usage: BufferUsages::COPY_DST | BufferUsages::UNIFORM,
usage: self.buffer_usage,
contents: self.scratch.as_ref(),
}));
self.capacity = size;
self.label_changed = false;
self.changed = false;
} else if let Some(buffer) = &self.buffer {
queue.write_buffer(buffer, 0, self.scratch.as_ref());
}
Expand Down