Skip to main content

PhysicalMaterial

Struct PhysicalMaterial 

Source
pub struct PhysicalMaterial {
    pub auto_sync_texture_to_uniforms: bool,
    /* private fields */
}

Fields§

§auto_sync_texture_to_uniforms: bool

Implementations§

Source§

impl PhysicalMaterial

Source

pub fn new(color: Vec4) -> PhysicalMaterial

Source

pub fn with_color(self, color: Vec4) -> PhysicalMaterial

Sets the base color (builder).

Source

pub fn with_roughness(self, roughness: f32) -> PhysicalMaterial

Sets the roughness factor (builder).

Source

pub fn with_metalness(self, metalness: f32) -> PhysicalMaterial

Sets the metalness factor (builder).

Source

pub fn with_emissive(self, color: Vec3, intensity: f32) -> PhysicalMaterial

Sets the emissive color and intensity (builder).

Source

pub fn with_opacity(self, opacity: f32) -> PhysicalMaterial

Sets the opacity (builder).

Source

pub fn with_normal_scale(self, scale: Vec2) -> PhysicalMaterial

Sets the normal map scale (builder).

Source

pub fn with_map(self, handle: TextureHandle) -> PhysicalMaterial

Sets the color map texture (builder).

Source

pub fn with_normal_map(self, handle: TextureHandle) -> PhysicalMaterial

Sets the normal map texture (builder).

Source

pub fn with_roughness_map(self, handle: TextureHandle) -> PhysicalMaterial

Sets the roughness map texture (builder).

Source

pub fn with_metalness_map(self, handle: TextureHandle) -> PhysicalMaterial

Sets the metalness map texture (builder).

Source

pub fn with_emissive_map(self, handle: TextureHandle) -> PhysicalMaterial

Sets the emissive map texture (builder).

Source

pub fn with_ao_map(self, handle: TextureHandle) -> PhysicalMaterial

Sets the AO map texture (builder).

Source

pub fn with_side(self, side: Side) -> PhysicalMaterial

Sets the face culling side (builder).

Source

pub fn with_alpha_mode(self, mode: AlphaMode) -> PhysicalMaterial

Sets the alpha mode (builder).

Source

pub fn with_depth_write(self, enabled: bool) -> PhysicalMaterial

Sets depth write (builder).

Source

pub fn disable_feature(&self, feature: PhysicalFeatures)

Source

pub fn enable_feature(&self, feature: PhysicalFeatures)

Source

pub fn with_clearcoat(self, factor: f32, roughness: f32) -> PhysicalMaterial

Source

pub fn with_sheen(self, color: Vec3, roughness: f32) -> PhysicalMaterial

Source

pub fn with_iridescence( self, intensity: f32, ior: f32, thickness_min: f32, thickness_max: f32, ) -> PhysicalMaterial

Source

pub fn with_anisotropy(self, anisotropy: f32, rotation: f32) -> PhysicalMaterial

Source

pub fn with_transmission( self, transmission: f32, thickness: f32, attenuation_distance: f32, attenuation_color: Vec3, ) -> PhysicalMaterial

Source

pub fn with_dispersion(self, dispersion: f32) -> PhysicalMaterial

Source

pub fn set_sss_id(&self, id: Option<FeatureId>)

Source

pub fn sss_id(&self) -> Option<FeatureId>

Source

pub fn set_ssr_id(&self, id: Option<FeatureId>)

Source

pub fn ssr_id(&self) -> Option<FeatureId>

Source

pub fn with_sss_id(self, id: FeatureId) -> PhysicalMaterial

Source

pub fn with_ssr_id(self, id: FeatureId) -> PhysicalMaterial

Source§

impl PhysicalMaterial

Source

pub fn settings_mut(&self) -> SettingsGuard<'_>

Source

pub fn settings(&self) -> MaterialSettings

Source

pub fn set_alpha_mode(&self, mode: AlphaMode)

Source

pub fn alpha_mode(&self) -> AlphaMode

Source

pub fn set_side(&self, side: Side)

Sets the face culling mode (Front/Back/Double).

Source

pub fn side(&self) -> Side

Source

pub fn set_depth_test(&self, depth_test: bool)

Enables or disables depth testing.

Source

pub fn depth_test(&self) -> bool

Source

pub fn set_depth_write(&self, depth_write: bool)

Enables or disables depth writing. For transparent objects, it’s usually recommended to disable this.

Source

pub fn depth_write(&self) -> bool

Source

pub fn uniforms_mut(&self) -> BufferGuard<'_, PhysicalUniforms>

Gets a mutable accessor for all Uniform parameters (for batch modifications). The Guard will automatically mark data as Dirty when it goes out of scope.

Source

pub fn uniforms(&self) -> BufferReadGuard<'_, PhysicalUniforms>

Gets a read-only accessor for all Uniform parameters.

Source

pub fn set_color(&self, value: Vec4)

Base color.

Source

pub fn color(&self) -> Vec4

Source

pub fn set_alpha_test(&self, value: f32)

Alpha test threshold.

Source

