Struct StandardMaterial 

pub struct StandardMaterial {

    pub base_color: Color,
    pub base_color_channel: UvChannel,
    pub base_color_texture: Option<Handle<Image>>,
    pub emissive: LinearRgba,
    pub emissive_exposure_weight: f32,
    pub emissive_channel: UvChannel,
    pub emissive_texture: Option<Handle<Image>>,
    pub perceptual_roughness: f32,
    pub metallic: f32,
    pub metallic_roughness_channel: UvChannel,
    pub metallic_roughness_texture: Option<Handle<Image>>,
    pub reflectance: f32,
    pub specular_tint: Color,
    pub diffuse_transmission: f32,
    pub diffuse_transmission_channel: UvChannel,
    pub diffuse_transmission_texture: Option<Handle<Image>>,
    pub specular_transmission: f32,
    pub specular_transmission_channel: UvChannel,
    pub specular_transmission_texture: Option<Handle<Image>>,
    pub thickness: f32,
    pub thickness_channel: UvChannel,
    pub thickness_texture: Option<Handle<Image>>,
    pub ior: f32,
    pub attenuation_distance: f32,
    pub attenuation_color: Color,
    pub normal_map_channel: UvChannel,
    pub normal_map_texture: Option<Handle<Image>>,
    pub flip_normal_map_y: bool,
    pub occlusion_channel: UvChannel,
    pub occlusion_texture: Option<Handle<Image>>,
    pub specular_channel: UvChannel,
    pub specular_texture: Option<Handle<Image>>,
    pub specular_tint_channel: UvChannel,
    pub specular_tint_texture: Option<Handle<Image>>,
    pub clearcoat: f32,
    pub clearcoat_channel: UvChannel,
    pub clearcoat_texture: Option<Handle<Image>>,
    pub clearcoat_perceptual_roughness: f32,
    pub clearcoat_roughness_channel: UvChannel,
    pub clearcoat_roughness_texture: Option<Handle<Image>>,
    pub clearcoat_normal_channel: UvChannel,
    pub clearcoat_normal_texture: Option<Handle<Image>>,
    pub anisotropy_strength: f32,
    pub anisotropy_rotation: f32,
    pub anisotropy_channel: UvChannel,
    pub anisotropy_texture: Option<Handle<Image>>,
    pub double_sided: bool,
    pub cull_mode: Option<Face>,
    pub unlit: bool,
    pub fog_enabled: bool,
    pub alpha_mode: AlphaMode,
    pub depth_bias: f32,
    pub depth_map: Option<Handle<Image>>,
    pub parallax_depth_scale: f32,
    pub parallax_mapping_method: ParallaxMappingMethod,
    pub max_parallax_layer_count: f32,
    pub lightmap_exposure: f32,
    pub opaque_render_method: OpaqueRendererMethod,
    pub deferred_lighting_pass_id: u8,
    pub uv_transform: Affine2,
}

A material with “standard” properties used in PBR lighting. Standard property values with pictures here: https://google.github.io/filament/notes/material_properties.html.

May be created directly from a Color or an Image.

Fields

base_color: Color

The color of the surface of the material before lighting.

Doubles as diffuse albedo for non-metallic, specular for metallic and a mix for everything in between. If used together with a base_color_texture, this is factored into the final base color as base_color * base_color_texture_value.

Defaults to Color::WHITE.

base_color_channel: UvChannel

The UV channel to use for the StandardMaterial::base_color_texture.

Defaults to UvChannel::Uv0.

base_color_texture: Option<Handle<Image>>

The texture component of the material’s color before lighting. The actual pre-lighting color is base_color * this_texture.

See base_color for details.

You should set base_color to Color::WHITE (the default) if you want the texture to show as-is.

Setting base_color to something else than white will tint the texture. For example, setting base_color to pure red will tint the texture red.

emissive: LinearRgba

Color the material “emits” to the camera.

This is typically used for monitor screens or LED lights. Anything that can be visible even in darkness.

The emissive color is added to what would otherwise be the material’s visible color. This means that for a light emissive value, in darkness, you will mostly see the emissive component.

