Enum bevy::render::alpha::AlphaMode

pub enum AlphaMode {
    Opaque,
    Mask(f32),
    Blend,
    Premultiplied,
    AlphaToCoverage,
    Add,
    Multiply,
}

Sets how a material’s base color alpha channel is used for transparency.

Variants

Opaque

Base color alpha values are overridden to be fully opaque (1.0).

Mask(f32)

Reduce transparency to fully opaque or fully transparent based on a threshold.

Compares the base color alpha value to the specified threshold. If the value is below the threshold, considers the color to be fully transparent (alpha is set to 0.0). If it is equal to or above the threshold, considers the color to be fully opaque (alpha is set to 1.0).

Blend

The base color alpha value defines the opacity of the color. Standard alpha-blending is used to blend the fragment’s color with the color behind it.

Premultiplied

Similar to AlphaMode::Blend, however assumes RGB channel values are premultiplied.

For otherwise constant RGB values, behaves more like AlphaMode::Blend for alpha values closer to 1.0, and more like AlphaMode::Add for alpha values closer to 0.0.

Can be used to avoid “border” or “outline” artifacts that can occur when using plain alpha-blended textures.

AlphaToCoverage

Spreads the fragment out over a hardware-dependent number of sample locations proportional to the alpha value. This requires multisample antialiasing; if MSAA isn’t on, this is identical to AlphaMode::Mask with a value of 0.5.

Alpha to coverage provides improved performance and better visual fidelity over AlphaMode::Blend, as Bevy doesn’t have to sort objects when it’s in use. It’s especially useful for complex transparent objects like foliage.

Add

Combines the color of the fragments with the colors behind them in an additive process, (i.e. like light) producing lighter results.

Black produces no effect. Alpha values can be used to modulate the result.

Useful for effects like holograms, ghosts, lasers and other energy beams.

Multiply

Combines the color of the fragments with the colors behind them in a multiplicative process, (i.e. like pigments) producing darker results.

White produces no effect. Alpha values can be used to modulate the result.

Useful for effects like stained glass, window tint film and some colored liquids.

Trait Implementations

impl Clone for AlphaMode

fn clone(&self) -> AlphaMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlphaMode

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

Formats the value using the given formatter.

impl Default for AlphaMode

fn default() -> AlphaMode

Returns the “default value” for a type.

impl Enum for AlphaMode

where AlphaMode: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

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

Returns a reference to the value of the field (in the current variant) with the given name.

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

Returns a reference to the value of the field (in the current variant) at the given index.

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

Returns a mutable reference to the value of the field (in the current variant) with the given name.

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

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

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

Returns the name of the field (in the current variant) with the given index.

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

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl FromReflect for AlphaMode

where AlphaMode: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(__param0: &(dyn Reflect + 'static)) -> Option<AlphaMode>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for AlphaMode

where AlphaMode: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

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 PartialEq for AlphaMode

fn eq(&self, other: &AlphaMode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for AlphaMode

where AlphaMode: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<AlphaMode>) -> 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<AlphaMode>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set( &mut self, __value_param: Box<dyn Reflect> ) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, __value_param: &(dyn Reflect + 'static))

Applies 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<AlphaMode>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl TypePath for AlphaMode

where AlphaMode: Any + Send + Sync,

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 AlphaMode

where AlphaMode: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for AlphaMode

impl Eq for AlphaMode

impl StructuralPartialEq for AlphaMode