Skip to main content

CubeFace

Enum CubeFace 

Source
#[repr(u8)]
pub enum CubeFace { PosX = 0, NegX = 1, PosY = 2, NegY = 3, PosZ = 4, NegZ = 5, }
Expand description

One of the six faces of an axis-aligned cube.

The discriminants are stable (u8) and match the wgpu cubemap face ordering, so CubeFace::index can be used directly to address a texture_cube_array layer set.

Variants§

§

PosX = 0

+X face.

§

NegX = 1

-X face.

§

PosY = 2

+Y face.

§

NegY = 3

-Y face.

§

PosZ = 4

+Z face.

§

NegZ = 5

-Z face.

Implementations§

Source§

impl CubeFace

Source

pub const ALL: [CubeFace; 6]

All six faces in wgpu cubemap order: [+X, -X, +Y, -Y, +Z, -Z].

Use this with Iterator::map or array .map() to produce per-face data structures (view matrices, render passes, atlas slots…) in a stable order that matches the GPU’s expectation.

Source

pub const fn index(self) -> usize

Returns the layer index this face occupies inside a texture_cube_array slice (0..=5).

Source

pub const fn forward(self) -> Vec3

World-space direction the rendering camera looks toward when rasterising this face.

Source

pub const fn up(self) -> Vec3

World-space “up” direction matching the wgpu / Vulkan / D3D11 cubemap convention. The ±Y faces use ±Z as their up vector to keep look_at_rh(eye, eye + face.forward(), face.up()) non-degenerate.

Source

pub fn from_direction(dir: Vec3) -> CubeFace

Picks the face whose forward axis is most aligned with dir (largest absolute component wins, sign chooses the half-axis).

This is the major-axis selection used in CPU-side cubemap sampling debug paths and unit tests; the GPU equivalent runs in hardware during textureSampleCompareLevel(cube, ...).

Trait Implementations§

Source§

impl Clone for CubeFace

Source§

fn clone(&self) -> CubeFace

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 CubeFace

Source§

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

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

impl Hash for CubeFace

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CubeFace

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Copy for CubeFace

Source§

impl Eq for CubeFace

Source§

impl StructuralPartialEq for CubeFace

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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.