Struct bevy_pbr::StandardMaterial

pub struct StandardMaterial {

    pub base_color: Color,
    pub base_color_texture: Option<Handle<Image>>,
    pub emissive: Color,
    pub emissive_texture: Option<Handle<Image>>,
    pub perceptual_roughness: f32,
    pub metallic: f32,
    pub metallic_roughness_texture: Option<Handle<Image>>,
    pub reflectance: f32,
    pub normal_map_texture: Option<Handle<Image>>,
    pub occlusion_texture: Option<Handle<Image>>,
    pub double_sided: bool,
    pub unlit: bool,
    pub alpha_mode: AlphaMode,
}

A material with “standard” properties used in PBR lighting Standard property values with pictures here https://google.github.io/filament/Material%20Properties.pdf.

May be created directly from a Color or an Image.

Fields

base_color: Color

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

base_color_texture: Option<Handle<Image>>

emissive: Color

emissive_texture: Option<Handle<Image>>

perceptual_roughness: f32

Linear perceptual roughness, clamped to [0.089, 1.0] in the shader Defaults to minimum of 0.089 If used together with a roughness/metallic texture, this is factored into the final base color as roughness * roughness_texture_value

metallic: f32

From [0.0, 1.0], dielectric to pure metallic If used together with a roughness/metallic texture, this is factored into the final base color as metallic * metallic_texture_value

metallic_roughness_texture: Option<Handle<Image>>

reflectance: f32

Specular intensity for non-metals on a linear scale of [0.0, 1.0] defaults to 0.5 which is mapped to 4% reflectance in the shader

normal_map_texture: Option<Handle<Image>>

occlusion_texture: Option<Handle<Image>>

double_sided: bool

unlit: bool

alpha_mode: AlphaMode

Trait Implementations

impl Clone for StandardMaterial

fn clone(&self) -> StandardMaterial

Returns a copy 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

Formats the value using the given formatter.

impl Default for StandardMaterial

fn default() -> Self

Returns the “default value” for a type.

impl From<Color> for StandardMaterial

fn from(color: Color) -> Self

Performs the conversion.

impl From<Handle<Image>> for StandardMaterial

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

Performs the conversion.

impl RenderAsset for StandardMaterial

type ExtractedAsset = StandardMaterial

The representation of the the asset in the “render world”.

type PreparedAsset = GpuStandardMaterial

The GPU-representation of the the asset.

type Param = (SRes<RenderDevice>, SRes<MaterialPipeline<StandardMaterial>>, SRes<RenderAssets<Image>>)

Specifies all ECS data required by RenderAsset::prepare_asset. For convenience use the lifetimeless SystemParams.

fn extract_asset(&self) -> Self::ExtractedAsset

Converts the asset into a RenderAsset::ExtractedAsset.

fn prepare_asset(
    material: Self::ExtractedAsset,
    (render_device, pbr_pipeline, gpu_images): &mut SystemParamItem<'_, '_, Self::Param>
) -> Result<Self::PreparedAsset, PrepareAssetError<Self::ExtractedAsset>>

Prepares the extracted asset for the GPU by transforming it into a RenderAsset::PreparedAsset. Therefore ECS data may be accessed via the param.

impl SpecializedMaterial for StandardMaterial

type Key = StandardMaterialKey

The key used to specialize this material’s RenderPipelineDescriptor.

fn key(render_asset: &<Self as RenderAsset>::PreparedAsset) -> Self::Key

Extract the SpecializedMaterial::Key for the “prepared” version of this material. This key will be passed in to the SpecializedMaterial::specialize function when compiling the RenderPipeline for a given entity’s material.

fn specialize(key: Self::Key, descriptor: &mut RenderPipelineDescriptor)

Specializes the given descriptor according to the given key.

fn fragment_shader(_asset_server: &AssetServer) -> Option<Handle<Shader>>

Returns this material’s fragment shader. If None is returned, the default mesh fragment shader will be used. Defaults to None.

fn bind_group(render_asset: &<Self as RenderAsset>::PreparedAsset) -> &BindGroup

Returns this material’s BindGroup. This should match the layout returned by SpecializedMaterial::bind_group_layout.

fn bind_group_layout(render_device: &RenderDevice) -> BindGroupLayout

Returns this material’s BindGroupLayout. This should match the BindGroup returned by SpecializedMaterial::bind_group.

fn alpha_mode(render_asset: &<Self as RenderAsset>::PreparedAsset) -> AlphaMode

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

fn vertex_shader(asset_server: &AssetServer) -> Option<Handle<Shader>>

Returns this material’s vertex shader. If None is returned, the default mesh vertex shader will be used. Defaults to None.

fn dynamic_uniform_indices(
    material: &<Self as RenderAsset>::PreparedAsset
) -> &[u32]

The dynamic uniform indices to set for the given material’s BindGroup. Defaults to an empty array / no dynamic uniform indices.

impl TypeUuid for StandardMaterial

const TYPE_UUID: Uuid