Struct bevy::sprite::ColorMaterial

pub struct ColorMaterial {
    pub color: Color,
    pub texture: Option<Handle<Image>>,
}

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

Fields

color: Color

texture: Option<Handle<Image>>

Trait Implementations

impl Clone for ColorMaterial

fn clone(&self) -> ColorMaterial

Returns a copy 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 Material2d for ColorMaterial

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: &<ColorMaterial as RenderAsset>::PreparedAsset
) -> &BindGroup

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

fn bind_group_layout(render_device: &RenderDevice) -> BindGroupLayout

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

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::PreparedAsset) -> &[u32]

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

fn specialize(
    descriptor: &mut RenderPipelineDescriptor,
    layout: &Hashed<InnerMeshVertexBufferLayout, FixedState>
) -> Result<(), SpecializedMeshPipelineError>

Customizes the default RenderPipelineDescriptor.

impl RenderAsset for ColorMaterial

type ExtractedAsset = ColorMaterial

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

type PreparedAsset = GpuColorMaterial

The GPU-representation of the the asset.

type Param = (Res<'static, RenderDevice>, Res<'static, Material2dPipeline<ColorMaterial>>, Res<'static, HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>>)

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

fn extract_asset(&self) -> <ColorMaterial as RenderAsset>::ExtractedAsset

Converts the asset into a RenderAsset::ExtractedAsset.

fn prepare_asset(
    material: <ColorMaterial as RenderAsset>::ExtractedAsset,
    &mut <<<ColorMaterial as RenderAsset>::Param as SystemParam>::Fetch as SystemParamFetch<'_, '_>>::Item
) -> Result<<ColorMaterial as RenderAsset>::PreparedAsset, PrepareAssetError<<ColorMaterial as RenderAsset>::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 TypeUuid for ColorMaterial

const TYPE_UUID: Uuid = bevy_reflect::Uuid::from_bytes([226, 40, 165, 68, 227, 202, 78, 30, 187, 157, 77, 139, 193, 173, 140, 25])