The default emissive color is LinearRgba::BLACK, which doesn’t add anything to the material color.

Emissive strength is controlled by the value of the color channels, while the hue is controlled by their relative values.

As a result, channel values for emissive colors can exceed 1.0. For instance, a base_color of LinearRgba::rgb(1.0, 0.0, 0.0) represents the brightest red for objects that reflect light, but an emissive color like LinearRgba::rgb(1000.0, 0.0, 0.0) can be used to create intensely bright red emissive effects.

This results in a final luminance value when multiplied by the value of the greyscale emissive texture (which ranges from 0 for black to 1 for white). Luminance is a measure of the amount of light emitted per unit area, and can be thought of as the “brightness” of the effect. In Bevy, we treat these luminance values as the physical units of cd/m², aka nits.

Increasing the emissive strength of the color will impact visual effects like bloom, but it’s important to note that an emissive material won’t typically light up surrounding areas like a light source, it just adds a value to the color seen on screen.

emissive_exposure_weight: f32

The weight in which the camera exposure influences the emissive color. A value of 0.0 means the emissive color is not affected by the camera exposure. In opposition, a value of 1.0 means the emissive color is multiplied by the camera exposure.

Defaults to 0.0

emissive_channel: UvChannel

The UV channel to use for the StandardMaterial::emissive_texture.

Defaults to UvChannel::Uv0.

emissive_texture: Option<Handle<Image>>

The emissive map, multiplies pixels with emissive to get the final “emitting” color of a surface.

This color is multiplied by emissive to get the final emitted color. Meaning that you should set emissive to Color::WHITE if you want to use the full range of color of the emissive texture.

perceptual_roughness: f32

Linear perceptual roughness, clamped to [0.089, 1.0] in the shader.

Defaults to 0.5.

Low values result in a “glossy” material with specular highlights, while values close to 1 result in rough materials.

If used together with a roughness/metallic texture, this is factored into the final base color as roughness * roughness_texture_value.

0.089 is the minimum floating point value that won’t be rounded down to 0 in the calculations used.

metallic: f32

How “metallic” the material appears, within [0.0, 1.0].

This should be set to 0.0 for dielectric materials or 1.0 for metallic materials. For a hybrid surface such as corroded metal, you may need to use in-between values.

Defaults to 0.00, for dielectric.

If used together with a roughness/metallic texture, this is factored into the final base color as metallic * metallic_texture_value.

metallic_roughness_channel: UvChannel

The UV channel to use for the StandardMaterial::metallic_roughness_texture.

Defaults to UvChannel::Uv0.

metallic_roughness_texture: Option<Handle<Image>>

Metallic and roughness maps, stored as a single texture.

The blue channel contains metallic values, and the green channel contains the roughness values. Other channels are unused.

Those values are multiplied by the scalar ones of the material, see metallic and perceptual_roughness for details.

Note that with the default values of metallic and perceptual_roughness, setting this texture has no effect. If you want to exclusively use the metallic_roughness_texture values for your material, make sure to set metallic and perceptual_roughness to 1.0.

reflectance: f32

Specular intensity for non-metals on a linear scale of [0.0, 1.0].

Use the value as a way to control the intensity of the specular highlight of the material, i.e. how reflective is the material, rather than the physical property “reflectance.”

Set to 0.0, no specular highlight is visible, the highlight is strongest when reflectance is set to 1.0.

Defaults to 0.5 which is mapped to 4% reflectance in the shader.

specular_tint: Color

A color with which to modulate the StandardMaterial::reflectance for non-metals.

The specular highlights and reflection are tinted with this color. Note that it has no effect for non-metals.

This feature is currently unsupported in the deferred rendering path, in order to reduce the size of the geometry buffers.

Defaults to Color::WHITE.

diffuse_transmission: f32

The amount of light transmitted diffusely through the material (i.e. “translucency”).

Implemented as a second, flipped Lambertian diffuse lobe, which provides an inexpensive but plausible approximation of translucency for thin dielectric objects (e.g. paper, leaves, some fabrics) or thicker volumetric materials with short scattering distances (e.g. porcelain, wax).

