Struct ColorMaterial 

pub struct ColorMaterial {
    pub color: Color,
    pub alpha_mode: AlphaMode2d,
    pub uv_transform: Affine2,
    pub texture: Option<Handle<Image>>,
}

Available on crate feature bevy_sprite_render only.

A 2d material that renders 2d meshes with a texture tinted by a uniform color

Fields

color: Color

alpha_mode: AlphaMode2d

uv_transform: Affine2

texture: Option<Handle<Image>>

Implementations

impl ColorMaterial

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

Creates a new material from a given color

Examples found in repository

examples/usage/character_creation.rs (line 742)

fn character_hat(character: &Character) -> Box<dyn Scene> {
    match character.hat_type {
        HatType::None => Box::new(bsn! {
            CharacterHat
        }),
        HatType::TopHat => Box::new(bsn! {
            CharacterHat
            // 0.78 radians ~ PI / 4
            Transform::from_rotation(Quat::from_rotation_z(0.78))
            Visibility::Inherited
            Children [
                // bottom wider portion of the top hat.
                Mesh2d(asset_value(Rectangle::new(
                    40., 10.
                )))
                MeshMaterial2d<ColorMaterial>(asset_value(ColorMaterial::from_color(Color::BLACK)))
                Transform::from_xyz(55., 60., 1.)
                --
                // top longer portion of the top hat
                Mesh2d(asset_value(Rectangle::new(
                    20., 50.
                )))
                MeshMaterial2d<ColorMaterial>(asset_value(ColorMaterial::from_color(Color::BLACK)))
                Transform::from_xyz(55., 85., 1.)
            ]
        }),
        HatType::DunceCap => Box::new(bsn! {
            CharacterHat
            Mesh2d(asset_value(Triangle2d::new(
                Vec2::new(0., 100.),
                Vec2::new(-20., 0.),
                Vec2::new(20., 0.)
            )))
            MeshMaterial2d<ColorMaterial>(asset_value(ColorMaterial::from_color(palettes::basic::TEAL)))
            Transform::from_xyz(0., 80., 1.).with_rotation(Quat::from_rotation_z(0.78))
        }),
    }
}

examples/testbed/2d.rs (line 608)

    pub fn setup(
        mut commands: Commands,
        mut meshes: ResMut<Assets<Mesh>>,
        mut materials: ResMut<Assets<ColorMaterial>>,
    ) {
        // The window background is drawn with the clear color.
        commands.insert_resource(ClearColor(TEST_COLOR));

        // Make sure there's no tonemapping
        commands.spawn((
            Camera2d,
            Tonemapping::None,
            DespawnOnExit(super::Scene::ColorConsistency),
        ));

        // Top third for sprites
        commands.spawn((
            Sprite {
                color: TEST_COLOR,
                custom_size: Some(Vec2::new(STRIP_WIDTH, STRIP_HEIGHT)),
                ..default()
            },
            Transform::from_xyz(0.0, STRIP_HEIGHT, 0.0),
            DespawnOnExit(super::Scene::ColorConsistency),
        ));

        // Middle third for 2D meshes
        commands.spawn((
            Mesh2d(meshes.add(Rectangle::new(STRIP_WIDTH, STRIP_HEIGHT))),
            MeshMaterial2d(materials.add(ColorMaterial::from_color(TEST_COLOR))),
            Transform::from_xyz(0.0, 0.0, 0.0),
            DespawnOnExit(super::Scene::ColorConsistency),
        ));

        // Bottom third for UI nodes
        commands.spawn((
            Node {
                position_type: PositionType::Absolute,
                bottom: Val::Px(0.0),
                left: Val::Px(0.0),
                width: Val::Percent(33.3),
                height: Val::Px(STRIP_HEIGHT),
                ..default()
            },
            BackgroundColor(TEST_COLOR),
            DespawnOnExit(super::Scene::ColorConsistency),
        ));
    }

Trait Implementations

impl AsBindGroup for ColorMaterial

type Data = ()

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

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

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() -> &'static str

label

fn build_bind_group( &self, layout: &BindGroupLayout, render_device: &RenderDevice, _: &mut <<ColorMaterial as AsBindGroup>::Param as SystemParam>::Item<'_, '_>, force_no_bindless: bool, output: &mut BindGroupBuilder, ) -> Result<(), AsBindGroupError>

Populates a BindGroupBuilder with all bindings that this type exposes.

fn bind_group_data(&self) -> <ColorMaterial 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_descriptor: &BindGroupLayoutDescriptor, render_device: &RenderDevice, pipeline_cache: &PipelineCache, fallback_buffer: &FallbackBuffer, shader_buffer_assets: &RenderAssets<GpuShaderBuffer>, 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

fn bind_group_layout_descriptor( render_device: &RenderDevice, ) -> BindGroupLayoutDescriptor

where Self: Sized,

Creates the bind group layout descriptor matching all bind groups returned by AsBindGroup::as_bind_group TODO: we only need RenderDevice to determine if bindless is supported

impl AsBindGroupShaderType<ColorMaterialUniform> for ColorMaterial

fn as_bind_group_shader_type( &self, _images: &RenderAssets<GpuImage>, ) -> ColorMaterialUniform

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

impl Asset for ColorMaterial

impl Clone for ColorMaterial

fn clone(&self) -> ColorMaterial

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColorMaterial

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

Formats the value using the given formatter.

impl Default for ColorMaterial

fn default() -> ColorMaterial

Returns the “default value” for a type.

impl From<Color> for ColorMaterial

fn from(color: Color) -> ColorMaterial

Converts to this type from the input type.

impl From<Handle<Image>> for ColorMaterial

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

Converts to this type from the input type.

impl FromArg for ColorMaterial

type This<'from_arg> = ColorMaterial

The type to convert into.

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

Creates an item from an argument.

impl FromReflect for ColorMaterial

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

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 ColorMaterial

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for ColorMaterial

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 ColorMaterial

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

where ColorMaterial: 'into_return,

Converts Self into a Return value.

impl Material2d for ColorMaterial

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

fn vertex_shader() -> ShaderRef

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

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.

fn specialize( pipeline: &Material2dPipeline, descriptor: &mut RenderPipelineDescriptor, layout: &MeshVertexBufferLayoutRef, key: Material2dKey<Self>, ) -> Result<(), SpecializedMeshPipelineError>

Customizes the default RenderPipelineDescriptor.

impl PartialReflect for ColorMaterial

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

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial 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) -> Result<Box<dyn PartialReflect>, ReflectCloneError>

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 ColorMaterial

fn into_any(self: Box<ColorMaterial>) -> 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<ColorMaterial>) -> 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 ColorMaterial

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

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

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

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

Gets 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>

Gets the name of the field with index index.

fn index_of_name(&self, name: &str) -> Option<usize>

Gets the index of the field with the given name.

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) -> Result<DynamicStruct, ReflectCloneError>

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 ColorMaterial

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 ColorMaterial

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl VisitAssetDependencies for ColorMaterial

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

Apply the visit closure to every asset dependency.