Struct WireframeMaterial
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: LinearRgbaThe 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: f32The 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§
§impl<'__de, __Context> BorrowDecode<'__de, __Context> for WireframeMaterial
impl<'__de, __Context> BorrowDecode<'__de, __Context> for WireframeMaterial
§fn borrow_decode<__D>(
decoder: &mut __D,
) -> Result<WireframeMaterial, DecodeError>where
__D: BorrowDecoder<'__de, Context = __Context>,
fn borrow_decode<__D>(
decoder: &mut __D,
) -> Result<WireframeMaterial, DecodeError>where
__D: BorrowDecoder<'__de, Context = __Context>,
§impl Clone for WireframeMaterial
impl Clone for WireframeMaterial
§fn clone(&self) -> WireframeMaterial
fn clone(&self) -> WireframeMaterial
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more§impl Debug for WireframeMaterial
impl Debug for WireframeMaterial
§impl<__Context> Decode<__Context> for WireframeMaterial
impl<__Context> Decode<__Context> for WireframeMaterial
§fn decode<__D>(decoder: &mut __D) -> Result<WireframeMaterial, DecodeError>where
__D: Decoder<Context = __Context>,
fn decode<__D>(decoder: &mut __D) -> Result<WireframeMaterial, DecodeError>where
__D: Decoder<Context = __Context>,
§impl Default for WireframeMaterial
impl Default for WireframeMaterial
§fn default() -> WireframeMaterial
fn default() -> WireframeMaterial
§impl<'de> Deserialize<'de> for WireframeMaterial
impl<'de> Deserialize<'de> for WireframeMaterial
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<WireframeMaterial, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<WireframeMaterial, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl Encode for WireframeMaterial
impl Encode for WireframeMaterial
§impl Material for WireframeMaterial
impl Material for WireframeMaterial
§fn base_color(&self) -> LinearRgba
fn base_color(&self) -> LinearRgba
§fn emissive_color(&self) -> LinearRgba
fn emissive_color(&self) -> LinearRgba
§fn specular_power(&self) -> f32
fn specular_power(&self) -> f32
§fn ambient_color(&self) -> LinearRgba
fn ambient_color(&self) -> LinearRgba
§fn metallic(&self) -> f32
fn metallic(&self) -> f32
§fn roughness(&self) -> f32
fn roughness(&self) -> f32
§fn base_color_texture(&self) -> Option<AssetUUID>
fn base_color_texture(&self) -> Option<AssetUUID>
None (untextured).§fn metallic_roughness_texture(&self) -> Option<AssetUUID>
fn metallic_roughness_texture(&self) -> Option<AssetUUID>
None.§fn normal_map(&self) -> Option<AssetUUID>
fn normal_map(&self) -> Option<AssetUUID>
None.§fn emissive_texture(&self) -> Option<AssetUUID>
fn emissive_texture(&self) -> Option<AssetUUID>
None.§fn occlusion_map(&self) -> Option<AssetUUID>
fn occlusion_map(&self) -> Option<AssetUUID>
None.§fn alpha_mode(&self) -> AlphaMode
fn alpha_mode(&self) -> AlphaMode
AlphaMode::Mask
the contained value is the alpha-cutoff threshold: fragments below it are
discarded. Default implementation is AlphaMode::Opaque.§fn double_sided(&self) -> bool
fn double_sided(&self) -> bool
false (the default) culls back faces for correctly-wound meshes.§impl Serialize for WireframeMaterial
impl Serialize for WireframeMaterial
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl Asset for WireframeMaterial
Auto Trait Implementations§
impl Freeze for WireframeMaterial
impl RefUnwindSafe for WireframeMaterial
impl Send for WireframeMaterial
impl Sync for WireframeMaterial
impl Unpin for WireframeMaterial
impl UnsafeUnpin for WireframeMaterial
impl UnwindSafe for WireframeMaterial
Blanket Implementations§
§impl<T> AppLifecycle for Twhere
T: ?Sized,
impl<T> AppLifecycle for Twhere
T: ?Sized,
§fn on_start(&mut self, ctx: &mut dyn AppContext)
fn on_start(&mut self, ctx: &mut dyn AppContext)
update. Apps install their theme / fonts here.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSend for T
impl<T> DowncastSend for T
§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian().§impl<F, T, S> SimdInto<T, S> for Fwhere
T: SimdFrom<F, S>,
S: Simd,
impl<F, T, S> SimdInto<T, S> for Fwhere
T: SimdFrom<F, S>,
S: Simd,
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.