For specular transmission usecases with refraction (e.g. glass) use the StandardMaterial::specular_transmission and StandardMaterial::ior properties instead.

• When set to 0.0 (the default) no diffuse light is transmitted;
• When set to 1.0 all diffuse light is transmitted through the material;
• Values higher than 0.5 will cause more diffuse light to be transmitted than reflected, resulting in a “darker” appearance on the side facing the light than the opposite side. (e.g. plant leaves)

Notes

• The material’s StandardMaterial::base_color also modulates the transmitted light;
• To receive transmitted shadows on the diffuse transmission lobe (i.e. the “backside”) of the material, use the TransmittedShadowReceiver component.

diffuse_transmission_channel: UvChannel

The UV channel to use for the StandardMaterial::diffuse_transmission_texture.

Defaults to UvChannel::Uv0.

diffuse_transmission_texture: Option<Handle<Image>>

A map that modulates diffuse transmission via its alpha channel. Multiplied by StandardMaterial::diffuse_transmission to obtain the final result.

Important: The StandardMaterial::diffuse_transmission property must be set to a value higher than 0.0, or this texture won’t have any effect.

specular_transmission: f32

The amount of light transmitted specularly through the material (i.e. via refraction).

• When set to 0.0 (the default) no light is transmitted.
• When set to 1.0 all light is transmitted through the material.

The material’s StandardMaterial::base_color also modulates the transmitted light.

Note: Typically used in conjunction with StandardMaterial::thickness, StandardMaterial::ior and StandardMaterial::perceptual_roughness.

Performance

Specular transmission is implemented as a relatively expensive screen-space effect that allows occluded objects to be seen through the material, with distortion and blur effects.

• Camera3d::screen_space_specular_transmission_steps can be used to enable transmissive objects to be seen through other transmissive objects, at the cost of additional draw calls and texture copies; (Use with caution!)
  • If a simplified approximation of specular transmission using only environment map lighting is sufficient, consider setting Camera3d::screen_space_specular_transmission_steps to 0.
• If purely diffuse light transmission is needed, (i.e. “translucency”) consider using StandardMaterial::diffuse_transmission instead, for a much less expensive effect.
• Specular transmission is rendered before alpha blending, so any material with AlphaMode::Blend, AlphaMode::Premultiplied, AlphaMode::Add or AlphaMode::Multiply won’t be visible through specular transmissive materials.

specular_transmission_channel: UvChannel

The UV channel to use for the StandardMaterial::specular_transmission_texture.

Defaults to UvChannel::Uv0.

specular_transmission_texture: Option<Handle<Image>>

A map that modulates specular transmission via its red channel. Multiplied by StandardMaterial::specular_transmission to obtain the final result.

Important: The StandardMaterial::specular_transmission property must be set to a value higher than 0.0, or this texture won’t have any effect.

thickness: f32

Thickness of the volume beneath the material surface.

When set to 0.0 (the default) the material appears as an infinitely-thin film, transmitting light without distorting it.

When set to any other value, the material distorts light like a thick lens.

Note: Typically used in conjunction with StandardMaterial::specular_transmission and StandardMaterial::ior, or with StandardMaterial::diffuse_transmission.

thickness_channel: UvChannel

The UV channel to use for the StandardMaterial::thickness_texture.

Defaults to UvChannel::Uv0.

thickness_texture: Option<Handle<Image>>

A map that modulates thickness via its green channel. Multiplied by StandardMaterial::thickness to obtain the final result.

Important: The StandardMaterial::thickness property must be set to a value higher than 0.0, or this texture won’t have any effect.

ior: f32

The index of refraction of the material.

Defaults to 1.5.

Material	Index of Refraction
Vacuum	1
Air	1.00
Ice	1.31
Water	1.33
Eyes	1.38
Quartz	1.46
Olive Oil	1.47
Honey	1.49
Acrylic	1.49
Window Glass	1.52
Polycarbonate	1.58
Flint Glass	1.69
Ruby	1.71
Glycerine	1.74
Sapphire	1.77
Cubic Zirconia	2.15
Diamond	2.42
Moissanite	2.65

