Struct bevy_render::render_resource::DynamicUniformBuffer
source · [−]pub struct DynamicUniformBuffer<T: ShaderType> { /* private fields */ }
Expand description
Stores data to be transferred to the GPU and made accessible to shaders as a dynamic uniform buffer.
Dynamic uniform buffers are available to shaders on a read-only basis. Dynamic uniform buffers are commonly used to make available to shaders runtime-sized arrays of parameters that are otherwise constant during shader execution, and are best suited to data that is relatively small in size as they are only guaranteed to support up to 16kB per binding.
The contained data is stored in system RAM. write_buffer
queues
copying of the data from system RAM to VRAM. Data in uniform buffers must follow std140 alignment/padding requirements,
which is automatically enforced by this structure. Per the WGPU spec, uniform buffers cannot store runtime-sized array
(vectors), or structures with fields that are vectors.
Other options for storing GPU-accessible data are:
Implementations
sourceimpl<T: ShaderType + WriteInto> DynamicUniformBuffer<T>
impl<T: ShaderType + WriteInto> DynamicUniformBuffer<T>
pub fn buffer(&self) -> Option<&Buffer>
pub fn binding(&self) -> Option<BindingResource<'_>>
pub fn len(&self) -> usize
pub fn is_empty(&self) -> bool
sourcepub fn push(&mut self, value: T) -> u32
pub fn push(&mut self, value: T) -> u32
Push data into the DynamicUniformBuffer
’s internal vector (residing on system RAM).
pub fn set_label(&mut self, label: Option<&str>)
pub fn get_label(&self) -> Option<&str>
sourcepub fn write_buffer(&mut self, device: &RenderDevice, queue: &RenderQueue)
pub fn write_buffer(&mut self, device: &RenderDevice, queue: &RenderQueue)
Queues writing of data from system RAM to VRAM using the RenderDevice
and the provided RenderQueue
.
If there is no GPU-side buffer allocated to hold the data currently stored, or if a GPU-side buffer previously allocated does not have enough capacity, a new GPU-side buffer is created.
pub fn clear(&mut self)
Trait Implementations
sourceimpl<T: ShaderType> Default for DynamicUniformBuffer<T>
impl<T: ShaderType> Default for DynamicUniformBuffer<T>
Auto Trait Implementations
impl<T> !RefUnwindSafe for DynamicUniformBuffer<T>
impl<T> Send for DynamicUniformBuffer<T> where
T: Send,
impl<T> Sync for DynamicUniformBuffer<T> where
T: Sync,
impl<T> Unpin for DynamicUniformBuffer<T> where
T: Unpin,
impl<T> !UnwindSafe for DynamicUniformBuffer<T>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
sourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
sourceimpl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
sourcefn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more