Enum vulkano::swapchain::SwapchainCreationError

pub enum SwapchainCreationError {
    OomError(OomError),
    DeviceLost,
    SurfaceLost,
    SurfaceInUse,
    NativeWindowInUse,
    RequirementNotMet {
        required_for: &'static str,
        requires_one_of: RequiresOneOf,
    },
    CompositeAlphaNotSupported {
        provided: CompositeAlpha,
        supported: SupportedCompositeAlpha,
    },
    FormatColorSpaceNotSupported,
    ImageArrayLayersNotSupported {
        provided: u32,
        max_supported: u32,
    },
    ImageExtentNotSupported {
        provided: [u32; 2],
        min_supported: [u32; 2],
        max_supported: [u32; 2],
    },
    ImageExtentZeroLengthDimensions,
    ImageFormatPropertiesNotSupported,
    ImageSharingQueueFamilyIndexOutOfRange {
        queue_family_index: u32,
        queue_family_count: u32,
    },
    ImageUsageNotSupported {
        provided: ImageUsage,
        supported: ImageUsage,
    },
    MinImageCountNotSupported {
        provided: u32,
        min_supported: u32,
        max_supported: Option<u32>,
    },
    PresentModeNotSupported,
    PreTransformNotSupported {
        provided: SurfaceTransform,
        supported: SupportedSurfaceTransforms,
    },
    SwapchainAlreadyRetired,
    Win32MonitorInvalid,
}

Error that can happen when creating a Swapchain.

Variants

OomError(OomError)

Not enough memory.

DeviceLost

The device was lost.

SurfaceLost

The surface was lost.

SurfaceInUse

The surface is already used by another swapchain.

NativeWindowInUse

The window is already in use by another API.

RequirementNotMet

Fields

required_for: &'static str

requires_one_of: RequiresOneOf

CompositeAlphaNotSupported

Fields

provided: CompositeAlpha

supported: SupportedCompositeAlpha

The provided composite_alpha is not supported by the surface for this device.

FormatColorSpaceNotSupported

The provided format and color_space are not supported by the surface for this device.

ImageArrayLayersNotSupported

Fields

provided: u32

max_supported: u32

The provided image_array_layers is greater than what is supported by the surface for this device.

ImageExtentNotSupported

Fields

provided: [u32; 2]

min_supported: [u32; 2]

max_supported: [u32; 2]

The provided image_extent is not within the range supported by the surface for this device.

ImageExtentZeroLengthDimensions

The provided image_extent contained at least one dimension of zero length. This is prohibited by VUID-VkSwapchainCreateInfoKHR-imageExtent-01689 which requires both the width and height be non-zero.

This error is distinct from ImageExtentNotSupported because a surface’s minimum supported length may not enforce this rule.

ImageFormatPropertiesNotSupported

The provided image parameters are not supported as queried from image_format_properties.

ImageSharingQueueFamilyIndexOutOfRange

Fields

queue_family_index: u32

queue_family_count: u32

The provided image_sharing was set to Concurrent, but one of the specified queue family indices was out of range.

ImageUsageNotSupported

Fields

provided: ImageUsage

supported: ImageUsage

The provided image_usage has fields set that are not supported by the surface for this device.

MinImageCountNotSupported

Fields

provided: u32

min_supported: u32

max_supported: Option<u32>

The provided min_image_count is not within the range supported by the surface for this device.

PresentModeNotSupported

The provided present_mode is not supported by the surface for this device.

PreTransformNotSupported

Fields

provided: SurfaceTransform

supported: SupportedSurfaceTransforms

The provided pre_transform is not supported by the surface for this device.

SwapchainAlreadyRetired

The swapchain has already been used to create a new one.

Win32MonitorInvalid

The win32_monitor value was Some when it must be None or vice-versa.

Trait Implementations

impl Clone for SwapchainCreationError

fn clone(&self) -> SwapchainCreationError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SwapchainCreationError

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

Formats the value using the given formatter.

impl Display for SwapchainCreationError

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

Formats the value using the given formatter.

impl Error for SwapchainCreationError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide(&'a self, demand: &mut Demand<'a>)

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

Provides type based access to context intended for error reports.

impl From<OomError> for SwapchainCreationError

fn from(err: OomError) -> SwapchainCreationError

Converts to this type from the input type.

impl From<VulkanError> for SwapchainCreationError

fn from(err: VulkanError) -> SwapchainCreationError

Converts to this type from the input type.

impl PartialEq<SwapchainCreationError> for SwapchainCreationError

fn eq(&self, other: &SwapchainCreationError) -> 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 Eq for SwapchainCreationError

impl StructuralEq for SwapchainCreationError

impl StructuralPartialEq for SwapchainCreationError