Note: Typically used in conjunction with StandardMaterial::specular_transmission and StandardMaterial::thickness.

attenuation_distance: f32

How far, on average, light travels through the volume beneath the material’s surface before being absorbed.

Defaults to f32::INFINITY, i.e. light is never absorbed.

Note: To have any effect, must be used in conjunction with:

• StandardMaterial::attenuation_color;
• StandardMaterial::thickness;
• StandardMaterial::diffuse_transmission or StandardMaterial::specular_transmission.

attenuation_color: Color

The resulting (non-absorbed) color after white light travels through the attenuation distance.

Defaults to Color::WHITE, i.e. no change.

Note: To have any effect, must be used in conjunction with:

• StandardMaterial::attenuation_distance;
• StandardMaterial::thickness;
• StandardMaterial::diffuse_transmission or StandardMaterial::specular_transmission.

normal_map_channel: UvChannel

The UV channel to use for the StandardMaterial::normal_map_texture.

Defaults to UvChannel::Uv0.

normal_map_texture: Option<Handle<Image>>

Used to fake the lighting of bumps and dents on a material.

A typical usage would be faking cobblestones on a flat plane mesh in 3D.

Notes

Normal mapping with StandardMaterial and the core bevy PBR shaders requires:

• A normal map texture
• Vertex UVs
• Vertex tangents
• Vertex normals

Tangents do not have to be stored in your model, they can be generated using the Mesh::generate_tangents or Mesh::with_generated_tangents methods. If your material has a normal map, but still renders as a flat surface, make sure your meshes have their tangents set.

Usage

fn load_normal_map(asset_server: Res<AssetServer>) {
    let normal_handle: Handle<Image> = asset_server.load_with_settings(
        "textures/parallax_example/cube_normal.png",
        // The normal map texture is in linear color space. Lighting won't look correct
        // if `is_srgb` is `true`, which is the default.
        |settings: &mut ImageLoaderSettings| settings.is_srgb = false,
    );
}

flip_normal_map_y: bool

Normal map textures authored for DirectX have their y-component flipped. Set this to flip it to right-handed conventions.

occlusion_channel: UvChannel

The UV channel to use for the StandardMaterial::occlusion_texture.

Defaults to UvChannel::Uv0.

occlusion_texture: Option<Handle<Image>>

Specifies the level of exposure to ambient light.

This is usually generated and stored automatically (“baked”) by 3D-modeling software.

Typically, steep concave parts of a model (such as the armpit of a shirt) are darker, because they have little exposure to light. An occlusion map specifies those parts of the model that light doesn’t reach well.

The material will be less lit in places where this texture is dark. This is similar to ambient occlusion, but built into the model.

specular_channel: UvChannel

The UV channel to use for the StandardMaterial::specular_texture.

Defaults to UvChannel::Uv0.

specular_texture: Option<Handle<Image>>

A map that specifies reflectance for non-metallic materials.

Alpha values from [0.0, 1.0] in this texture are linearly mapped to reflectance values of [0.0, 0.5] and multiplied by the constant StandardMaterial::reflectance value. This follows the KHR_materials_specular specification. The map will have no effect if the material is fully metallic.

When using this map, you may wish to set the StandardMaterial::reflectance value to 2.0 so that this map can express the full [0.0, 1.0] range of values.

Note that, because the reflectance is stored in the alpha channel, and the StandardMaterial::specular_tint_texture has no alpha value, it may be desirable to pack the values together and supply the same texture to both fields.

specular_tint_channel: UvChannel

The UV channel to use for the StandardMaterial::specular_tint_texture.

Defaults to UvChannel::Uv0.

specular_tint_texture: Option<Handle<Image>>

A map that specifies color adjustment to be applied to the specular reflection for non-metallic materials.

The RGB values of this texture modulate the StandardMaterial::specular_tint value. See the documentation for that field for more information.

