Skip to main content

PlaneFormat

Enum PlaneFormat 

Source
pub enum PlaneFormat {
Show 13 variants R8, R16, RG8, RG16, RGBA8, BGRA8, RGBA16, RGBA16F, RGBA32F, R16Uint, R32Float, RGBA16Uint, RGB10A2,
}
Expand description

Per-plane storage primitive. A plane’s PlaneFormat names the smallest texture format a GPU upload would use for it; the shader reinterprets the channels when needed (e.g. AYUV64LE uses RGBA16 storage with AYUV channel semantics).

Variants§

§

R8

§

R16

§

RG8

§

RG16

§

RGBA8

§

BGRA8

§

RGBA16

§

RGBA16F

§

RGBA32F

§

R16Uint

§

R32Float

§

RGBA16Uint

Four-channel 16-bit unsigned-integer RGBA (Rgba16Uint), 8 B/px. The integer 4-channel storage primitive an already-colour multi-plane raw frame uploads as (read via textureLoad — never sampler-normalised).

§

RGB10A2

Packed 10:10:10:2 unsigned-normalized RGBA (Rgb10a2Unorm), 4 B/px — R in bits 0..10, G 10..20, B 20..30, A 30..32 (little-endian; DXGI R10G10B10A2_UNORM / Vulkan A2B10G10R10_UNORM_PACK32). The HDR10 swapchain / render-target primitive (PixelFormat::Rgb10A2).

Implementations§

Source§

impl PlaneFormat

Source

pub const fn bytes_per_sample(self) -> u32

Size in bytes of one stored texel of this plane format (all channels). width_in_texels * bytes_per_sample() is the tight row stride; every backend’s stride / buffer-length math derives from this single table. RGBA16F is two bytes per channel (IEEE half), matching RGBA16.

Source

pub const fn requires_16bit_norm(self) -> bool

True when a texture of this plane format needs the wgpu::Features::TEXTURE_FORMAT_16BIT_NORM adapter feature — the three 16-bit normalized storage primitives (R16 → R16Unorm, RG16 → Rg16Unorm, RGBA16 → Rgba16Unorm). The 16-bit integer primitives (R16Uint, RGBA16Uint), the 16-bit float primitive (RGBA16F → Rgba16Float), and every 8-/10-/32-bit primitive are core wgpu formats and return false.

This is the single source of truth an interop import gate keys on: a PixelFormat whose plane layout contains any such plane cannot be zero-copy imported on a device without the feature (see PixelFormat::requires_16bit_norm).

Source

pub const fn to_wgpu_texture_format(self) -> TextureFormat

Available on crate feature wgpu only.

Canonical wgpu equivalent of this per-plane storage primitive. Used at the wgpu-backend boundary where the type system needs the real wgpu::TextureFormat (transient texture creation, pipeline layout). Backend-agnostic code carries PlaneFormat instead.

Trait Implementations§

Source§

impl Clone for PlaneFormat

Source§

fn clone(&self) -> Self

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 Copy for PlaneFormat

Source§

impl Debug for PlaneFormat

Source§

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

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

impl<'de> Deserialize<'de> for PlaneFormat

Available on crate feature serde only.
Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for PlaneFormat

Source§

impl Hash for PlaneFormat

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 PlaneFormat

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for PlaneFormat

Available on crate feature serde only.
Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PlaneFormat

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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

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

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

Source§

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> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,