#[repr(u32)]pub enum DebugChannel {
Show 20 variants
None = 0,
UvCoords0 = 1,
UvCoords1 = 2,
Normals = 3,
VertexColor = 4,
VertexNormals = 5,
UvNormals = 6,
Tangents = 7,
Bitangents = 8,
DiffuseIrradiance = 9,
SpecularReflection = 10,
Brdf = 11,
Albedo = 12,
Roughness = 13,
Metallic = 14,
Occlusion = 15,
Emissive = 16,
UvEmissive = 17,
EmissiveFactor = 18,
EmissiveStrength = 19,
}
Expand description
Used to debug shaders by early exiting the shader and attempting to display the value as shaded colors.
Variants§
None = 0
UvCoords0 = 1
Displays the first set of UV coordinates as a color.
UvCoords1 = 2
Displays the second set of UV coordinates as a color.
Normals = 3
Displays normals after normal mapping, in world space
VertexColor = 4
Displays only the vertex color for the fragment.
VertexNormals = 5
Displays vertex normals.
UvNormals = 6
Displays uv normals. These are normals coming from a normal map texture. These are the normals in tangent space.
Tangents = 7
Displays vertex normals.
Bitangents = 8
Displays bitangents as calculated from normals and tangents.
DiffuseIrradiance = 9
Displays only the diffuse irradiance value.
SpecularReflection = 10
Displays only the specular reflection value.
Brdf = 11
Displays only the BRDF value for the fragment.
Albedo = 12
Displays only the albedo color for the fragment.
Roughness = 13
Displays only the roughness value for the fragment.
Metallic = 14
Displays only the metallic value for the fragment.
Occlusion = 15
Displays only the occlusion color for the fragment.
Emissive = 16
Displays only the calculated emissive effect (emissive_tex_color * emissive_factor * emissive_strength) of the fragment.
UvEmissive = 17
Displays only the emissive color (from the emissive map texture) of the fragment.
EmissiveFactor = 18
Displays only teh emissive factor of the fragment.
EmissiveStrength = 19
Displays only the emissive strength of the fragment (KHR_materials_emissive_strength).
Trait Implementations§
Source§impl Clone for DebugChannel
impl Clone for DebugChannel
Source§fn clone(&self) -> DebugChannel
fn clone(&self) -> DebugChannel
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DebugChannel
impl Debug for DebugChannel
Source§impl Default for DebugChannel
impl Default for DebugChannel
Source§fn default() -> DebugChannel
fn default() -> DebugChannel
Source§impl PartialEq for DebugChannel
impl PartialEq for DebugChannel
Source§impl PartialOrd for DebugChannel
impl PartialOrd for DebugChannel
Source§impl SlabItem for DebugChannel
impl SlabItem for DebugChannel
impl Copy for DebugChannel
impl StructuralPartialEq for DebugChannel
Auto Trait Implementations§
impl Freeze for DebugChannel
impl RefUnwindSafe for DebugChannel
impl Send for DebugChannel
impl Sync for DebugChannel
impl Unpin for DebugChannel
impl UnwindSafe for DebugChannel
Blanket Implementations§
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> 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<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute
] value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
[Quirk
] value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition
] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
§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()
.