Enum ShaderResourceKind

pub enum ShaderResourceKind {
    Texture {
        kind: SamplerKind,
        fallback: SamplerFallback,
    },
    PropertyGroup(Vec<ShaderProperty>),
}

Shader property with default value.

Variants

Texture

A texture.

Fields

kind: SamplerKind

Kind of the texture.

fallback: SamplerFallback

Fallback value.

Sometimes you don’t want to set a value to a texture binding, or you even don’t have the appropriate one. There is fallback value that helps you with such situations, it defines a set of values that will be fetched from a texture binding point when there is no actual texture.

For example, standard shader has a lot of samplers defined: diffuse, normal, height, emission, mask, metallic, roughness, etc. In some situations you may not have all the textures, you have only diffuse texture, to keep rendering correct, each other property has appropriate fallback value. Normal sampler - a normal vector pointing up (+Y), height - zero, emission - zero, etc.

Fallback value is also helpful to catch missing textures, you’ll definitely know the texture is missing by very specific value in the fallback texture.

PropertyGroup(Vec<ShaderProperty>)

Implementations

impl ShaderResourceKind

pub const TEXTURE_KIND: &'static str = "Texture@kind"

pub const TEXTURE_FALLBACK: &'static str = "Texture@fallback"

pub const PROPERTY_GROUP_F_0: &'static str = "PropertyGroup@0"

Trait Implementations

impl Debug for ShaderResourceKind

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

Formats the value using the given formatter.

impl Default for ShaderResourceKind

fn default() -> ShaderResourceKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShaderResourceKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ShaderResourceKind

fn eq(&self, other: &ShaderResourceKind) -> 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 ShaderResourceKind

where ShaderResourceKind: 'static, SamplerKind: Reflect, SamplerFallback: Reflect, Vec<ShaderProperty>: 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<ShaderResourceKind>) -> 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 fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

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

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 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 Serialize for ShaderResourceKind

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 Visit for ShaderResourceKind

where SamplerKind: Visit, SamplerFallback: Visit, Vec<ShaderProperty>: Visit,

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 ShaderResourceKind