Struct basis_universal::transcoding::DecodeFlags

pub struct DecodeFlags { /* fields omitted */ }

Implementations

impl DecodeFlags

pub const PVRTC_DECODE_TO_NEXT_POW_2: DecodeFlags

PVRTC1: decode non-pow2 ETC1S texture level to the next larger power of 2 (not implemented yet, but we're going to support it). Ignored if the slice's dimensions are already a power of 2.

pub const TRANSCODE_ALPHA_DATA_TO_OPAQUE_FORMATS: DecodeFlags

When decoding to an opaque texture format, if the basis file has alpha, decode the alpha slice instead of the color slice to the output texture format. This is primarily to allow decoding of textures with alpha to multiple ETC1 textures (one for color, another for alpha).

pub const BC1_FORBID_THREE_COLOR_BLOCKS: DecodeFlags

Forbid usage of BC1 3 color blocks (we don't support BC1 punchthrough alpha yet). This flag is used internally when decoding to BC3.

pub const OUTPUT_HAS_ALPHA_INDICES: DecodeFlags

The output buffer contains alpha endpoint/selector indices. Used internally when decoding formats like ASTC that require both color and alpha data to be available when transcoding to the output format.

pub const HIGH_QULITY: DecodeFlags

pub const fn empty() -> DecodeFlags

Returns an empty set of flags

pub const fn all() -> DecodeFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> DecodeFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for DecodeFlags

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

Formats the value using the given formatter.

impl BitAnd<DecodeFlags> for DecodeFlags

type Output = DecodeFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<DecodeFlags> for DecodeFlags

fn bitand_assign(&mut self, other: DecodeFlags)

Disables all flags disabled in the set.

impl BitOr<DecodeFlags> for DecodeFlags

type Output = DecodeFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<DecodeFlags> for DecodeFlags

fn bitor_assign(&mut self, other: DecodeFlags)

Adds the set of flags.

impl BitXor<DecodeFlags> for DecodeFlags

type Output = DecodeFlags

The resulting type after applying the ^ operator.

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

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<DecodeFlags> for DecodeFlags

fn bitxor_assign(&mut self, other: DecodeFlags)

Toggles the set of flags.

impl Clone for DecodeFlags

fn clone(&self) -> DecodeFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DecodeFlags

impl Debug for DecodeFlags

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

Formats the value using the given formatter.

impl Eq for DecodeFlags

impl Extend<DecodeFlags> for DecodeFlags

fn extend<T: IntoIterator<Item = DecodeFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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 FromIterator<DecodeFlags> for DecodeFlags

fn from_iter<T: IntoIterator<Item = DecodeFlags>>(iterator: T) -> DecodeFlags

Creates a value from an iterator.

impl Hash for DecodeFlags

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for DecodeFlags

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

Formats the value using the given formatter.

impl Not for DecodeFlags

type Output = DecodeFlags

The resulting type after applying the ! operator.

fn not(self) -> DecodeFlags

Returns the complement of this set of flags.

impl Octal for DecodeFlags

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

Formats the value using the given formatter.

impl Ord for DecodeFlags

fn cmp(&self, other: &DecodeFlags) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<DecodeFlags> for DecodeFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<DecodeFlags> for DecodeFlags

fn partial_cmp(&self, other: &DecodeFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for DecodeFlags

impl StructuralPartialEq for DecodeFlags

impl Sub<DecodeFlags> for DecodeFlags

type Output = DecodeFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<DecodeFlags> for DecodeFlags

fn sub_assign(&mut self, other: DecodeFlags)

Disables all flags enabled in the set.

impl UpperHex for DecodeFlags

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

Formats the value using the given formatter.