Skip to main content

Decal

Struct Decal 

Source
pub struct Decal {
    pub asset_id: AssetId,
    pub texture: Option<TextureHandle>,
    pub position: [f32; 3],
    pub rotation_deg: [f32; 3],
    pub size: [f32; 3],
    pub tint: [f32; 4],
    pub visible: bool,
}
Expand description

A projected texture stamped onto whatever scene geometry sits inside the decal’s oriented box.

The decal is a box volume positioned by position/rotation_deg/size in world space. The texture is projected down the box’s local +Y axis onto the local X-Z plane and stamped onto the surfaces inside the box; anything outside the box is unaffected. Surfaces near the box’s top and bottom faces fade out so the stamp doesn’t show a hard edge on a curved surface.

The defaults orient the decal as a ground stamp: a flat 1×1 m square laid on the world X-Z plane, projecting down from +Y. To stamp a wall, rotate so local +Y points into the surface (e.g. rotation_deg:[0,0,90] for a +X wall).

Decals blend over the lit image without affecting depth, so they layer on top of the surfaces they stamp.

Decal {
    position: [2.0, 0.01, -1.5],
    size: [1.5, 0.5, 1.5],
    ..Default::default()
};

Fields§

§asset_id: AssetId

Asset identity; injected via inject_name. Not part of args.

§texture: Option<TextureHandle>

The Texture asset projected onto the scene.

§position: [f32; 3]

World-space position of the decal box’s centre.

§rotation_deg: [f32; 3]

Euler rotation in degrees [pitch, yaw, roll], YXZ order, same as Prop.

§size: [f32; 3]

Local-space box extents. Local +Y is the projection axis; the texture is sampled on the local X-Z plane. A non-positive component disables the decal.

§tint: [f32; 4]

Linear-space RGBA tint multiplied with the sampled texture. The alpha channel scales the final blend, so [1,1,1,0] hides the decal.

§visible: bool

When false the decal is skipped each frame.

Trait Implementations§

Source§

impl Clone for Decal

Source§

fn clone(&self) -> Decal

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Component for Decal

Source§

const NAME: &'static str = "Decal"

The registry name a world authors this component under.
Source§

fn inject_name(&mut self, id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.
Source§

fn from_baked(bytes: &[u8]) -> Result<Self, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.
Source§

fn inject_locator(&mut self, _locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).
Source§

impl ComponentSlot for Decal

Source§

const DISCRIMINANT: u8

The component type’s stable id, used as its ComponentId.
Source§

fn slot(s: &ComponentStorage) -> &Column<Self>

Borrow this type’s column out of the storage.
Source§

fn slot_mut(s: &mut ComponentStorage) -> &mut Column<Self>

Mutably borrow this type’s column out of the storage.
Source§

impl Debug for Decal

Source§

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

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

impl Default for Decal

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Decal
where Decal: Default,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<Decal> for ComponentAsset

Source§

fn from(c: Decal) -> Self

Converts to this type from the input type.
Source§

impl RuntimeComponent for Decal

Source§

impl Serialize for Decal

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Decal

§

impl RefUnwindSafe for Decal

§

impl Send for Decal

§

impl Sync for Decal

§

impl Unpin for Decal

§

impl UnsafeUnpin for Decal

§

impl UnwindSafe for Decal

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<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 = !

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.