Skip to main content

WireframeMaterial

Struct WireframeMaterial 

Source
pub struct WireframeMaterial {
    pub color: LinearRgba,
    pub line_width: f32,
}
Expand description

A material that renders geometry as a wireframe for debugging and editor visualization.

Wireframe materials are essential for debug views, editor gizmos, and understanding the underlying geometry of meshes. This material will integrate with the future EditorGizmo RenderLane (issue #167) and is designed for development and debugging, not production rendering.

§Performance Note

Wireframe rendering typically requires either:

  • A geometry shader to generate line primitives
  • Barycentric coordinates in the fragment shader

The exact implementation will depend on the graphics backend capabilities. This material is intended for debug/editor contexts where performance is less critical.

§Examples

use khora_core::asset::WireframeMaterial;
use khora_core::math::LinearRgba;

// Create a green wireframe for debug visualization
let debug_wireframe = WireframeMaterial {
    color: LinearRgba::new(0.0, 1.0, 0.0, 1.0),
    line_width: 1.5,
};

// Create a thin white wireframe for mesh inspection
let mesh_inspector = WireframeMaterial {
    color: LinearRgba::new(1.0, 1.0, 1.0, 1.0),
    line_width: 1.0,
};

Fields§

§color: LinearRgba

The color of the wireframe lines.

This color is used for all edges of the geometry. Typically bright colors like green, cyan, or white are used for maximum visibility against the scene.

§line_width: f32

The width of the wireframe lines in pixels.

Note that line width support varies by platform and graphics backend:

  • Vulkan: Limited support for line widths other than 1.0
  • Metal/DX12: Good support for varying line widths
  • WebGPU: Limited to 1.0 pixel lines

For maximum compatibility, use 1.0. The rendering system may clamp this value based on backend capabilities.

Trait Implementations§

Source§

impl<'__de, __Context> BorrowDecode<'__de, __Context> for WireframeMaterial

Source§

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.
Source§

impl Clone for WireframeMaterial

Source§

fn clone(&self) -> WireframeMaterial

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 Debug for WireframeMaterial

Source§

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

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

impl<__Context> Decode<__Context> for WireframeMaterial

Source§

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.
Source§

impl Default for WireframeMaterial

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for WireframeMaterial

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 Encode for WireframeMaterial

Source§

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.
Source§

impl Material for WireframeMaterial

Source§

fn base_color(&self) -> LinearRgba

Returns the base color (albedo or diffuse) of the material. Default implementation is White.
Source§

fn emissive_color(&self) -> LinearRgba

Returns the emissive color of the material. Default implementation is Black.
Source§

fn specular_power(&self) -> f32

Returns the specular power or roughness conversion for the material. Default implementation is 32.0.
Source§

fn ambient_color(&self) -> LinearRgba

Returns the ambient color modifier for the material. Default implementation is (0.1, 0.1, 0.1, 0.0).
Source§

fn metallic(&self) -> f32

Returns the metallic factor (0.0 = dielectric, 1.0 = metal). Default implementation is 0.0.
Source§

fn roughness(&self) -> f32

Returns the roughness factor (0.0 = smooth, 1.0 = rough). Default implementation is 1.0.
Source§

fn base_color_texture(&self) -> Option<AssetUUID>

Returns the UUID of the base-color (albedo) texture, if any. Default implementation is None (untextured).
Source§

fn metallic_roughness_texture(&self) -> Option<AssetUUID>

Returns the UUID of the metallic-roughness texture, if any (glTF convention: B=metallic, G=roughness). Default implementation is None.
Source§

fn normal_map(&self) -> Option<AssetUUID>

Returns the UUID of the tangent-space normal map, if any. Default implementation is None.
Source§

fn emissive_texture(&self) -> Option<AssetUUID>

Returns the UUID of the emissive texture, if any. Default implementation is None.
Source§

fn occlusion_map(&self) -> Option<AssetUUID>

Returns the UUID of the ambient-occlusion map, if any (red channel). Attenuates the indirect (ambient/IBL) term only, never direct light. Default implementation is None.
Source§

fn alpha_mode(&self) -> AlphaMode

Returns the material’s alpha (transparency) mode. For AlphaMode::Mask the contained value is the alpha-cutoff threshold: fragments below it are discarded. Default implementation is AlphaMode::Opaque.
Source§

fn double_sided(&self) -> bool

Whether the material is rendered double-sided (back faces not culled). false (the default) culls back faces for correctly-wound meshes.
Source§

impl Serialize for WireframeMaterial

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

impl Asset for WireframeMaterial

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> AppLifecycle for T
where T: ?Sized,

Source§

fn on_start(&mut self, ctx: &mut dyn AppContext)

Called once after the backend is up but before the first update. Apps install their theme / fonts here.
Source§

fn on_exit(&mut self)

Called once when the window is closing. Persist state here.
Source§

impl<T> AsAny for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Returns a reference to the inner value as &dyn Any.
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> 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> MaterialClone for T
where T: Material + Clone + 'static,

Source§

fn clone_box(&self) -> Box<dyn Material>

Clones self into a new boxed dyn Material.
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,