Struct CompressedImageFormats 

pub struct CompressedImageFormats(/* private fields */);

A set of flags describing the compressed formats supported by a render device.

Implementations

impl CompressedImageFormats

pub const NONE: CompressedImageFormats

No support for compressed textures.

pub const ASTC_LDR: CompressedImageFormats

Support for Adaptive Scalable Texture Compression.

For more information see:

• Features::TEXTURE_COMPRESSION_ASTC
• ASTC Format Specification

pub const ASTC_HDR: CompressedImageFormats

Support for ASTC HDR textures.

For more information see:

• Features::TEXTURE_COMPRESSION_ASTC_HDR

pub const BC: CompressedImageFormats

Support for Block Compressed textures.

For more information see:

• Features::TEXTURE_COMPRESSION_BC
• S3TC Format Specification (BC1, BC2, BC3)
• RGTC Format Specification (BC4, BC5)
• BPTC Format Specification (BC6, BC7)

pub const ETC2: CompressedImageFormats

Support for Ericsson Texture Compression.

For more information see:

• Features::TEXTURE_COMPRESSION_ETC2
• ETC2 Format Specification

impl CompressedImageFormats

pub const fn empty() -> CompressedImageFormats

Get a flags value with all bits unset.

pub const fn all() -> CompressedImageFormats

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<CompressedImageFormats>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> CompressedImageFormats

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> CompressedImageFormats

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<CompressedImageFormats>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: CompressedImageFormats) -> bool

Whether any set bits in other are also set in self.

pub const fn contains(&self, other: CompressedImageFormats) -> bool

Whether all set bits in other are also set in self.

Examples found in repository

examples/3d/skybox.rs (line 128)

fn cycle_cubemap_asset(
    time: Res<Time>,
    mut next_swap: Local<f32>,
    mut cubemap: ResMut<Cubemap>,
    asset_server: Res<AssetServer>,
    render_device: Res<RenderDevice>,
) {
    let now = time.elapsed_secs();
    if *next_swap == 0.0 {
        *next_swap = now + CUBEMAP_SWAP_DELAY;
        return;
    } else if now < *next_swap {
        return;
    }
    *next_swap += CUBEMAP_SWAP_DELAY;

    let supported_compressed_formats =
        CompressedImageFormats::from_features(render_device.features());

    let mut new_index = cubemap.index;
    for _ in 0..CUBEMAPS.len() {
        new_index = (new_index + 1) % CUBEMAPS.len();
        if supported_compressed_formats.contains(CUBEMAPS[new_index].1) {
            break;
        }
        info!(
            "Skipping format which is not supported by current hardware: {:?}",
            CUBEMAPS[new_index]
        );
    }

    // Skip swapping to the same texture. Useful for when ktx2, zstd, or compressed texture support
    // is missing
    if new_index == cubemap.index {
        return;
    }

    cubemap.index = new_index;
    cubemap.image_handle = asset_server.load(CUBEMAPS[cubemap.index].0);
    cubemap.is_loaded = false;
}

pub fn insert(&mut self, other: CompressedImageFormats)

The bitwise or (|) of the bits in self and other.

pub fn remove(&mut self, other: CompressedImageFormats)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: CompressedImageFormats)

The bitwise exclusive-or (^) of the bits in self and other.

