Skip to main content

SurfaceCapabilities

Struct SurfaceCapabilities 

Source
pub struct SurfaceCapabilities {
    pub formats: Vec<TextureFormat>,
    pub format_capabilities: Vec<SurfaceFormatCapabilities>,
    pub present_modes: Vec<PresentMode>,
    pub alpha_modes: Vec<CompositeAlphaMode>,
    pub usages: TextureUsages,
}
Expand description

Defines the capabilities of a given surface and adapter.

Fields§

§formats: Vec<TextureFormat>

List of supported formats to use with the given adapter. The first format in the vector is preferred.

Only contains formats that can be configured with the default SurfaceColorSpace::Auto; formats available exclusively in explicit-opt-in (wide-gamut / HDR) color spaces appear only in format_capabilities.

Returns an empty vector if the surface is incompatible with the adapter.

§format_capabilities: Vec<SurfaceFormatCapabilities>

List of supported formats together with the color spaces supported for each format, in the same preference order as formats, of which it is a superset.

Returns an empty vector if the surface is incompatible with the adapter.

§present_modes: Vec<PresentMode>

List of supported presentation modes to use with the given adapter.

Returns an empty vector if the surface is incompatible with the adapter.

§alpha_modes: Vec<CompositeAlphaMode>

List of supported alpha modes to use with the given adapter.

Will return at least one element, CompositeAlphaMode::Opaque or CompositeAlphaMode::Inherit.

§usages: TextureUsages

Bitflag of supported texture usages for the surface to use with the given adapter.

The usage TextureUsages::RENDER_ATTACHMENT is guaranteed.

Implementations§

Source§

impl SurfaceCapabilities

Source

pub fn color_spaces(&self, format: TextureFormat) -> SurfaceColorSpaces

Returns the set of color spaces supported for the given format, or an empty set if the format is not supported.

This is a convenience lookup over format_capabilities: an empty result means format is absent from that list.

Trait Implementations§

Source§

impl Debug for SurfaceCapabilities

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SurfaceCapabilities

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more