Struct maplibre::render::settings::Backends

#[repr(transparent)]
pub struct Backends(pub(crate) <Backends as PublicFlags>::Internal);

Represents the backends that wgpu will use.

Tuple Fields

0: <Backends as PublicFlags>::Internal

Implementations

impl Backends

pub const VULKAN: Backends = Self::from_bits_retain(1 << Backend::Vulkan as u32)

Supported on Windows, Linux/Android, and macOS/iOS via Vulkan Portability (with the Vulkan feature enabled)

pub const GL: Backends = Self::from_bits_retain(1 << Backend::Gl as u32)

Supported on Linux/Android, the web through webassembly via WebGL, and Windows and macOS/iOS via ANGLE

pub const METAL: Backends = Self::from_bits_retain(1 << Backend::Metal as u32)

Supported on macOS/iOS

pub const DX12: Backends = Self::from_bits_retain(1 << Backend::Dx12 as u32)

Supported on Windows 10

pub const DX11: Backends = Self::from_bits_retain(1 << Backend::Dx11 as u32)

Supported on Windows 7+

pub const BROWSER_WEBGPU: Backends = Self::from_bits_retain(1 << Backend::BrowserWebGpu as u32)

Supported when targeting the web through webassembly

pub const PRIMARY: Backends = Self::from_bits_retain(Self::VULKAN.bits() | Self::METAL.bits() | Self::DX12.bits() | Self::BROWSER_WEBGPU.bits())

All the apis that wgpu offers first tier of support for.

Vulkan + Metal + DX12 + Browser WebGPU

pub const SECONDARY: Backends = Self::from_bits_retain(Self::GL.bits() | Self::DX11.bits())

All the apis that wgpu offers second tier of support for. These may be unsupported/still experimental.

OpenGL + DX11

impl Backends

pub const fn empty() -> Backends

Returns an empty set of flags.

pub const fn all() -> Backends

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

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

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

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

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

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the 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: Backends) -> bool

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

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

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

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

Inserts the specified flags in-place.

This method is equivalent to union.

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

Removes the specified flags in-place.

This method is equivalent to difference.

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

Toggles the specified flags in-place.

This method is equivalent to symmetric_difference.

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

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

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

Returns the intersection between the flags in self and other.

Calculating self bitwise and (&) other, including any bits that don’t correspond to a defined flag.

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

Returns the union of between the flags in self and other.

Calculates self bitwise or (|) other, including any bits that don’t correspond to a defined flag.

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

Returns the difference between the flags in self and other.

Calculates self bitwise and (&!) the bitwise negation of other, including any bits that don’t correspond to a defined flag.

This method is not equivalent to a & !b when there are bits set that don’t correspond to a defined flag. The ! operator will unset any bits that don’t correspond to a flag, so they’ll always be unset by a &! b, but respected by a.difference(b).

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

Returns the symmetric difference between the flags in self and other.

Calculates self bitwise exclusive or (^) other, including any bits that don’t correspond to a defined flag.

pub const fn complement(self) -> Backends

Returns the complement of this set of flags.

Calculates the bitwise negation (!) of self, unsetting any bits that don’t correspond to a defined flag.

impl Backends

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

Iterate over enabled flag values.

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

Iterate over enabled flag values with their stringified names.

impl Backends

pub fn contains_invalid_bits(&self) -> bool

Returns true if the bitflags contains bits that are not part of the bitflags definition.

Trait Implementations

impl Binary for Backends

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

Formats the value using the given formatter.

impl BitAnd<Backends> for Backends

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

Returns the intersection between the two sets of flags.

type Output = Backends

The resulting type after applying the & operator.

impl BitAndAssign<Backends> for Backends

fn bitand_assign(&mut self, other: Backends)

Disables all flags disabled in the set.

impl BitOr<Backends> for Backends

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

Returns the union of the two sets of flags.

type Output = Backends

The resulting type after applying the | operator.

impl BitOrAssign<Backends> for Backends

fn bitor_assign(&mut self, other: Backends)

Adds the set of flags.

impl BitXor<Backends> for Backends

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

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

type Output = Backends

The resulting type after applying the ^ operator.

impl BitXorAssign<Backends> for Backends

fn bitxor_assign(&mut self, other: Backends)

Toggles the set of flags.

impl Clone for Backends

fn clone(&self) -> Backends

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Backends

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

Formats the value using the given formatter.

impl Extend<Backends> for Backends

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

Extends a collection with the contents of an iterator.

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 Backends

const FLAGS: &'static [Flag<Backends>] = &[{ ::bitflags::Flag::new("VULKAN", Backends::VULKAN) }, { ::bitflags::Flag::new("GL", Backends::GL) }, { ::bitflags::Flag::new("METAL", Backends::METAL) }, { ::bitflags::Flag::new("DX12", Backends::DX12) }, { ::bitflags::Flag::new("DX11", Backends::DX11) }, { ::bitflags::Flag::new("BROWSER_WEBGPU", Backends::BROWSER_WEBGPU) }, { ::bitflags::Flag::new("PRIMARY", Backends::PRIMARY) }, { ::bitflags::Flag::new("SECONDARY", Backends::SECONDARY) }]

The set of available flags and their names.

type Bits = u32

The underlying storage type.

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

fn from_bits_retain(bits: u32) -> Backends

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

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

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

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

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

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

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

Get the flag for a particular name.

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

Iterate over enabled flag values.

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

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

fn remove(&mut self, other: Self)

Removes the specified flags in-place.

fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

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

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

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

Returns the intersection between the flags in self and other.

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

Returns the union of between the flags in self and other.

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

Returns the difference between the flags in self and other.

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

Returns the symmetric difference between the flags in self and other.

fn complement(self) -> Self

Returns the complement of this set of flags.

impl From<Backend> for Backends

fn from(backend: Backend) -> Backends

Converts to this type from the input type.

impl FromIterator<Backends> for Backends

fn from_iter<T>(iterator: T) -> Backendswhere
    T: IntoIterator<Item = Backends>,

Creates a value from an iterator.

impl Hash for Backends

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

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 IntoIterator for Backends

type Item = Backends

The type of the elements being iterated over.

type IntoIter = Iter<Backends>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for Backends

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

Formats the value using the given formatter.

impl Not for Backends

fn not(self) -> Backends

Returns the complement of this set of flags.

type Output = Backends

The resulting type after applying the ! operator.

impl Octal for Backends

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

Formats the value using the given formatter.

impl PartialEq<Backends> for Backends

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<Backends> for Backends

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

Returns the set difference of the two sets of flags.

type Output = Backends

The resulting type after applying the - operator.

impl SubAssign<Backends> for Backends

fn sub_assign(&mut self, other: Backends)

Disables all flags enabled in the set.

impl UpperHex for Backends

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

Formats the value using the given formatter.

impl Copy for Backends

impl Eq for Backends

impl StructuralEq for Backends

impl StructuralPartialEq for Backends