Like the fixed specular tint value, this texture map isn’t supported in the deferred renderer.

clearcoat: f32

An extra thin translucent layer on top of the main PBR layer. This is typically used for painted surfaces.

This value specifies the strength of the layer, which affects how visible the clearcoat layer will be.

Defaults to zero, specifying no clearcoat layer.

clearcoat_channel: UvChannel

The UV channel to use for the StandardMaterial::clearcoat_texture.

Defaults to UvChannel::Uv0.

clearcoat_texture: Option<Handle<Image>>

An image texture that specifies the strength of the clearcoat layer in the red channel. Values sampled from this texture are multiplied by the main StandardMaterial::clearcoat factor.

As this is a non-color map, it must not be loaded as sRGB.

clearcoat_perceptual_roughness: f32

The roughness of the clearcoat material. This is specified in exactly the same way as the StandardMaterial::perceptual_roughness.

If the StandardMaterial::clearcoat value if zero, this has no effect.

Defaults to 0.5.

clearcoat_roughness_channel: UvChannel

The UV channel to use for the StandardMaterial::clearcoat_roughness_texture.

Defaults to UvChannel::Uv0.

clearcoat_roughness_texture: Option<Handle<Image>>

An image texture that specifies the roughness of the clearcoat level in the green channel. Values from this texture are multiplied by the main StandardMaterial::clearcoat_perceptual_roughness factor.

As this is a non-color map, it must not be loaded as sRGB.

clearcoat_normal_channel: UvChannel

The UV channel to use for the StandardMaterial::clearcoat_normal_texture.

Defaults to UvChannel::Uv0.

clearcoat_normal_texture: Option<Handle<Image>>

An image texture that specifies a normal map that is to be applied to the clearcoat layer. This can be used to simulate, for example, scratches on an outer layer of varnish. Normal maps are in the same format as StandardMaterial::normal_map_texture.

Note that, if a clearcoat normal map isn’t specified, the main normal map, if any, won’t be applied to the clearcoat. If you want a normal map that applies to both the main material and to the clearcoat, specify it in both StandardMaterial::normal_map_texture and this field.

As this is a non-color map, it must not be loaded as sRGB.

anisotropy_strength: f32

Increases the roughness along a specific direction, so that the specular highlight will be stretched instead of being a circular lobe.

This value ranges from 0 (perfectly circular) to 1 (maximally stretched). The default direction (corresponding to a StandardMaterial::anisotropy_rotation of 0) aligns with the tangent of the mesh; thus mesh tangents must be specified in order for this parameter to have any meaning. The direction can be changed using the StandardMaterial::anisotropy_rotation parameter.

This is typically used for modeling surfaces such as brushed metal and hair, in which one direction of the surface but not the other is smooth.

See the KHR_materials_anisotropy specification for more details.

anisotropy_rotation: f32

The direction of increased roughness, in radians relative to the mesh tangent.

This parameter causes the roughness to vary according to the StandardMaterial::anisotropy_strength. The rotation is applied in tangent-bitangent space; thus, mesh tangents must be present for this parameter to have any meaning.

This parameter has no effect if StandardMaterial::anisotropy_strength is zero. Its value can optionally be adjusted across the mesh with the StandardMaterial::anisotropy_texture.

See the KHR_materials_anisotropy specification for more details.

anisotropy_channel: UvChannel

The UV channel to use for the StandardMaterial::anisotropy_texture.

Defaults to UvChannel::Uv0.

anisotropy_texture: Option<Handle<Image>>

An image texture that allows the StandardMaterial::anisotropy_strength and StandardMaterial::anisotropy_rotation to vary across the mesh.

The KHR_materials_anisotropy specification defines the format that this texture must take. To summarize: the direction vector is encoded in the red and green channels, while the strength is encoded in the blue channels. For the direction vector, the red and green channels map the color range [0, 1] to the vector range [-1, 1]. The direction vector encoded in this texture modifies the default rotation direction in tangent-bitangent space, before the StandardMaterial::anisotropy_rotation parameter is applied. The value in the blue channel is multiplied by the StandardMaterial::anisotropy_strength value to produce the final anisotropy strength.

