🥮 mooncakes.io

    windowing

    Backend-neutral raw window and display handle contracts for MoonBit.

    windowing
    raw-window-handle
    interop
    Download zip
    Author
    Version
    0.1.1
    License
    Apache-2.0
    Repository
    Last updated
    14 days ago
    Downloads
    3K

    #Milky2018/windowing

    Milky2018/windowing defines backend-neutral raw window and display handle contracts for MoonBit window systems and renderer libraries.

    The module does not create windows or rendering surfaces. Window libraries implement HasWindowHandle and HasDisplayHandle; renderer libraries consume the resulting structured handles.

    The current implemented producer is AppKit. Win32, Wayland, Xlib, and Xcb handle types are present as interoperability placeholders for future backends.

    #Contracts

    • HasWindowHandle produces a WindowHandle.
    • HasDisplayHandle produces a DisplayHandle.
    • WindowHandle::as_raw() and DisplayHandle::as_raw() expose a platform-specific enum at the renderer boundary.
    • Handle objects retain their provider, allowing a window implementation to keep its native owner reachable while a renderer holds the handle.

    Pointer-backed constructors reject zero addresses with HandleError::Unavailable. The provider may also return Unavailable after the underlying native object has been explicitly destroyed.

    The module deliberately has no dependency on Milky2018/window or a renderer implementation.

    DisplayHandleProvider

    source
    pub(open) trait DisplayHandleProvider {
      fn raw_display_handle(Self) -> RawDisplayHandle raise HandleError
    }

    HasDisplayHandle

    source
    pub(open) trait HasDisplayHandle {
      fn display_handle(Self) -> DisplayHandle raise HandleError
    }

    HasWindowHandle

    source
    pub(open) trait HasWindowHandle {
      fn window_handle(Self) -> WindowHandle raise HandleError
    }

    WindowHandleProvider

    source
    pub(open) trait WindowHandleProvider {
      fn raw_window_handle(Self) -> RawWindowHandle raise HandleError
    }

    HandleError

    source
    pub(all) suberror HandleError {
      Unavailable
    } derive(Eq, 
    Debug    )

    impl Show for HandleError

    HandleError::equal

    source
    fn HandleError::equal(HandleError, HandleError) -> Bool

    HandleError::not_equal

    source
    fn HandleError::not_equal(x : HandleError, y : HandleError) -> Bool

    HandleError::output

    source
    fn HandleError::output(self : HandleError, logger : &Logger) -> Unit

    HandleError::to_repr

    source

    HandleError::to_string

    source
    fn HandleError::to_string(self : HandleError) -> String

    AppKitDisplayHandle

    source
    pub struct AppKitDisplayHandle {
      // private fields
    } derive(Eq, 
    Debug    )

    AppKitDisplayHandle::equal

    source

    AppKitDisplayHandle::new

    source

    AppKitDisplayHandle::not_equal

    source

    AppKitDisplayHandle::to_repr

    source

    AppKitWindowHandle

    source
    pub struct AppKitWindowHandle {
      // private fields
    } derive(Eq, 
    Debug    )

    AppKitWindowHandle::equal

    source

    AppKitWindowHandle::new

    source
    fn AppKitWindowHandle::new(ns_view : UInt64) -> AppKitWindowHandle raise HandleError

    AppKitWindowHandle::not_equal

    source

    AppKitWindowHandle::ns_view

    source
    fn AppKitWindowHandle::ns_view(self : AppKitWindowHandle) -> UInt64

    AppKitWindowHandle::to_repr

    source

    DisplayHandle

    source
    pub struct DisplayHandle {
      // private fields
    }

    DisplayHandle::as_raw

    source

    DisplayHandle::from_provider

    source
    fn DisplayHandle::from_provider(provider : &DisplayHandleProvider) -> DisplayHandle

    DisplayHandle::to_repr

    source

    RawDisplayHandle

    source
    pub(all) enum RawDisplayHandle {
      AppKit(AppKitDisplayHandle)
      Windows(WindowsDisplayHandle)
      Wayland(WaylandDisplayHandle)
      Xlib(XlibDisplayHandle)
      Xcb(XcbDisplayHandle)
    } derive(Eq, 
    Debug    )

    RawDisplayHandle::equal

    source

    RawDisplayHandle::not_equal

    source
    fn RawDisplayHandle::not_equal(x : RawDisplayHandle, y : RawDisplayHandle) -> Bool

    RawDisplayHandle::output

    source
    fn RawDisplayHandle::output(self : RawDisplayHandle, logger : &Logger) -> Unit

    RawDisplayHandle::to_repr

    source

    RawDisplayHandle::to_string

    source
    fn RawDisplayHandle::to_string(self : RawDisplayHandle) -> String

    RawWindowHandle

    source
    pub(all) enum RawWindowHandle {
      AppKit(AppKitWindowHandle)
      Win32(Win32WindowHandle)
      Wayland(WaylandWindowHandle)
      Xlib(XlibWindowHandle)
      Xcb(XcbWindowHandle)
    } derive(Eq, 
    Debug    )

    RawWindowHandle::equal

    source

    RawWindowHandle::not_equal

    source
    fn RawWindowHandle::not_equal(x : RawWindowHandle, y : RawWindowHandle) -> Bool

    RawWindowHandle::output

    source
    fn RawWindowHandle::output(self : RawWindowHandle, logger : &Logger) -> Unit

    RawWindowHandle::to_repr

    source

    RawWindowHandle::to_string

    source
    fn RawWindowHandle::to_string(self : RawWindowHandle) -> String

    WaylandDisplayHandle

    source
    pub struct WaylandDisplayHandle {
      // private fields
    } derive(Eq, 
    Debug    )

    WaylandDisplayHandle::display

    source
    fn WaylandDisplayHandle::display(self : WaylandDisplayHandle) -> UInt64

    WaylandDisplayHandle::equal

    source

    WaylandDisplayHandle::new

    source
    fn WaylandDisplayHandle::new(display : UInt64) -> WaylandDisplayHandle raise HandleError

    WaylandDisplayHandle::not_equal

    source

    WaylandDisplayHandle::to_repr

    source

    WaylandWindowHandle

    source
    pub struct WaylandWindowHandle {
      // private fields
    } derive(Eq, 
    Debug    )

    WaylandWindowHandle::equal

    source

    WaylandWindowHandle::new

    source
    fn WaylandWindowHandle::new(surface : UInt64) -> WaylandWindowHandle raise HandleError

    WaylandWindowHandle::not_equal

    source

    WaylandWindowHandle::surface

    source
    fn WaylandWindowHandle::surface(self : WaylandWindowHandle) -> UInt64

    WaylandWindowHandle::to_repr

    source

    Win32WindowHandle

    source
    pub struct Win32WindowHandle {
      // private fields
    } derive(Eq, 
    Debug    )

    Win32WindowHandle::equal

    source

    Win32WindowHandle::hinstance

    source
    fn Win32WindowHandle::hinstance(self : Win32WindowHandle) -> UInt64?

    Win32WindowHandle::hwnd

    source
    fn Win32WindowHandle::hwnd(self : Win32WindowHandle) -> UInt64

    Win32WindowHandle::new

    source
    fn Win32WindowHandle::new(hwnd : UInt64, hinstance? : UInt64) -> Win32WindowHandle raise HandleError

    Win32WindowHandle::not_equal

    source
    fn Win32WindowHandle::not_equal(x : Win32WindowHandle, y : Win32WindowHandle) -> Bool

    Win32WindowHandle::to_repr

    source

    WindowHandle

    source
    pub struct WindowHandle {
      // private fields
    }

    WindowHandle::as_raw

    source

    WindowHandle::from_provider

    source
    fn WindowHandle::from_provider(provider : &WindowHandleProvider) -> WindowHandle

    WindowHandle::to_repr

    source

    WindowsDisplayHandle

    source
    pub struct WindowsDisplayHandle {
      // private fields
    } derive(Eq, 
    Debug    )

    WindowsDisplayHandle::equal

    source

    WindowsDisplayHandle::new

    source

    WindowsDisplayHandle::not_equal

    source

    WindowsDisplayHandle::to_repr

    source

    XcbDisplayHandle

    source
    pub struct XcbDisplayHandle {
      // private fields
    } derive(Eq, 
    Debug    )

    XcbDisplayHandle::connection

    source
    fn XcbDisplayHandle::connection(self : XcbDisplayHandle) -> UInt64?

    XcbDisplayHandle::equal

    source

    XcbDisplayHandle::new

    source
    fn XcbDisplayHandle::new(connection : UInt64?, screen : Int) -> XcbDisplayHandle

    XcbDisplayHandle::not_equal

    source
    fn XcbDisplayHandle::not_equal(x : XcbDisplayHandle, y : XcbDisplayHandle) -> Bool

    XcbDisplayHandle::screen

    source
    fn XcbDisplayHandle::screen(self : XcbDisplayHandle) -> Int

    XcbDisplayHandle::to_repr

    source

    XcbWindowHandle

    source
    pub struct XcbWindowHandle {
      // private fields
    } derive(Eq, 
    Debug    )

    XcbWindowHandle::equal

    source

    XcbWindowHandle::new

    source
    fn XcbWindowHandle::new(window : UInt, visual_id? : UInt) -> XcbWindowHandle raise HandleError

    XcbWindowHandle::not_equal

    source
    fn XcbWindowHandle::not_equal(x : XcbWindowHandle, y : XcbWindowHandle) -> Bool

    XcbWindowHandle::to_repr

    source

    XcbWindowHandle::visual_id

    source
    fn XcbWindowHandle::visual_id(self : XcbWindowHandle) -> UInt?

    XcbWindowHandle::window

    source
    fn XcbWindowHandle::window(self : XcbWindowHandle) -> UInt

    XlibDisplayHandle

    source
    pub struct XlibDisplayHandle {
      // private fields
    } derive(Eq, 
    Debug    )

    XlibDisplayHandle::display

    source
    fn XlibDisplayHandle::display(self : XlibDisplayHandle) -> UInt64?

    XlibDisplayHandle::equal

    source

    XlibDisplayHandle::new

    source
    fn XlibDisplayHandle::new(display : UInt64?, screen : Int) -> XlibDisplayHandle

    XlibDisplayHandle::not_equal

    source
    fn XlibDisplayHandle::not_equal(x : XlibDisplayHandle, y : XlibDisplayHandle) -> Bool

    XlibDisplayHandle::screen

    source
    fn XlibDisplayHandle::screen(self : XlibDisplayHandle) -> Int

    XlibDisplayHandle::to_repr

    source

    XlibWindowHandle

    source
    pub struct XlibWindowHandle {
      // private fields
    } derive(Eq, 
    Debug    )

    XlibWindowHandle::equal

    source

    XlibWindowHandle::new

    source
    fn XlibWindowHandle::new(window : UInt64, visual_id? : UInt64) -> XlibWindowHandle raise HandleError

    XlibWindowHandle::not_equal

    source
    fn XlibWindowHandle::not_equal(x : XlibWindowHandle, y : XlibWindowHandle) -> Bool

    XlibWindowHandle::to_repr

    source

    XlibWindowHandle::visual_id

    source
    fn XlibWindowHandle::visual_id(self : XlibWindowHandle) -> UInt64

    XlibWindowHandle::window

    source
    fn XlibWindowHandle::window(self : XlibWindowHandle) -> UInt64

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io