Enum DepthTest

#[repr(u32)]
pub enum DepthTest {
    Less = 0,
    LessOrEq = 1,
    Greater = 2,
    GreaterOrEq = 3,
    Equal = 4,
    NotEqual = 5,
    Always = 6,
    Never = 7,
}

Depth test describes how this material looks at and responds to depth information in the zbuffer! The default is Less, which means if the material pixel’s depth is Less than the existing depth data, (basically, is this in front of some other object) it will draw that pixel. Similarly, Greater would only draw the material if it’s ‘behind’ the depth buffer. Always would just draw all the time, and not read from the depth buffer at all. https://stereokit.net/Pages/StereoKit/DepthTest.html

Variants

Less = 0

Default behavior, pixels behind the depth buffer will be discarded, and pixels in front of it will be drawn.

LessOrEq = 1

Pixels behind the depth buffer will be discarded, and pixels in front of, or at the depth buffer’s value it will be drawn. This could be great for things that might be sitting exactly on a floor or wall.

Greater = 2

Pixels in front of the zbuffer will be discarded! This is opposite of how things normally work. Great for drawing indicators that something is occluded by a wall or other geometry.

GreaterOrEq = 3

Pixels in front of (or exactly at) the zbuffer will be discarded! This is opposite of how things normally work. Great for drawing indicators that something is occluded by a wall or other geometry.

Equal = 4

Only draw pixels if they’re at exactly the same depth as the zbuffer!

NotEqual = 5

Draw any pixel that’s not exactly at the value in the zbuffer.

Always = 6

Don’t look at the zbuffer at all, just draw everything, always, all the time! At this point, the order at which the mesh gets drawn will be super important, so don’t forget about Material.QueueOffset!

Never = 7

Never draw a pixel, regardless of what’s in the zbuffer. I can think of better ways to do this, but uhh, this is here for completeness! Maybe you can find a use for it.

Trait Implementations

impl Clone for DepthTest

fn clone(&self) -> DepthTest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DepthTest

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

Formats the value using the given formatter.

impl PartialEq for DepthTest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for DepthTest

impl Eq for DepthTest

impl StructuralPartialEq for DepthTest