Struct vulkano::swapchain::Surface

pub struct Surface<W> { /* private fields */ }

Represents a surface on the screen.

Creating a Surface is platform-specific.

Implementations

impl<W> Surface<W>

pub unsafe fn from_raw_surface(
    instance: Arc<Instance>,
    handle: SurfaceKHR,
    api: SurfaceApi,
    win: W
) -> Surface<W>

Creates a Surface given the raw handle.

Safety

• handle must be a valid Vulkan surface handle owned by instance.
• handle must have been created from api.
• The window object that handle was created from must outlive the created Surface. The win parameter can be used to ensure this.

pub fn from_display_plane(
    display_mode: &DisplayMode,
    plane: &DisplayPlane
) -> Result<Arc<Surface<()>>, SurfaceCreationError>

Creates a Surface from a DisplayPlane.

Panic

• Panics if display_mode and plane don’t belong to the same physical device.
• Panics if plane doesn’t support the display of display_mode.

pub unsafe fn from_android<T>(
    instance: Arc<Instance>,
    window: *const T,
    win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>

Creates a Surface from an Android window.

Safety

• window must be a valid handle.
• The object referred to by window must outlive the created Surface. The win parameter can be used to ensure this.

pub unsafe fn from_ios<T>(
    instance: Arc<Instance>,
    view: *const T,
    win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>

Creates a Surface from an iOS UIView.

Safety

• view must be a valid handle.
• The object referred to by view must outlive the created Surface. The win parameter can be used to ensure this.
• The UIView must be backed by a CALayer instance of type CAMetalLayer.

pub unsafe fn from_mac_os<T>(
    instance: Arc<Instance>,
    view: *const T,
    win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>

Creates a Surface from a MacOS NSView.

Safety

• view must be a valid handle.
• The object referred to by view must outlive the created Surface. The win parameter can be used to ensure this.
• The NSView must be backed by a CALayer instance of type CAMetalLayer.

pub unsafe fn from_metal<T>(
    instance: Arc<Instance>,
    layer: *const T,
    win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>

Creates a Surface from a Metal CAMetalLayer.

Safety

• layer must be a valid handle.
• The object referred to by layer must outlive the created Surface. The win parameter can be used to ensure this.

pub unsafe fn from_vi<T>(
    instance: Arc<Instance>,
    window: *const T,
    win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>

Creates a Surface from a code:nn::code:vi::code:Layer.

Safety

• window must be a valid handle.
• The object referred to by window must outlive the created Surface. The win parameter can be used to ensure this.

pub unsafe fn from_wayland<D, S>(
    instance: Arc<Instance>,
    display: *const D,
    surface: *const S,
    win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>

Creates a Surface from a Wayland window.

The window’s dimensions will be set to the size of the swapchain.

Safety

• display and surface must be valid handles.
• The objects referred to by display and surface must outlive the created Surface. The win parameter can be used to ensure this.

pub unsafe fn from_win32<T, U>(
    instance: Arc<Instance>,
    hinstance: *const T,
    hwnd: *const U,
    win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>

Creates a Surface from a Win32 window.

The surface’s min, max and current extent will always match the window’s dimensions.

Safety

• hinstance and hwnd must be valid handles.
• The objects referred to by hwnd and hinstance must outlive the created Surface. The win parameter can be used to ensure this.

pub unsafe fn from_xcb<C>(
    instance: Arc<Instance>,
    connection: *const C,
    window: u32,
    win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>

Creates a Surface from an XCB window.

The surface’s min, max and current extent will always match the window’s dimensions.

Safety

• connection and window must be valid handles.
• The objects referred to by connection and window must outlive the created Surface. The win parameter can be used to ensure this.

pub unsafe fn from_xlib<D>(
    instance: Arc<Instance>,
    display: *const D,
    window: c_ulong,
    win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>

Creates a Surface from an Xlib window.

The surface’s min, max and current extent will always match the window’s dimensions.

Safety

• display and window must be valid handles.
• The objects referred to by display and window must outlive the created Surface. The win parameter can be used to ensure this.

pub fn instance(&self) -> &Arc<Instance>

Returns the instance this surface was created with.

pub fn api(&self) -> SurfaceApi

Returns the windowing API that was used to construct the surface.

pub fn window(&self) -> &W

Returns a reference to the W type parameter that was passed when creating the surface.

Trait Implementations

impl<W> Debug for Surface<W>

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

Formats the value using the given formatter.

impl<W> Drop for Surface<W>

fn drop(&mut self)

Executes the destructor for this type.

impl<W> Hash for Surface<W>

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<W> PartialEq<Surface<W>> for Surface<W>

fn eq(&self, other: &Self) -> 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 !=.

impl<W> VulkanObject for Surface<W>

type Object = SurfaceKHR

The type of the object.

fn internal_object(&self) -> SurfaceKHR

Returns a reference to the object.

impl<W> Eq for Surface<W>