As the texel values don’t represent colors, this texture must be in linear color space, not sRGB.

double_sided: bool

Support two-sided lighting by automatically flipping the normals for “back” faces within the PBR lighting shader.

Defaults to false. This does not automatically configure backface culling, which can be done via cull_mode.

cull_mode: Option<Face>

Whether to cull the “front”, “back” or neither side of a mesh. If set to None, the two sides of the mesh are visible.

Defaults to Some(Face::Back). In bevy, the order of declaration of a triangle’s vertices in Mesh defines the triangle’s front face.

When a triangle is in a viewport, if its vertices appear counter-clockwise from the viewport’s perspective, then the viewport is seeing the triangle’s front face. Conversely, if the vertices appear clockwise, you are seeing the back face.

In short, in bevy, front faces winds counter-clockwise.

Your 3D editing software should manage all of that.

unlit: bool

Whether to apply only the base color to this material.

Normals, occlusion textures, roughness, metallic, reflectance, emissive, shadows, alpha mode and ambient light are ignored if this is set to true.

fog_enabled: bool

Whether to enable fog for this material.

alpha_mode: AlphaMode

How to apply the alpha channel of the base_color_texture.

See AlphaMode for details. Defaults to AlphaMode::Opaque.

depth_bias: f32

Adjust rendered depth.

A material with a positive depth bias will render closer to the camera while negative values cause the material to render behind other objects. This is independent of the viewport.

depth_bias affects render ordering and depth write operations using the wgpu::DepthBiasState::Constant field.

depth_map: Option<Handle<Image>>

The depth map used for parallax mapping.

It is a grayscale image where white represents bottom and black the top. If this field is set, bevy will apply parallax mapping. Parallax mapping, unlike simple normal maps, will move the texture coordinate according to the current perspective, giving actual depth to the texture.

The visual result is similar to a displacement map, but does not require additional geometry.

Use the parallax_depth_scale field to control the depth of the parallax.

Limitations

• It will look weird on bent/non-planar surfaces.
• The depth of the pixel does not reflect its visual position, resulting in artifacts for depth-dependent features such as fog or SSAO.
• For the same reason, the geometry silhouette will always be the one of the actual geometry, not the parallaxed version, resulting in awkward looks on intersecting parallaxed surfaces.

Performance

Parallax mapping requires multiple texture lookups, proportional to max_parallax_layer_count, which might be costly.

Use the parallax_mapping_method and max_parallax_layer_count fields to tweak the shader, trading graphical quality for performance.

To improve performance, set your depth_map’s Image::sampler filter mode to FilterMode::Nearest, as this paper indicates, it improves performance a bit.

To reduce artifacts, avoid steep changes in depth, blurring the depth map helps with this.

Larger depth maps haves a disproportionate performance impact.

parallax_depth_scale: f32

How deep the offset introduced by the depth map should be.

Default is 0.1, anything over that value may look distorted. Lower values lessen the effect.

The depth is relative to texture size. This means that if your texture occupies a surface of 1 world unit, and parallax_depth_scale is 0.1, then the in-world depth will be of 0.1 world units. If the texture stretches for 10 world units, then the final depth will be of 1 world unit.

parallax_mapping_method: ParallaxMappingMethod

Which parallax mapping method to use.

We recommend that all objects use the same ParallaxMappingMethod, to avoid duplicating and running two shaders.

max_parallax_layer_count: f32

In how many layers to split the depth maps for parallax mapping.

If you are seeing jaggy edges, increase this value. However, this incurs a performance cost.

Dependent on the situation, switching to ParallaxMappingMethod::Relief and keeping this value low might have better performance than increasing the layer count while using ParallaxMappingMethod::Occlusion.

Default is 16.0.

lightmap_exposure: f32

The exposure (brightness) level of the lightmap, if present.

opaque_render_method: OpaqueRendererMethod

Render method used for opaque materials. (Where alpha_mode is AlphaMode::Opaque or AlphaMode::Mask)

