Struct ShaderBuffer 

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

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.

copy_on_resize: bool

Whether this buffer should be copied on the GPU when resized.

Implementations

impl ShaderBuffer

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

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

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

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.

pub fn resize(&mut self, size: u64)

Resizes the buffer to the new size.

If CPU data is present, it will be truncated or zero-extended. Does not preserve GPU data when the descriptor changes.

pub fn resize_in_place(&mut self, size: u64)

Resizes the buffer to the new size, preserving existing data.

If CPU data is present, it will be truncated or zero-extended. If no CPU data is present, sets copy_on_resize to preserve GPU data.

Trait Implementations

impl Asset for ShaderBuffer

impl Clone for ShaderBuffer

fn clone(&self) -> ShaderBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShaderBuffer

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

Formats the value using the given formatter.

impl Default for ShaderBuffer

fn default() -> ShaderBuffer

Returns the “default value” for a type.

impl<T> From<T> for ShaderBuffer

where T: ShaderType + WriteInto,

fn from(value: T) -> ShaderBuffer

Converts to this type from the input type.

impl FromReflect for ShaderBuffer

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

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 GetTypeRegistration for ShaderBuffer

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 PartialReflect for ShaderBuffer

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<ShaderBuffer>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<ShaderBuffer>, ) -> 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<ShaderBuffer>) -> 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 reflect_partial_cmp( &self, _value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for ShaderBuffer

fn into_any(self: Box<ShaderBuffer>) -> 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<ShaderBuffer>) -> 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 ShaderBuffer

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 ShaderBuffer

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl VisitAssetDependencies for ShaderBuffer

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