pub fn set(&mut self, other: CompressedImageFormats, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection( self, other: CompressedImageFormats, ) -> CompressedImageFormats

The bitwise and (&) of the bits in self and other.

pub const fn union( self, other: CompressedImageFormats, ) -> CompressedImageFormats

The bitwise or (|) of the bits in self and other.

pub const fn difference( self, other: CompressedImageFormats, ) -> CompressedImageFormats

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference( self, other: CompressedImageFormats, ) -> CompressedImageFormats

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> CompressedImageFormats

The bitwise negation (!) of the bits in self, truncating the result.

impl CompressedImageFormats

pub const fn iter(&self) -> Iter<CompressedImageFormats>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<CompressedImageFormats>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl CompressedImageFormats

pub fn from_features(features: Features) -> CompressedImageFormats

Get the supported texture compression formats from a wgpu device’s features.

Examples found in repository

examples/3d/skybox.rs (line 123)

fn cycle_cubemap_asset(
    time: Res<Time>,
    mut next_swap: Local<f32>,
    mut cubemap: ResMut<Cubemap>,
    asset_server: Res<AssetServer>,
    render_device: Res<RenderDevice>,
) {
    let now = time.elapsed_secs();
    if *next_swap == 0.0 {
        *next_swap = now + CUBEMAP_SWAP_DELAY;
        return;
    } else if now < *next_swap {
        return;
    }
    *next_swap += CUBEMAP_SWAP_DELAY;

    let supported_compressed_formats =
        CompressedImageFormats::from_features(render_device.features());

    let mut new_index = cubemap.index;
    for _ in 0..CUBEMAPS.len() {
        new_index = (new_index + 1) % CUBEMAPS.len();
        if supported_compressed_formats.contains(CUBEMAPS[new_index].1) {
            break;
        }
        info!(
            "Skipping format which is not supported by current hardware: {:?}",
            CUBEMAPS[new_index]
        );
    }

    // Skip swapping to the same texture. Useful for when ktx2, zstd, or compressed texture support
    // is missing
    if new_index == cubemap.index {
        return;
    }

    cubemap.index = new_index;
    cubemap.image_handle = asset_server.load(CUBEMAPS[cubemap.index].0);
    cubemap.is_loaded = false;
}

pub fn supports(&self, format: TextureFormat) -> bool

Returns true if the given TextureFormat is supported by the available compression features.

Always returns true for uncompressed formats.

Trait Implementations

impl Binary for CompressedImageFormats

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

Formats the value using the given formatter.

impl BitAnd for CompressedImageFormats

fn bitand(self, other: CompressedImageFormats) -> CompressedImageFormats

The bitwise and (&) of the bits in self and other.

type Output = CompressedImageFormats

The resulting type after applying the & operator.

impl BitAndAssign for CompressedImageFormats

fn bitand_assign(&mut self, other: CompressedImageFormats)

The bitwise and (&) of the bits in self and other.

impl BitOr for CompressedImageFormats

fn bitor(self, other: CompressedImageFormats) -> CompressedImageFormats

The bitwise or (|) of the bits in self and other.

type Output = CompressedImageFormats

The resulting type after applying the | operator.

impl BitOrAssign for CompressedImageFormats

fn bitor_assign(&mut self, other: CompressedImageFormats)

The bitwise or (|) of the bits in self and other.

impl BitXor for CompressedImageFormats

fn bitxor(self, other: CompressedImageFormats) -> CompressedImageFormats

The bitwise exclusive-or (^) of the bits in self and other.

type Output = CompressedImageFormats

The resulting type after applying the ^ operator.

impl BitXorAssign for CompressedImageFormats

fn bitxor_assign(&mut self, other: CompressedImageFormats)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for CompressedImageFormats

fn clone(&self) -> CompressedImageFormats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CompressedImageFormats

impl Debug for CompressedImageFormats

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

Formats the value using the given formatter.

impl Default for CompressedImageFormats

fn default() -> CompressedImageFormats

Returns the “default value” for a type.

impl Eq for CompressedImageFormats

impl Extend<CompressedImageFormats> for CompressedImageFormats

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = CompressedImageFormats>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for CompressedImageFormats

const FLAGS: &'static [Flag<CompressedImageFormats>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> CompressedImageFormats

Convert from a bits value exactly.

fn all_named() -> CompressedImageFormats

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in other are also set in self.

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

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in self and other.

fn difference(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<CompressedImageFormats> for CompressedImageFormats

fn from_iter<T>(iterator: T) -> CompressedImageFormats

where T: IntoIterator<Item = CompressedImageFormats>,

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for CompressedImageFormats

type Item = CompressedImageFormats

The type of the elements being iterated over.

type IntoIter = Iter<CompressedImageFormats>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <CompressedImageFormats as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for CompressedImageFormats

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

Formats the value using the given formatter.

impl Not for CompressedImageFormats

fn not(self) -> CompressedImageFormats

The bitwise negation (!) of the bits in self, truncating the result.

type Output = CompressedImageFormats

The resulting type after applying the ! operator.

impl Octal for CompressedImageFormats

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

Formats the value using the given formatter.

impl PartialEq for CompressedImageFormats

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CompressedImageFormats

impl Sub for CompressedImageFormats

fn sub(self, other: CompressedImageFormats) -> CompressedImageFormats

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = CompressedImageFormats

The resulting type after applying the - operator.

impl SubAssign for CompressedImageFormats

fn sub_assign(&mut self, other: CompressedImageFormats)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for CompressedImageFormats

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

Formats the value using the given formatter.