🥮 mooncakes.io

windowing

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

windowing
raw-window-handle
interop
moon add Milky2018/windowing@0.1.0
Download zip
Author
Version
0.1.0
License
Apache-2.0
Repository
Last updated
last month
Downloads
1K
README

#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

#
AppKitDisplayHandle

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

#
AppKitDisplayHandle::new

source

#
AppKitWindowHandle

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

#
AppKitWindowHandle::new

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

#
AppKitWindowHandle::ns_view

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

#
DisplayHandle

source
pub struct DisplayHandle {
  // private fields
}

#
DisplayHandle::as_raw

source

#
DisplayHandle::from_provider

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

#
RawDisplayHandle

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

#
RawWindowHandle

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

#
WaylandDisplayHandle

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

#
WaylandDisplayHandle::display

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

#
WaylandDisplayHandle::new

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

#
WaylandWindowHandle

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

#
WaylandWindowHandle::new

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

#
WaylandWindowHandle::surface

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

#
Win32WindowHandle

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

#
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

#
WindowHandle

source
pub struct WindowHandle {
  // private fields
}

#
WindowHandle::as_raw

source

#
WindowHandle::from_provider

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

#
WindowsDisplayHandle

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

#
WindowsDisplayHandle::new

source

#
XcbDisplayHandle

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

#
XcbDisplayHandle::connection

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

#
XcbDisplayHandle::new

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

#
XcbDisplayHandle::screen

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

#
XcbWindowHandle

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

#
XcbWindowHandle::new

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

#
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::new

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

#
XlibDisplayHandle::screen

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

#
XlibWindowHandle

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

#
XlibWindowHandle::new

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

#
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