Struct sdl2::image::InitFlag

pub struct InitFlag { /* fields omitted */ }

InitFlags are passed to init() to control which subsystem functionality to load.

Methods

impl InitFlag

pub const JPG: InitFlag

pub const PNG: InitFlag

pub const TIF: InitFlag

pub const WEBP: InitFlag

pub const fn empty() -> InitFlag

Returns an empty set of flags

pub const fn all() -> InitFlag

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<InitFlag>

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) -> InitFlag

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

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

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: InitFlag) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for InitFlag

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

Formats the value using the given formatter.

impl BitAnd<InitFlag> for InitFlag

type Output = InitFlag

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<InitFlag> for InitFlag

fn bitand_assign(&mut self, other: InitFlag)

Disables all flags disabled in the set.

impl BitOr<InitFlag> for InitFlag

type Output = InitFlag

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<InitFlag> for InitFlag

fn bitor_assign(&mut self, other: InitFlag)

Adds the set of flags.

impl BitXor<InitFlag> for InitFlag

type Output = InitFlag

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<InitFlag> for InitFlag

fn bitxor_assign(&mut self, other: InitFlag)

Toggles the set of flags.

impl Clone for InitFlag

fn clone(&self) -> InitFlag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for InitFlag

impl Debug for InitFlag

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

Formats the value using the given formatter.

impl Display for InitFlag

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

Formats the value using the given formatter.

impl Eq for InitFlag

impl Extend<InitFlag> for InitFlag

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

Extends a collection with the contents of an iterator.

impl FromIterator<InitFlag> for InitFlag

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

Creates a value from an iterator.

impl Hash for InitFlag

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

Feeds this value into the given [Hasher].

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 InitFlag

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

Formats the value using the given formatter.

impl Not for InitFlag

type Output = InitFlag

The resulting type after applying the ! operator.

fn not(self) -> InitFlag

Returns the complement of this set of flags.

impl Octal for InitFlag

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

Formats the value using the given formatter.

impl Ord for InitFlag

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<InitFlag> for InitFlag

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

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

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

This method tests for !=.

impl PartialOrd<InitFlag> for InitFlag

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

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

fn lt(&self, other: &InitFlag) -> bool

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

fn le(&self, other: &InitFlag) -> bool

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

fn gt(&self, other: &InitFlag) -> bool

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

fn ge(&self, other: &InitFlag) -> bool

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

impl StructuralEq for InitFlag

impl StructuralPartialEq for InitFlag

impl Sub<InitFlag> for InitFlag

type Output = InitFlag

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<InitFlag> for InitFlag

fn sub_assign(&mut self, other: InitFlag)

Disables all flags enabled in the set.

impl UpperHex for InitFlag

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

Formats the value using the given formatter.