Struct ShaderProperty 

pub struct ShaderProperty {
    pub name: ImmutableString,
    pub kind: ShaderPropertyKind,
}

A uniform value that is supplied to a shader by a material.

Fields

name: ImmutableString

The name of the value in the shader and when editing the value in the material.

kind: ShaderPropertyKind

The property’s data type and default value.

Implementations

impl ShaderProperty

pub const NAME: &'static str = "name"

pub const KIND: &'static str = "kind"

impl ShaderProperty

pub fn new( name: impl Into<ImmutableString>, kind: ShaderPropertyKind, ) -> ShaderProperty

Create a property with the given name and value.

pub fn new_matrix2(name: impl Into<ImmutableString>) -> ShaderProperty

Create a property with the 2x2 identity matrix as its value.

pub fn new_matrix3(name: impl Into<ImmutableString>) -> ShaderProperty

Create a property with the 3x3 identity matrix as its value.

pub fn new_matrix4(name: impl Into<ImmutableString>) -> ShaderProperty

Create a property with the 4x4 identity matrix as its value.

pub fn new_vector2(name: impl Into<ImmutableString>) -> ShaderProperty

Create a property with the vector (0,0) as its value.

pub fn new_vector3(name: impl Into<ImmutableString>) -> ShaderProperty

Create a property with the vector (0,0,0) as its value.

pub fn new_vector4(name: impl Into<ImmutableString>) -> ShaderProperty

Create a property with the vector (0,0,0,0) as its value.

pub fn new_float(name: impl Into<ImmutableString>) -> ShaderProperty

Create a property with the float 0.0 as its value.

pub fn new_bool(name: impl Into<ImmutableString>) -> ShaderProperty

Create a property with false as its value.

pub fn new_int(name: impl Into<ImmutableString>) -> ShaderProperty

Create a property with the integer 0 as its value.

pub fn new_color(name: impl Into<ImmutableString>) -> ShaderProperty

Create a property with white as its value.

pub fn new_mat4_f32_array( name: impl Into<ImmutableString>, max_len: usize, ) -> ShaderProperty

Create a property with an empty list of 4x4 matrices and the given maximum length for the list.

pub fn new_f32_array( name: impl Into<ImmutableString>, max_len: usize, ) -> ShaderProperty

Create a property with an empty list of floats and the given maximum length for the list.

pub fn new_vec4_f32_array( name: impl Into<ImmutableString>, max_len: usize, ) -> ShaderProperty

Create a property with an empty list of vectors and the given maximum length for the list.

pub fn new_vec3_f32_array( name: impl Into<ImmutableString>, max_len: usize, ) -> ShaderProperty

Create a property with an empty list of vectors and the given maximum length for the list.

pub fn new_vec2_f32_array( name: impl Into<ImmutableString>, max_len: usize, ) -> ShaderProperty

Create a property with an empty list of vectors and the given maximum length for the list.

Trait Implementations

impl Clone for ShaderProperty

fn clone(&self) -> ShaderProperty

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShaderProperty

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

Formats the value using the given formatter.

impl Default for ShaderProperty

fn default() -> ShaderProperty

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShaderProperty

fn deserialize<__D>( __deserializer: __D, ) -> Result<ShaderProperty, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ShaderProperty

fn eq(&self, other: &ShaderProperty) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for ShaderProperty

where ShaderProperty: 'static,

fn source_path() -> &'static str

fn try_clone_box(&self) -> Option<Box<dyn Reflect>>

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

fn derived_types() -> &'static [TypeId]

fn query_derived_types(&self) -> &'static [TypeId]

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_ref(&self, func: &mut dyn FnMut(&[FieldRef<'_, '_>]))

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

fn into_any(self: Box<ShaderProperty>) -> 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 + 'static)))

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

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

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

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

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

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

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

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)>), )

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

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

impl Serialize for ShaderProperty

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypeUuidProvider for ShaderProperty

fn type_uuid() -> Uuid

Return type UUID.

impl Visit for ShaderProperty

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

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

impl StructuralPartialEq for ShaderProperty