Struct ddsfile::HeaderFlags
[−]
pub struct HeaderFlags { /* fields omitted */ }
Methods
impl HeaderFlags
pub const CAPS: HeaderFlags
CAPS: HeaderFlags = HeaderFlags{bits: 1,}
Required in every DDS file
pub const HEIGHT: HeaderFlags
HEIGHT: HeaderFlags = HeaderFlags{bits: 2,}
Required in every DDS file
pub const WIDTH: HeaderFlags
WIDTH: HeaderFlags = HeaderFlags{bits: 4,}
Required in every DDS file
pub const PITCH: HeaderFlags
PITCH: HeaderFlags = HeaderFlags{bits: 8,}
Required when pitch is provided for an uncompressed texture
pub const PIXELFORMAT: HeaderFlags
PIXELFORMAT: HeaderFlags = HeaderFlags{bits: 4096,}
Required in every DDS file
pub const MIPMAPCOUNT: HeaderFlags
MIPMAPCOUNT: HeaderFlags = HeaderFlags{bits: 131072,}
Required in a mipmapped texture
pub const LINEARSIZE: HeaderFlags
LINEARSIZE: HeaderFlags = HeaderFlags{bits: 524288,}
Required when pitch is provided for a compressed texture
pub const DEPTH: HeaderFlags
DEPTH: HeaderFlags = HeaderFlags{bits: 8388608,}
Required in a depth texture
pub fn empty() -> HeaderFlags
Returns an empty set of flags.
pub fn all() -> HeaderFlags
Returns the set containing all flags.
pub fn bits(&self) -> u32
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u32) -> Option<HeaderFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub fn from_bits_truncate(bits: u32) -> HeaderFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub fn is_empty(&self) -> bool
Returns true if no flags are currently stored.
pub fn is_all(&self) -> bool
Returns true if all flags are currently set.
pub fn intersects(&self, other: HeaderFlags) -> bool
Returns true if there are flags common to both self and other.
pub fn contains(&self, other: HeaderFlags) -> bool
Returns true all of the flags in other are contained within self.
pub fn insert(&mut self, other: HeaderFlags)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: HeaderFlags)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: HeaderFlags)
Toggles the specified flags in-place.
pub fn set(&mut self, other: HeaderFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl Copy for HeaderFlags
impl PartialEq for HeaderFlags
fn eq(&self, __arg_0: &HeaderFlags) -> bool
This method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, __arg_0: &HeaderFlags) -> bool
This method tests for !=.
impl Eq for HeaderFlags
impl Clone for HeaderFlags
fn clone(&self) -> HeaderFlags
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
Performs copy-assignment from source. Read more
impl PartialOrd for HeaderFlags
fn partial_cmp(&self, __arg_0: &HeaderFlags) -> Option<Ordering>
This method returns an ordering between self and other values if one exists. Read more
fn lt(&self, __arg_0: &HeaderFlags) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
fn le(&self, __arg_0: &HeaderFlags) -> bool
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
fn gt(&self, __arg_0: &HeaderFlags) -> bool
This method tests greater than (for self and other) and is used by the > operator. Read more
fn ge(&self, __arg_0: &HeaderFlags) -> bool
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
impl Ord for HeaderFlags
fn cmp(&self, __arg_0: &HeaderFlags) -> Ordering
This method returns an Ordering between self and other. Read more
fn max(self, other: Self) -> Self1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Hash for HeaderFlags
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
Feeds this value into the given [Hasher]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, 1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher]. Read more
impl Debug for HeaderFlags
impl Binary for HeaderFlags
impl Octal for HeaderFlags
impl LowerHex for HeaderFlags
impl UpperHex for HeaderFlags
impl BitOr for HeaderFlags
type Output = HeaderFlags
The resulting type after applying the | operator.
fn bitor(self, other: HeaderFlags) -> HeaderFlags
Returns the union of the two sets of flags.
impl BitOrAssign for HeaderFlags
fn bitor_assign(&mut self, other: HeaderFlags)
Adds the set of flags.
impl BitXor for HeaderFlags
type Output = HeaderFlags
The resulting type after applying the ^ operator.
fn bitxor(self, other: HeaderFlags) -> HeaderFlags
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign for HeaderFlags
fn bitxor_assign(&mut self, other: HeaderFlags)
Toggles the set of flags.
impl BitAnd for HeaderFlags
type Output = HeaderFlags
The resulting type after applying the & operator.
fn bitand(self, other: HeaderFlags) -> HeaderFlags
Returns the intersection between the two sets of flags.
impl BitAndAssign for HeaderFlags
fn bitand_assign(&mut self, other: HeaderFlags)
Disables all flags disabled in the set.
impl Sub for HeaderFlags
type Output = HeaderFlags
The resulting type after applying the - operator.
fn sub(self, other: HeaderFlags) -> HeaderFlags
Returns the set difference of the two sets of flags.
impl SubAssign for HeaderFlags
fn sub_assign(&mut self, other: HeaderFlags)
Disables all flags enabled in the set.
impl Not for HeaderFlags
type Output = HeaderFlags
The resulting type after applying the ! operator.
fn not(self) -> HeaderFlags
Returns the complement of this set of flags.
impl Extend<HeaderFlags> for HeaderFlags
fn extend<T: IntoIterator<Item = HeaderFlags>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
impl FromIterator<HeaderFlags> for HeaderFlags
fn from_iter<T: IntoIterator<Item = HeaderFlags>>(iterator: T) -> HeaderFlags
Creates a value from an iterator. Read more