pub fn alpha_test(&self) -> f32

Source

pub fn set_roughness(&self, value: f32)

Roughness factor.

Source

pub fn roughness(&self) -> f32

Source

pub fn set_metalness(&self, value: f32)

Metalness factor.

Source

pub fn metalness(&self) -> f32

Source

pub fn set_opacity(&self, value: f32)

Opacity value.

Source

pub fn opacity(&self) -> f32

Source

pub fn set_emissive(&self, value: Vec3)

Emissive color.

Source

pub fn emissive(&self) -> Vec3

Source

pub fn set_emissive_intensity(&self, value: f32)

Emissive intensity.

Source

pub fn emissive_intensity(&self) -> f32

Source

pub fn set_normal_scale(&self, value: Vec2)

Normal map scale.

Source

pub fn normal_scale(&self) -> Vec2

Source

pub fn set_ao_map_intensity(&self, value: f32)

AO map intensity.

Source

pub fn ao_map_intensity(&self) -> f32

Source

pub fn set_ior(&self, value: f32)

Index of Refraction.

Source

pub fn ior(&self) -> f32

Source

pub fn set_specular_color(&self, value: Vec3)

Specular color.

Source

pub fn specular_color(&self) -> Vec3

Source

pub fn set_specular_intensity(&self, value: f32)

Specular intensity.

Source

pub fn specular_intensity(&self) -> f32

Source

pub fn set_clearcoat(&self, value: f32)

Clearcoat factor.

Source

pub fn clearcoat(&self) -> f32

Source

pub fn set_clearcoat_roughness(&self, value: f32)

Clearcoat roughness factor.

Source

pub fn clearcoat_roughness(&self) -> f32

Source

pub fn set_sheen_color(&self, value: Vec3)

The sheen tint. Default is (0, 0, 0), black.

Source

pub fn sheen_color(&self) -> Vec3

Source

pub fn set_sheen_roughness(&self, value: f32)

The sheen roughness. Default is 1.0.

Source

pub fn sheen_roughness(&self) -> f32

Source

pub fn set_iridescence(&self, value: f32)

The intensity of the iridescence layer, simulating RGB color shift based on the angle between the surface and the viewer.

Source

pub fn iridescence(&self) -> f32

Source

pub fn set_iridescence_ior(&self, value: f32)

The strength of the iridescence RGB color shift effect, represented by an index-of-refraction. Default is 1.3.

Source

pub fn iridescence_ior(&self) -> f32

Source

pub fn set_iridescence_thickness_min(&self, value: f32)

The minimum thickness of the thin-film layer given in nanometers. Default is 100 nm.

Source

pub fn iridescence_thickness_min(&self) -> f32

Source

pub fn set_iridescence_thickness_max(&self, value: f32)

The maximum thickness of the thin-film layer given in nanometers. Default is 400 nm.

Source

pub fn iridescence_thickness_max(&self) -> f32

Source

pub fn set_transmission(&self, value: f32)

The transmission factor controlling the amount of light that passes through the surface.

Source

pub fn transmission(&self) -> f32

Source

pub fn set_thickness(&self, value: f32)

The thickness of the object used for subsurface absorption.

Source

pub fn thickness(&self) -> f32

Source

pub fn set_attenuation_color(&self, value: Vec3)

The color that light is attenuated towards as it passes through the material.

Source

pub fn attenuation_color(&self) -> Vec3

Source

pub fn set_attenuation_distance(&self, value: f32)

The distance that light travels through the material before it is absorbed.

Source

pub fn attenuation_distance(&self) -> f32

Source

pub fn set_dispersion(&self, value: f32)

The amount of chromatic dispersion in the transmitted light.

Source

pub fn dispersion(&self) -> f32

Source

pub fn set_map(&self, value: Option<TextureHandle>)

The color map.

Source

pub fn map(&self) -> Option<TextureHandle>

Source

pub fn set_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_normal_map(&self, value: Option<TextureHandle>)

The normal map.

Source

pub fn normal_map(&self) -> Option<TextureHandle>

Source

pub fn set_normal_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_normal_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_roughness_map(&self, value: Option<TextureHandle>)

The roughness map.

Source

pub fn roughness_map(&self) -> Option<TextureHandle>

Source

pub fn set_roughness_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_roughness_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_metalness_map(&self, value: Option<TextureHandle>)

The metalness map.

Source

pub fn metalness_map(&self) -> Option<TextureHandle>

Source

pub fn set_metalness_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_metalness_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_ao_map(&self, value: Option<TextureHandle>)

The AO map.

Source

pub fn ao_map(&self) -> Option<TextureHandle>

Source

pub fn set_ao_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_ao_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_emissive_map(&self, value: Option<TextureHandle>)

The emissive map.

Source

pub fn emissive_map(&self) -> Option<TextureHandle>

Source

pub fn set_emissive_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_emissive_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_specular_map(&self, value: Option<TextureHandle>)

The specular map.

Source

pub fn specular_map(&self) -> Option<TextureHandle>

Source

pub fn set_specular_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_specular_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_specular_intensity_map(&self, value: Option<TextureHandle>)