deferred_lighting_pass_id: u8

Used for selecting the deferred lighting pass for deferred materials. Default is DEFAULT_PBR_DEFERRED_LIGHTING_PASS_ID for default PBR deferred lighting pass. Ignored in the case of forward materials.

uv_transform: Affine2

The transform applied to the UVs corresponding to ATTRIBUTE_UV_0 on the mesh before sampling. Default is identity.

Implementations

impl StandardMaterial

pub const FLIP_HORIZONTAL: Affine2

Horizontal flipping transform

Multiplying this with another Affine2 returns transformation with horizontally flipped texture coords

pub const FLIP_VERTICAL: Affine2

Vertical flipping transform

Multiplying this with another Affine2 returns transformation with vertically flipped texture coords

pub const FLIP_X: Affine3

Flipping X 3D transform

Multiplying this with another Affine3 returns transformation with flipped X coords

pub const FLIP_Y: Affine3

Flipping Y 3D transform

Multiplying this with another Affine3 returns transformation with flipped Y coords

pub const FLIP_Z: Affine3

Flipping Z 3D transform

Multiplying this with another Affine3 returns transformation with flipped Z coords

pub fn flip(&mut self, horizontal: bool, vertical: bool)

Flip the texture coordinates of the material.

pub fn flipped(self, horizontal: bool, vertical: bool) -> StandardMaterial

Consumes the material and returns a material with flipped texture coordinates

pub fn from_color(color: impl Into<Color>) -> StandardMaterial

Creates a new material from a given color

Trait Implementations

impl AsBindGroup for StandardMaterial

type Data = StandardMaterialKey

Data that will be stored alongside the “prepared” bind group.

