Struct stockton_bsp::lumps::textures::ContentsFlags

pub struct ContentsFlags { /* fields omitted */ }

Extracted from the Q3 arena engine code. Less documented than SurfaceFlags. https://github.com/id-Software/Quake-III-Arena/blob/master/code/game/surfaceflags.h

Implementations

impl ContentsFlags

pub const SOLID: ContentsFlags

pub const LAVA: ContentsFlags

pub const SLIME: ContentsFlags

pub const WATER: ContentsFlags

pub const FOG: ContentsFlags

pub const NOT_TEAM1: ContentsFlags

pub const NOT_TEAM2: ContentsFlags

pub const NOT_BOT_CLIP: ContentsFlags

pub const AREA_PORTAL: ContentsFlags

pub const PLAYER_CLIP: ContentsFlags

bot specific contents type

pub const MONSTER_CLIP: ContentsFlags

bot specific contents type

pub const TELEPORTER: ContentsFlags

pub const JUMP_PAD: ContentsFlags

pub const CLUSTER_PORTAL: ContentsFlags

pub const DO_NOT_ENTER: ContentsFlags

pub const BOT_CLIP: ContentsFlags

pub const MOVER: ContentsFlags

pub const ORIGIN: ContentsFlags

pub const BODY: ContentsFlags

pub const DETAIL: ContentsFlags

brush not used for the bsp

pub const CORPSE: ContentsFlags

brush not used for the bsp

pub const STRUCTURAL: ContentsFlags

brushes used for the bsp

pub const TRANSLUCENT: ContentsFlags

don't consume surface fragments inside

pub const TRIGGER: ContentsFlags

pub const NODROP: ContentsFlags

don't leave bodies or items (death fog, lava)

pub const fn empty() -> ContentsFlags

Returns an empty set of flags

pub const fn all() -> ContentsFlags

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

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for ContentsFlags

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

Formats the value using the given formatter.

impl BitAnd<ContentsFlags> for ContentsFlags

type Output = ContentsFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<ContentsFlags> for ContentsFlags

fn bitand_assign(&mut self, other: ContentsFlags)

Disables all flags disabled in the set.

impl BitOr<ContentsFlags> for ContentsFlags

type Output = ContentsFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<ContentsFlags> for ContentsFlags

fn bitor_assign(&mut self, other: ContentsFlags)

Adds the set of flags.

impl BitXor<ContentsFlags> for ContentsFlags

type Output = ContentsFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<ContentsFlags> for ContentsFlags

fn bitxor_assign(&mut self, other: ContentsFlags)

Toggles the set of flags.

impl Clone for ContentsFlags

fn clone(&self) -> ContentsFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ContentsFlags

impl Debug for ContentsFlags

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

Formats the value using the given formatter.

impl Eq for ContentsFlags

impl Extend<ContentsFlags> for ContentsFlags

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

Extends a collection with the contents of an iterator.

impl FromIterator<ContentsFlags> for ContentsFlags

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

Creates a value from an iterator.

impl Hash for ContentsFlags

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 ContentsFlags

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

Formats the value using the given formatter.

impl Not for ContentsFlags

type Output = ContentsFlags

The resulting type after applying the ! operator.

fn not(self) -> ContentsFlags

Returns the complement of this set of flags.

impl Octal for ContentsFlags

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

Formats the value using the given formatter.

impl Ord for ContentsFlags

fn cmp(&self, other: &ContentsFlags) -> 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<ContentsFlags> for ContentsFlags

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

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

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

This method tests for !=.

impl PartialOrd<ContentsFlags> for ContentsFlags

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ContentsFlags

impl StructuralPartialEq for ContentsFlags

impl Sub<ContentsFlags> for ContentsFlags

type Output = ContentsFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ContentsFlags> for ContentsFlags

fn sub_assign(&mut self, other: ContentsFlags)

Disables all flags enabled in the set.

impl UpperHex for ContentsFlags

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

Formats the value using the given formatter.