Enum ClipVolume 

#[non_exhaustive]
pub enum ClipVolume {
    None,
    Plane {
        normal: [f32; 3],
        distance: f32,
    },
    Box {
        center: [f32; 3],
        half_extents: [f32; 3],
        orientation: [[f32; 3]; 3],
    },
    Sphere {
        center: [f32; 3],
        radius: f32,
    },
}

A volumetric clip region applied as an additional clipping test on top of any existing ClipPlanes. Fragments outside the volume are discarded.

The default value is ClipVolume::None which adds zero overhead.

This is a separate, independent mechanism from the half-space clip_planes field on FrameData. When both are active a fragment must pass both the clip-plane loop and the clip-volume test.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

No clip volume — all fragments pass (default, zero GPU overhead).

Plane

Half-space plane: dot(p, normal) + distance >= 0 is the kept region.

This reproduces the existing ClipPlane behavior at the single-volume level and is useful when a caller wants to express both the plane and box/sphere regions through the same uniform path.

Fields

normal: [f32; 3]

Unit normal pointing into the preserved half-space.

distance: f32

Signed distance from the origin along normal.

Box

Axis-aligned or oriented box region: fragments inside the box are kept.

orientation is a 3×3 rotation matrix stored as three column vectors (each [f32; 3]). For an axis-aligned box use the identity.

Fields

center: [f32; 3]

Box center in world space.

half_extents: [f32; 3]

Half-extents (per-axis radius) of the box.

orientation: [[f32; 3]; 3]

Rotation matrix columns: orientation[0] = local X axis in world space, orientation[1] = local Y, orientation[2] = local Z.

Sphere

Sphere region: fragments inside the sphere are kept.

Fields

center: [f32; 3]

Sphere center in world space.

radius: f32

Sphere radius in world units.

Trait Implementations

impl Clone for ClipVolume

fn clone(&self) -> ClipVolume

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClipVolume

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

Formats the value using the given formatter.

impl Default for ClipVolume

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ClipVolume

fn eq(&self, other: &ClipVolume) -> 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 ClipVolume

impl StructuralPartialEq for ClipVolume