type Param = (Res<'static, RenderAssets<GpuImage>>, Res<'static, FallbackImage>, Res<'static, RenderAssets<GpuShaderStorageBuffer>>)

fn bindless_slot_count() -> Option<BindlessSlabResourceLimit>

The number of slots per bind group, if bindless mode is enabled.

fn bindless_supported(render_device: &RenderDevice) -> bool

True if the hardware actually supports bindless textures for this type, taking the device and driver capabilities into account.

fn label() -> Option<&'static str>

label

fn unprepared_bind_group( &self, layout: &BindGroupLayout, render_device: &RenderDevice, _: &mut <<StandardMaterial as AsBindGroup>::Param as SystemParam>::Item<'_, '_>, force_no_bindless: bool, ) -> Result<UnpreparedBindGroup, AsBindGroupError>

Returns a vec of (binding index, OwnedBindingResource).

fn bind_group_data(&self) -> <StandardMaterial as AsBindGroup>::Data

fn bind_group_layout_entries( render_device: &RenderDevice, force_no_bindless: bool, ) -> Vec<BindGroupLayoutEntry>

Returns a vec of bind group layout entries.

fn bindless_descriptor() -> Option<BindlessDescriptor>

fn as_bind_group( &self, layout: &BindGroupLayout, render_device: &RenderDevice, param: &mut <Self::Param as SystemParam>::Item<'_, '_>, ) -> Result<PreparedBindGroup, AsBindGroupError>

Creates a bind group for self matching the layout defined in AsBindGroup::bind_group_layout.

fn bind_group_layout(render_device: &RenderDevice) -> BindGroupLayout

where Self: Sized,

Creates the bind group layout matching all bind groups returned by AsBindGroup::as_bind_group

impl AsBindGroupShaderType<StandardMaterialUniform> for StandardMaterial

fn as_bind_group_shader_type( &self, images: &RenderAssets<GpuImage>, ) -> StandardMaterialUniform

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.

impl Clone for StandardMaterial

fn clone(&self) -> StandardMaterial

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StandardMaterial

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

Formats the value using the given formatter.

impl Default for StandardMaterial

fn default() -> StandardMaterial

Returns the “default value” for a type.

impl From<&StandardMaterial> for StandardMaterialKey

fn from(material: &StandardMaterial) -> StandardMaterialKey

Converts to this type from the input type.

impl From<Color> for StandardMaterial

fn from(color: Color) -> StandardMaterial

Converts to this type from the input type.

impl From<Handle<Image>> for StandardMaterial

fn from(texture: Handle<Image>) -> StandardMaterial

Converts to this type from the input type.

impl FromArg for StandardMaterial

type This<'from_arg> = StandardMaterial

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<StandardMaterial as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for StandardMaterial

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

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 GetOwnership for StandardMaterial

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for StandardMaterial

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 IntoReturn for StandardMaterial

fn into_return<'into_return>(self) -> Return<'into_return>

where StandardMaterial: 'into_return,

Converts Self into a Return value.

impl Material for StandardMaterial

fn fragment_shader() -> ShaderRef

Returns this material’s fragment shader. If ShaderRef::Default is returned, the default mesh fragment shader will be used.

fn alpha_mode(&self) -> AlphaMode

Returns this material’s AlphaMode. Defaults to AlphaMode::Opaque.

fn opaque_render_method(&self) -> OpaqueRendererMethod

Returns if this material should be rendered by the deferred or forward renderer. for AlphaMode::Opaque or AlphaMode::Mask materials. If OpaqueRendererMethod::Auto, it will default to what is selected in the DefaultOpaqueRendererMethod resource.

fn depth_bias(&self) -> f32

Add a bias to the view depth of the mesh which can be used to force a specific render order. for meshes with similar depth, to avoid z-fighting. The bias is in depth-texture units so large values may be needed to overcome small depth differences.

fn reads_view_transmission_texture(&self) -> bool

Returns whether the material would like to read from ViewTransmissionTexture.

fn prepass_fragment_shader() -> ShaderRef

Returns this material’s prepass fragment shader. If ShaderRef::Default is returned, the default prepass fragment shader will be used.

fn deferred_fragment_shader() -> ShaderRef

Returns this material’s deferred fragment shader. If ShaderRef::Default is returned, the default deferred fragment shader will be used.

fn meshlet_mesh_fragment_shader() -> ShaderRef

Returns this material’s crate::meshlet::MeshletMesh fragment shader. If ShaderRef::Default is returned, the default meshlet mesh fragment shader will be used.

fn meshlet_mesh_prepass_fragment_shader() -> ShaderRef

Returns this material’s crate::meshlet::MeshletMesh prepass fragment shader. If ShaderRef::Default is returned, the default meshlet mesh prepass fragment shader will be used.

fn meshlet_mesh_deferred_fragment_shader() -> ShaderRef

Returns this material’s crate::meshlet::MeshletMesh deferred fragment shader. If ShaderRef::Default is returned, the default meshlet mesh deferred fragment shader will be used.

fn specialize( _pipeline: &MaterialPipeline, descriptor: &mut RenderPipelineDescriptor, _layout: &MeshVertexBufferLayoutRef, key: MaterialPipelineKey<StandardMaterial>, ) -> Result<(), SpecializedMeshPipelineError>

Customizes the default RenderPipelineDescriptor for a specific entity using the entity’s MaterialPipelineKey and MeshVertexBufferLayoutRef as input.

fn vertex_shader() -> ShaderRef

Returns this material’s vertex shader. If ShaderRef::Default is returned, the default mesh vertex shader will be used.

fn prepass_vertex_shader() -> ShaderRef

Returns this material’s prepass vertex shader. If ShaderRef::Default is returned, the default prepass vertex shader will be used.

fn deferred_vertex_shader() -> ShaderRef

Returns this material’s deferred vertex shader. If ShaderRef::Default is returned, the default deferred vertex shader will be used.

impl PartialReflect for StandardMaterial

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

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

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<StandardMaterial>, ) -> 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<StandardMaterial>) -> 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 reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

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 to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

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 is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for StandardMaterial

fn into_any(self: Box<StandardMaterial>) -> 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<StandardMaterial>) -> 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 Struct for StandardMaterial

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for StandardMaterial

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 StandardMaterial

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl VisitAssetDependencies for StandardMaterial

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

impl Asset for StandardMaterial