The specular intensity map.

Source

pub fn specular_intensity_map(&self) -> Option<TextureHandle>

Source

pub fn set_specular_intensity_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_specular_intensity_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_clearcoat_map(&self, value: Option<TextureHandle>)

The clearcoat map.

Source

pub fn clearcoat_map(&self) -> Option<TextureHandle>

Source

pub fn set_clearcoat_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_clearcoat_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_clearcoat_roughness_map(&self, value: Option<TextureHandle>)

The clearcoat roughness map.

Source

pub fn clearcoat_roughness_map(&self) -> Option<TextureHandle>

Source

pub fn set_clearcoat_roughness_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_clearcoat_roughness_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_clearcoat_normal_map(&self, value: Option<TextureHandle>)

The clearcoat normal map.

Source

pub fn clearcoat_normal_map(&self) -> Option<TextureHandle>

Source

pub fn set_clearcoat_normal_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_clearcoat_normal_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_sheen_color_map(&self, value: Option<TextureHandle>)

The sheen color map.

Source

pub fn sheen_color_map(&self) -> Option<TextureHandle>

Source

pub fn set_sheen_color_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_sheen_color_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_sheen_roughness_map(&self, value: Option<TextureHandle>)

The sheen roughness map.

Source

pub fn sheen_roughness_map(&self) -> Option<TextureHandle>

Source

pub fn set_sheen_roughness_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_sheen_roughness_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_iridescence_map(&self, value: Option<TextureHandle>)

The iridescence map.

Source

pub fn iridescence_map(&self) -> Option<TextureHandle>

Source

pub fn set_iridescence_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_iridescence_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_iridescence_thickness_map(&self, value: Option<TextureHandle>)

The iridescence thickness map.

Source

pub fn iridescence_thickness_map(&self) -> Option<TextureHandle>

Source

pub fn set_iridescence_thickness_map_transform( &self, transform: TextureTransform, )

Source

pub fn configure_iridescence_thickness_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_anisotropy_map(&self, value: Option<TextureHandle>)

The anisotropy map.

Source

pub fn anisotropy_map(&self) -> Option<TextureHandle>

Source

pub fn set_anisotropy_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_anisotropy_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_transmission_map(&self, value: Option<TextureHandle>)

The transmission map.

Source

pub fn transmission_map(&self) -> Option<TextureHandle>

Source

pub fn set_transmission_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_transmission_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn set_thickness_map(&self, value: Option<TextureHandle>)

The thickness map.

Source

pub fn thickness_map(&self) -> Option<TextureHandle>

Source

pub fn set_thickness_map_transform(&self, transform: TextureTransform)

Source

pub fn configure_thickness_map<F>(&self, f: F)
where F: FnOnce(&mut TextureSlot),

Source

pub fn flush_texture_transforms(&self) -> bool

Flushes texture transform matrices to Uniforms. Only writes when values actually change, avoiding unnecessary version bumps. Returns whether any data was updated.

Source

pub fn configure<F>(&self, f: F)

Source

pub fn notify_pipeline_dirty(&self)

Manually notifies that the material pipeline needs to be rebuilt.

Note: In most cases, you don’t need to call this method manually, as modifying texture slots through the standard API will automatically track version changes. This method is only for the following special scenarios:

  • After directly modifying pub(crate) fields (e.g., in loader internal code)
  • When you’re certain the material configuration has changed but the version hasn’t been updated

Trait Implementations§

Source§

impl Clone for PhysicalMaterial

Source§

fn clone(&self) -> PhysicalMaterial

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PhysicalMaterial

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PhysicalMaterial

Source§

fn default() -> PhysicalMaterial

Returns the “default value” for a type. Read more
Source§

impl From<PhysicalMaterial> for Material

Source§

fn from(data: PhysicalMaterial) -> Material

Converts to this type from the input type.
Source§

impl MaterialTrait for PhysicalMaterial

Source§

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

Returns self as Any for downcasting.
Source§

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

Returns mutable self as Any for downcasting.
Source§

impl RenderableMaterialTrait for PhysicalMaterial

Source§

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

Returns the shader template name.
Source§

fn version(&self) -> u64

Returns the material version (used for cache invalidation).
Source§

fn settings(&self) -> MaterialSettings

Returns material rendering settings.
Source§

fn uniform_buffer(&self) -> BufferRef

Returns a reference to the uniform buffer.
Source§

fn with_uniform_bytes(&self, visitor: &mut dyn FnMut(&[u8]))

Provides uniform data bytes to the callback.
Source§

fn shader_defines(&self) -> ShaderDefines

Returns shader macro definitions based on current material state.
Source§

fn visit_textures(&self, visitor: &mut dyn FnMut(&TextureSource))

Visits all textures used by this material.
Source§

fn define_bindings<'a>(&'a self, builder: &mut ResourceBuilder<'a>)

Defines GPU resource bindings for this material.
Source§

fn extra_defines(&self, _defines: &mut ShaderDefines)

Source§

impl ResolveMaterial for PhysicalMaterial

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,