Struct vulkano::swapchain::Surface [−][src]
pub struct Surface<W> { /* fields omitted */ }
Represents a surface on the screen.
Creating a Surface
is platform-specific.
Implementations
impl<W> Surface<W>
[src]
impl<W> Surface<W>
[src]pub unsafe fn from_raw_surface(
instance: Arc<Instance>,
surface: SurfaceKHR,
win: W
) -> Surface<W>
[src]
pub unsafe fn from_raw_surface(
instance: Arc<Instance>,
surface: SurfaceKHR,
win: W
) -> Surface<W>
[src]Creates a Surface
given the raw handler.
Be careful when using it
pub fn from_display_mode(
display_mode: &DisplayMode,
plane: &DisplayPlane
) -> Result<Arc<Surface<()>>, SurfaceCreationError>
[src]
pub fn from_display_mode(
display_mode: &DisplayMode,
plane: &DisplayPlane
) -> Result<Arc<Surface<()>>, SurfaceCreationError>
[src]Creates a Surface
that covers a display mode.
Panic
- Panics if
display_mode
andplane
don’t belong to the same physical device. - Panics if
plane
doesn’t support the display ofdisplay_mode
.
pub unsafe fn from_hwnd<T, U>(
instance: Arc<Instance>,
hinstance: *const T,
hwnd: *const U,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]
pub unsafe fn from_hwnd<T, U>(
instance: Arc<Instance>,
hinstance: *const T,
hwnd: *const U,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]Creates a Surface
from a Win32 window.
The surface’s min, max and current extent will always match the window’s dimensions.
Safety
The caller must ensure that the hinstance
and the hwnd
are both correct and stay
alive for the entire lifetime of the 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>
[src]
pub unsafe fn from_xcb<C>(
instance: Arc<Instance>,
connection: *const C,
window: u32,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]Creates a Surface
from an XCB window.
The surface’s min, max and current extent will always match the window’s dimensions.
Safety
The caller must ensure that the connection
and the window
are both correct and stay
alive for the entire lifetime of the 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>
[src]
pub unsafe fn from_xlib<D>(
instance: Arc<Instance>,
display: *const D,
window: c_ulong,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]Creates a Surface
from an Xlib window.
The surface’s min, max and current extent will always match the window’s dimensions.
Safety
The caller must ensure that the display
and the window
are both correct and stay
alive for the entire lifetime of the 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>
[src]
pub unsafe fn from_wayland<D, S>(
instance: Arc<Instance>,
display: *const D,
surface: *const S,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]Creates a Surface
from a Wayland window.
The window’s dimensions will be set to the size of the swapchain.
Safety
The caller must ensure that the display
and the surface
are both correct and stay
alive for the entire lifetime of the surface. The win
parameter can be used to ensure this.
pub unsafe fn from_anativewindow<T>(
instance: Arc<Instance>,
window: *const T,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]
pub unsafe fn from_anativewindow<T>(
instance: Arc<Instance>,
window: *const T,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]Creates a Surface
from an Android window.
Safety
The caller must ensure that the window
is correct and stays alive for the entire
lifetime of the surface. The win
parameter can be used to ensure this.
pub unsafe fn from_ios_moltenvk<T>(
instance: Arc<Instance>,
view: *const T,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]
pub unsafe fn from_ios_moltenvk<T>(
instance: Arc<Instance>,
view: *const T,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]Creates a Surface
from an iOS UIView
.
Safety
- The caller must ensure that the
view
is correct and stays alive for the entire lifetime of the surface. The win parameter can be used to ensure this. - The
UIView
must be backed by aCALayer
instance of typeCAMetalLayer
.
pub unsafe fn from_macos_moltenvk<T>(
instance: Arc<Instance>,
view: *const T,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]
pub unsafe fn from_macos_moltenvk<T>(
instance: Arc<Instance>,
view: *const T,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]Creates a Surface
from a MacOS NSView
.
Safety
- The caller must ensure that the
view
is correct and stays alive for the entire lifetime of the surface. Thewin
parameter can be used to ensure this. - The
NSView
must be backed by aCALayer
instance of typeCAMetalLayer
.
pub unsafe fn from_vi_surface<T>(
instance: Arc<Instance>,
window: *const T,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]
pub unsafe fn from_vi_surface<T>(
instance: Arc<Instance>,
window: *const T,
win: W
) -> Result<Arc<Surface<W>>, SurfaceCreationError>
[src]Creates a Surface
from a code:nn::code:vi::code:Layer
.
Safety
The caller must ensure that the window
is correct and stays alive for the entire
lifetime of the surface. The win
parameter can be used to ensure this.
pub fn is_supported(
&self,
queue: QueueFamily<'_>
) -> Result<bool, CapabilitiesError>
[src]
pub fn is_supported(
&self,
queue: QueueFamily<'_>
) -> Result<bool, CapabilitiesError>
[src]Returns true if the given queue family can draw on this surface.
pub fn capabilities(
&self,
device: PhysicalDevice<'_>
) -> Result<Capabilities, CapabilitiesError>
[src]
pub fn capabilities(
&self,
device: PhysicalDevice<'_>
) -> Result<Capabilities, CapabilitiesError>
[src]pub fn window(&self) -> &W
[src]
Trait Implementations
impl<W> VulkanObject for Surface<W>
[src]
impl<W> VulkanObject for Surface<W>
[src]type Object = SurfaceKHR
type Object = SurfaceKHR
The type of the object.
const TYPE: ObjectType
[src]
const TYPE: ObjectType
[src]The ObjectType
of the internal Vulkan handle.
fn internal_object(&self) -> SurfaceKHR
[src]
fn internal_object(&self) -> SurfaceKHR
[src]Returns a reference to the object.
Auto Trait Implementations
impl<W> RefUnwindSafe for Surface<W> where
W: RefUnwindSafe,
W: RefUnwindSafe,
impl<W> Send for Surface<W> where
W: Send,
W: Send,
impl<W> Sync for Surface<W> where
W: Sync,
W: Sync,
impl<W> Unpin for Surface<W> where
W: Unpin,
W: Unpin,
impl<W> UnwindSafe for Surface<W> where
W: UnwindSafe,
W: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Content for T
[src]
impl<T> Content for T
[src]pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]
pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]Builds a pointer to this type from a raw pointer.
pub fn is_size_suitable(usize) -> bool
[src]
pub fn is_size_suitable(usize) -> bool
[src]Returns true if the size is suitable to store a type like this.
pub fn indiv_size() -> usize
[src]
pub fn indiv_size() -> usize
[src]Returns the size of an individual element.