Struct draw2d::GlfwWindow

pub struct GlfwWindow {
    pub glfw: Glfw,
    pub window: Window,
    pub event_receiver: EventReceiver,
    // some fields omitted
}

Resources required for rendering to a single GLFW window.

Fields

glfw: Glfw

The glfw library instance

window: Window

The glfw window

event_receiver: EventReceiver

The event reciever. Usually consumed by the application’s main loop.

Implementations

impl GlfwWindow

pub fn new<F>(create_window: F) -> Result<Self> where
    F: FnOnce(&mut Glfw) -> Result<(Window, EventReceiver)>, 

Create a new application window and vulkan surface.

It’s safe to clone the the resulting window, but it is not safe to use glfw window functions from any thread but the main thread. (the thread where this new function was invoked).

pub fn fullscreen(title: &str) -> Result<Self>

Create a new fullscreen window using the primary monitor.

pub fn windowed(title: &str, width: u32, height: u32) -> Result<Self>

Create a new non-fullscreen window.

pub fn poll_events(&mut self) -> Vec<(f64, WindowEvent)>

Poll glfw for window events

Trait Implementations

impl Drop for GlfwWindow

fn drop(&mut self)

Executes the destructor for this type.

impl WindowSurface for GlfwWindow

fn clone_vulkan_instance(&self) -> Arc<Instance>

clone the instance created by this window surface

fn framebuffer_size(&self) -> (u32, u32)

Yield the window’s current framebuffer size.

The size is in physical pixels and is meant to be used directly in the swapchain extent.

unsafe fn get_surface_handle(&self) -> SurfaceKHR

Get the raw surface handle.

Unsafe because the the WindowSurface itself is responsible for the lifetime of the real surface object. The caller should not retain this handle except for the creation of other vulkan resources which will not outlive the window surface.

unsafe fn get_physical_device_surface_support(
    &self,
    physical_device: &PhysicalDevice,
    queue_family_index: u32
) -> Result<bool>

Check that a physical device supports rendering to this surface.

Unsafe because the device’s supported extensions must be checked prior to querying for queue presentation support.

unsafe fn supported_formats(
    &self,
    physical_device: &PhysicalDevice
) -> Vec<SurfaceFormatKHR>

Returns the set of all supported formats for this device.

Unsafe because the device’s supported extensions must be checked prior to querying the surface formats.

unsafe fn supported_presentation_modes(
    &self,
    physical_device: &PhysicalDevice
) -> Vec<PresentModeKHR>

Returns the set of all supported presentation modes for this device.

Unsafe because the device’s supported extensions must be checked prior to querying the presentation modes.

unsafe fn surface_capabilities(
    &self,
    physical_device: &PhysicalDevice
) -> Result<SurfaceCapabilitiesKHR>

Returns the set of all supported surface capabilities.

Unsafe because the device’s supported extensions must be checked prior to querying the surface capabilities.