Struct MaterialPropertyGroup

pub struct MaterialPropertyGroup { /* private fields */ }

Property group stores a bunch of named values of a fixed set of types, that will be used for rendering with some shader.

Implementations

impl MaterialPropertyGroup

pub const PROPERTIES: &'static str = "properties"

impl MaterialPropertyGroup

pub fn property_ref( &self, name: impl Into<ImmutableString>, ) -> Option<&MaterialProperty>

Searches for a property with given name.

Complexity

O(1)

Examples

let mut group = MaterialPropertyGroup::default();
let color = group.property_ref("diffuseColor").unwrap().as_color();

pub fn property_mut( &mut self, name: impl Into<ImmutableString>, ) -> Option<&mut MaterialProperty>

Searches for a property with given name.

Complexity

O(1)

Examples

let mut group = MaterialPropertyGroup::default();
*group.property_mut("diffuseColor").unwrap() = MaterialProperty::Color(Color::RED);

pub fn set_property( &mut self, name: impl Into<ImmutableString>, new_value: impl Into<MaterialProperty>, )

Sets new value of the property with given name.

Type checking

This method does not check if the property exists in the shader nor its type. Validation happens in the renderer, when it tries to use the property group. This is made for performance reasons.

Example

let mut group = MaterialPropertyGroup::default();
group.set_property("diffuseColor", Color::WHITE);

pub fn unset_property( &mut self, name: impl Into<ImmutableString>, ) -> Option<MaterialProperty>

Removes the property from the group. The renderer will use shader defaults for this property.

pub fn properties(&self) -> &FxHashMap<ImmutableString, MaterialProperty>

Returns immutable reference to internal property storage.

Trait Implementations

impl Clone for MaterialPropertyGroup

fn clone(&self) -> MaterialPropertyGroup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaterialPropertyGroup

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

Formats the value using the given formatter.

impl Default for MaterialPropertyGroup

fn default() -> MaterialPropertyGroup

Returns the “default value” for a type.

impl Reflect for MaterialPropertyGroup

where Self: 'static, FxHashMap<ImmutableString, MaterialProperty>: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

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

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

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn fields(&self, func: &mut dyn FnMut(&[&dyn Reflect]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [&mut dyn Reflect]))

fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>))

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut dyn Reflect>), )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl Visit for MaterialPropertyGroup

where FxHashMap<ImmutableString, MaterialProperty>: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

Read or write this value, depending on whether Visitor::is_reading() is true or false.