Struct ShaderStorageBuffer 

pub struct ShaderStorageBuffer {
    pub data: Option<Vec<u8>>,
    pub buffer_description: BufferDescriptor<Option<&'static str>>,
    pub asset_usage: RenderAssetUsages,
}

A storage buffer that is prepared as a RenderAsset and uploaded to the GPU.

Fields

data: Option<Vec<u8>>

Optional data used to initialize the buffer.

buffer_description: BufferDescriptor<Option<&'static str>>

The buffer description used to create the buffer.

asset_usage: RenderAssetUsages

The asset usage of the storage buffer.

Implementations

impl ShaderStorageBuffer

pub fn new(data: &[u8], asset_usage: RenderAssetUsages) -> ShaderStorageBuffer

Creates a new storage buffer with the given data and asset usage.

pub fn with_size( size: usize, asset_usage: RenderAssetUsages, ) -> ShaderStorageBuffer

Creates a new storage buffer with the given size and asset usage.

pub fn set_data<T>(&mut self, value: T)

where T: ShaderType + WriteInto,

Sets the data of the storage buffer to the given ShaderType.

Examples found in repository

examples/shader/storage_buffer.rs (lines 77-89)

fn update(
    time: Res<Time>,
    material_handles: Res<CustomMaterialHandle>,
    mut materials: ResMut<Assets<CustomMaterial>>,
    mut buffers: ResMut<Assets<ShaderStorageBuffer>>,
) {
    let material = materials.get_mut(&material_handles.0).unwrap();

    let buffer = buffers.get_mut(&material.colors).unwrap();
    buffer.set_data(
        (0..5)
            .map(|i| {
                let t = time.elapsed_secs() * 5.0;
                [
                    ops::sin(t + i as f32) / 2.0 + 0.5,
                    ops::sin(t + i as f32 + 2.0) / 2.0 + 0.5,
                    ops::sin(t + i as f32 + 4.0) / 2.0 + 0.5,
                    1.0,
                ]
            })
            .collect::<Vec<[f32; 4]>>(),
    );
}

Trait Implementations

impl Clone for ShaderStorageBuffer

fn clone(&self) -> ShaderStorageBuffer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShaderStorageBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ShaderStorageBuffer

fn default() -> ShaderStorageBuffer

Returns the “default value” for a type.

impl<T> From<T> for ShaderStorageBuffer

where T: ShaderType + WriteInto,

fn from(value: T) -> ShaderStorageBuffer

Converts to this type from the input type.

impl FromArg for ShaderStorageBuffer

type This<'from_arg> = ShaderStorageBuffer

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<ShaderStorageBuffer as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for ShaderStorageBuffer

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<ShaderStorageBuffer>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetOwnership for ShaderStorageBuffer

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for ShaderStorageBuffer

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(_registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoReturn for ShaderStorageBuffer

fn into_return<'into_return>(self) -> Return<'into_return>

where ShaderStorageBuffer: 'into_return,

Converts Self into a Return value.

impl PartialReflect for ShaderStorageBuffer

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<ShaderStorageBuffer>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<ShaderStorageBuffer>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect( self: Box<ShaderStorageBuffer>, ) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq( &self, _value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for ShaderStorageBuffer

fn into_any(self: Box<ShaderStorageBuffer>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<ShaderStorageBuffer>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl TypePath for ShaderStorageBuffer

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ShaderStorageBuffer

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl VisitAssetDependencies for ShaderStorageBuffer

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))

impl Asset for ShaderStorageBuffer