Struct ColorMaterial

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

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

Fields§

§color: Color§texture: Option<Handle<Image>>

Trait Implementations§

Source§

impl Clone for ColorMaterial

Source§

fn clone(&self) -> ColorMaterial

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 ColorMaterial

Source§

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

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

impl Default for ColorMaterial

Source§

fn default() -> ColorMaterial

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

impl From<Color> for ColorMaterial

Source§

fn from(color: Color) -> ColorMaterial

Converts to this type from the input type.
Source§

impl From<Handle<Image>> for ColorMaterial

Source§

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

Converts to this type from the input type.
Source§

impl Material2d for ColorMaterial

Source§

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.
Source§

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.
Source§

fn bind_group_layout(render_device: &RenderDevice) -> BindGroupLayout

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

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.
Source§

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.
Source§

impl RenderAsset for ColorMaterial

Source§

type ExtractedAsset = ColorMaterial

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

type PreparedAsset = GpuColorMaterial

The GPU-representation of the the asset.
Source§

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

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

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

Converts the asset into a RenderAsset::ExtractedAsset.
Source§

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.
Source§

impl TypeUuid for ColorMaterial

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 + Send + Sync>

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> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World
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<M> SpecializedMaterial2d for M
where M: Material2d,

Source§

type Key = ()

The key used to specialize this material’s RenderPipelineDescriptor.
Source§

fn key( _material: &<M as RenderAsset>::PreparedAsset, ) -> <M as SpecializedMaterial2d>::Key

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

fn specialize( _key: <M as SpecializedMaterial2d>::Key, _descriptor: &mut RenderPipelineDescriptor, )

Specializes the given descriptor according to the given key.
Source§

fn bind_group(material: &<M as RenderAsset>::PreparedAsset) -> &BindGroup

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

fn bind_group_layout(render_device: &RenderDevice) -> BindGroupLayout

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

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.
Source§

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.
Source§

fn dynamic_uniform_indices( material: &<M 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.
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> TypeData for T
where T: 'static + Send + Sync + Clone,

Source§

impl<T> TypeUuidDynamic for T
where T: TypeUuid,

Source§

fn type_uuid(&self) -> Uuid

Source§

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

Source§

impl<T> Upcast<T> for T

Source§

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

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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> Asset for T

Source§

impl<T> AssetDynamic for T
where T: Send + Sync + 'static + TypeUuidDynamic,

Source§

impl<T> Resource for T
where T: Send + Sync + 'static,