Struct Surface

pub struct Surface {
    inner: ManuallyDrop<Box<dyn Surface>>,
    swapchain: RwLock<Option<Box<dyn Swapchain>>>,
}

Fields

inner: ManuallyDrop<Box<dyn Surface>>

swapchain: RwLock<Option<Box<dyn Swapchain>>>

Implementations

impl Surface

pub unsafe fn raw_native_handle(&self) -> Option<SurfaceKHR>

Returns the raw Vulkan surface handle.

Returns None if the surface is a DXGI surface.

pub fn raw_native_swapchain(&self) -> Option<SwapchainKHR>

Get the raw Vulkan swapchain associated with this surface.

Returns None if the surface is not configured or if the swapchain is a DXGI swapchain.

pub fn set_next_present_time(&self, present_timing: PresentTimeGOOGLE)

Set the present timing information which will be used for the next presentation of this surface, using VK_GOOGLE_display_timing.

This can be used to give an id to presentations, for future use of [vk::PastPresentationTimingGOOGLE]. Note that wgpu-hal does not provide a way to use that API - you should manually access this through [ash].

This can also be used to add a “not before” timestamp to the presentation.

The exact semantics of the fields are also documented in the specification for the extension.

Panics

• If the surface hasn’t been configured.
• If the surface has been configured for a DXGI swapchain.
• If the device doesn’t support present timing.

Trait Implementations

impl Drop for Surface

fn drop(&mut self)

Executes the destructor for this type.

impl DynResource for Surface

fn as_any(&self) -> &dyn Any

fn as_any_mut(&mut self) -> &mut dyn Any

impl Surface for Surface

type A = Api

unsafe fn configure( &self, device: &Device, config: &SurfaceConfiguration, ) -> Result<(), SurfaceError>

Configure self to use device.

unsafe fn unconfigure(&self, device: &Device)

Unconfigure self on device.

unsafe fn acquire_texture( &self, timeout: Option<Duration>, fence: &Fence, ) -> Result<Option<AcquiredSurfaceTexture<Api>>, SurfaceError>

Return the next texture to be presented by self, for the caller to draw on.

unsafe fn discard_texture(&self, texture: SurfaceTexture)

Relinquish an acquired texture without presenting it.