Files

ab_glyph_rasterizer

geometry.rslib.rsraster.rs

adler

algo.rslib.rs

adler32

lib.rs

andrew

shapes

mod.rsrectangle.rs

text

fontconfig.rsmod.rs

lib.rsline.rs

bitflags

lib.rs

bytemuck

contiguous.rslib.rsoffset_of.rspod.rstransparent.rszeroable.rs

byteorder

io.rslib.rs

calloop

sources

channel.rsgeneric.rsmod.rsping.rssignals.rstimer.rs

sys

epoll.rsmod.rs

lib.rslist.rsloop_logic.rs

cfg_if

lib.rs

color_quant

lib.rsmath.rs

crc32fast

specialized

mod.rspclmulqdq.rs

baseline.rscombine.rslib.rstable.rs

crossbeam_channel

flavors

array.rsat.rslist.rsmod.rsnever.rstick.rszero.rs

channel.rscontext.rscounter.rserr.rslib.rsselect.rsselect_macro.rsutils.rswaker.rs

crossbeam_deque

deque.rslib.rs

crossbeam_epoch

sync

list.rsmod.rsqueue.rs

atomic.rscollector.rsdefault.rsdeferred.rsepoch.rsguard.rsinternal.rslib.rs

crossbeam_utils

atomic

atomic_cell.rsconsume.rsmod.rsseq_lock.rs

sync

mod.rsparker.rssharded_lock.rswait_group.rs

backoff.rscache_padded.rslib.rsthread.rs

deflate

bit_reverse.rsbitstream.rschained_hash_table.rschecksum.rscompress.rscompression_options.rsdeflate_state.rsencoder_state.rshuffman_lengths.rshuffman_table.rsinput_buffer.rslength_encode.rslib.rslz77.rslzvalue.rsmatching.rsoutput_writer.rsrle.rsstored_block.rswriter.rszlib.rs

dlib

lib.rs

downcast_rs

lib.rs

draw_state

lib.rspreset.rsstate.rstarget.rs

either

lib.rs

event_loop

lib.rs

float

lib.rs

fnv

lib.rs

gfx

macros

mod.rspso.rsstructure.rs

pso

buffer.rsbundle.rsmod.rsresource.rstarget.rs

encoder.rsfactory.rslib.rsshade.rsslice.rs

gfx_core

buffer.rscommand.rsdummy.rsfactory.rsformat.rshandle.rslib.rsmapping.rsmemory.rspso.rsshade.rstexture.rs

gfx_device_gl

command.rsfactory.rsinfo.rslib.rsshade.rsstate.rstex.rs

gfx_gl

lib.rs

gfx_graphics

back_end.rslib.rs

gfx_texture

lib.rs

gif

reader

decoder.rsmod.rs

common.rsencoder.rslib.rstraits.rs

gl

lib.rs

glutin

api

egl

make_current_guard.rsmod.rs

glx

make_current_guard.rsmod.rs

osmesa

mod.rs

dlloader.rsmod.rs

platform

mod.rsunix.rs

platform_impl

unix

x11

utils.rs

mod.rswayland.rsx11.rs

mod.rs

context.rslib.rswindowed.rs

glutin_egl_sys

lib.rs

glutin_glx_sys

lib.rs

glutin_window

lib.rs

graphics

glyph_cache

mod.rsrusttype.rs

character.rscircle_arc.rscolor.rscolored.rscontext.rsdraw_state.rsellipse.rsgraphics.rsgrid.rsimage.rslib.rsline.rsmath.rsmodular_index.rspolygon.rsrectangle.rsrectangled.rssource_rectangled.rstext.rstexture_packer.rstransformed.rstriangulation.rstypes.rs

graphics_api_version

lib.rs

image

codecs

bmp

decoder.rsencoder.rsmod.rs

hdr

decoder.rsencoder.rsmod.rs

ico

decoder.rsencoder.rsmod.rs

jpeg

decoder.rsencoder.rsentropy.rsmod.rstransform.rs

pnm

autobreak.rsdecoder.rsencoder.rsheader.rsmod.rs

tga

decoder.rsencoder.rsheader.rsmod.rs

webp

decoder.rsmod.rstransform.rsvp8.rs

dds.rsdxt.rsfarbfeld.rsgif.rspng.rstiff.rs

imageops

affine.rscolorops.rsmod.rssample.rs

io

free_functions.rsmod.rsreader.rs

math

mod.rsnq.rsrect.rsutils.rs

utils

mod.rs

animation.rsbuffer.rscolor.rsdynimage.rserror.rsflat.rsimage.rslib.rstraits.rs

input

after_render.rsbutton.rsclose.rscontroller.rscursor.rsevent_id.rsfocus.rsgeneric_event.rsidle.rskeyboard.rslib.rsmouse.rsrender.rsresize.rstext.rstouch.rsupdate.rs

instant

lib.rsnative.rs

interpolation

ease.rslerp.rslib.rs

iovec

sys

mod.rsunix.rs

lib.rsunix.rs

jpeg_decoder

worker

immediate.rsmod.rsmultithreaded.rs

decoder.rserror.rshuffman.rsidct.rslib.rsmarker.rsparser.rsupsampler.rs

lazy_static

inline_lazy.rslib.rs

lazycell

lib.rs

libc

unix

linux_like

linux

arch

generic

mod.rs

mod.rs

gnu

b64

x86_64

align.rsmod.rsnot_x32.rs

mod.rs

align.rsmod.rs

align.rsmod.rs

mod.rs

align.rsmod.rs

fixed_width_ints.rslib.rsmacros.rs

libloading

os

unix

consts.rsmod.rs

mod.rs

changelog.rserror.rslib.rsutil.rs

lock_api

lib.rsmutex.rsremutex.rsrwlock.rs

log

lib.rsmacros.rs

maybe_uninit

lib.rs

memchr

x86

mod.rssse2.rs

fallback.rsiter.rslib.rsnaive.rs

memmap2

lib.rsunix.rs

memoffset

lib.rsoffset_of.rsraw_field.rsspan_of.rs

miniz_oxide

deflate

buffer.rscore.rsmod.rsstream.rs

inflate

core.rsmod.rsoutput_buffer.rsstream.rs

lib.rsshared.rs

mio

deprecated

event_loop.rshandler.rsio.rsmod.rsnotify.rsunix.rs

net

mod.rstcp.rsudp.rs

sys

unix

awakener.rsdlsym.rsepoll.rseventedfd.rsio.rsmod.rsready.rstcp.rsudp.rsuds.rsuio.rs

mod.rs

channel.rsevent_imp.rsio.rslazycell.rslib.rspoll.rstimer.rstoken.rsudp.rs

mio_extras

channel.rslib.rstimer.rs

net2

sys

unix

impls.rsmod.rs

ext.rslib.rssocket.rstcp.rsudp.rsunix.rsutils.rs

nix

net

if_.rsmod.rs

sys

ioctl

linux.rsmod.rs

ptrace

linux.rsmod.rs

socket

addr.rsmod.rssockopt.rs

aio.rsepoll.rseventfd.rsinotify.rsmemfd.rsmman.rsmod.rspersonality.rspthread.rsquota.rsreboot.rsselect.rssendfile.rssignal.rssignalfd.rsstat.rsstatfs.rsstatvfs.rssysinfo.rstermios.rstime.rstimerfd.rsuio.rsutsname.rswait.rs

dir.rsenv.rserrno.rsfcntl.rsfeatures.rsifaddrs.rskmod.rslib.rsmacros.rsmount.rsmqueue.rspoll.rspty.rssched.rstime.rsucontext.rsunistd.rs

nom

bits

complete.rsmacros.rsmod.rsstreaming.rs

branch

macros.rsmod.rs

bytes

complete.rsmacros.rsmod.rsstreaming.rs

character

complete.rsmacros.rsmod.rsstreaming.rs

combinator

macros.rsmod.rs

multi

macros.rsmod.rs

number

complete.rsmacros.rsmod.rsstreaming.rs

sequence

macros.rsmod.rs

error.rsinternal.rslib.rsstr.rstraits.rsutil.rs

num_cpus

lib.rslinux.rs

num_integer

average.rslib.rsroots.rs

num_iter

lib.rs

num_rational

lib.rspow.rs

num_traits

ops

checked.rsinv.rsmod.rsmul_add.rsoverflowing.rssaturating.rswrapping.rs

bounds.rscast.rsfloat.rsidentities.rsint.rslib.rsmacros.rspow.rsreal.rssign.rs

once_cell

imp_std.rslib.rsrace.rs

osmesa_sys

lib.rs

owned_ttf_parser

convert.rslib.rsowned.rs

parking_lot

condvar.rsdeadlock.rselision.rsfair_mutex.rslib.rsmutex.rsonce.rsraw_fair_mutex.rsraw_mutex.rsraw_rwlock.rsremutex.rsrwlock.rsutil.rs

parking_lot_core

thread_parker

linux.rsmod.rs

lib.rsparking_lot.rsspinwait.rsutil.rsword_lock.rs

percent_encoding

lib.rs

piston

lib.rs

piston_window

lib.rs

png

decoder

mod.rsstream.rszlib.rs

chunk.rscommon.rsencoder.rsfilter.rslib.rstraits.rsutils.rs

proc_macro2

detection.rsfallback.rslib.rsmarker.rsparse.rswrapper.rs

quote

ext.rsformat.rsident_fragment.rslib.rsruntime.rsspanned.rsto_tokens.rs

raw_window_handle

lib.rsunix.rs

rayon

collections

binary_heap.rsbtree_map.rsbtree_set.rshash_map.rshash_set.rslinked_list.rsmod.rsvec_deque.rs

compile_fail

cannot_collect_filtermap_data.rscannot_zip_filtered_data.rscell_par_iter.rsmod.rsmust_use.rsno_send_par_iter.rsrc_par_iter.rs

iter

collect

consumer.rsmod.rs

find_first_last

mod.rs

plumbing

mod.rs

chain.rschunks.rscloned.rscopied.rsempty.rsenumerate.rsextend.rsfilter.rsfilter_map.rsfind.rsflat_map.rsflat_map_iter.rsflatten.rsflatten_iter.rsfold.rsfor_each.rsfrom_par_iter.rsinspect.rsinterleave.rsinterleave_shortest.rsintersperse.rslen.rsmap.rsmap_with.rsmod.rsmultizip.rsnoop.rsonce.rspanic_fuse.rspar_bridge.rspositions.rsproduct.rsreduce.rsrepeat.rsrev.rsskip.rssplitter.rsstep_by.rssum.rstake.rstry_fold.rstry_reduce.rstry_reduce_with.rsunzip.rsupdate.rswhile_some.rszip.rszip_eq.rs

slice

mergesort.rsmod.rsquicksort.rs

delegate.rslib.rsmath.rsoption.rspar_either.rsprelude.rsprivate.rsrange.rsrange_inclusive.rsresult.rssplit_producer.rsstr.rsstring.rsvec.rs

rayon_core

compile_fail

mod.rsquicksort_race1.rsquicksort_race2.rsquicksort_race3.rsrc_return.rsrc_upvar.rsscope_join_bad.rs

join

mod.rs

scope

mod.rs

sleep

counters.rsmod.rs

spawn

mod.rs

thread_pool

mod.rs

job.rslatch.rslib.rslog.rsprivate.rsregistry.rsunwind.rsutil.rs

read_color

lib.rs

rusttype

font.rsgeometry.rslib.rsoutliner.rs

same_file

lib.rsunix.rs

scoped_threadpool

lib.rs

scoped_tls

lib.rs

scopeguard

lib.rs

serde

de

ignored_any.rsimpls.rsmod.rsseed.rsutf8.rsvalue.rs

private

de.rsdoc.rsmod.rsser.rssize_hint.rs

ser

fmt.rsimpls.rsimpossible.rsmod.rs

integer128.rslib.rsmacros.rs

serde_derive

internals

ast.rsattr.rscase.rscheck.rsctxt.rsmod.rsreceiver.rsrespan.rssymbol.rs

bound.rsde.rsdummy.rsfragment.rslib.rspretend.rsser.rstry.rs

shader_version

glsl.rslib.rsopengl.rs

shaders_graphics2d

colored

mod.rs

textured

mod.rs

textured_color

mod.rs

lib.rs

shared_library

dynamic_library.rslib.rs

slab

lib.rs

smallvec

lib.rs

smithay_client_toolkit

data_device

device.rsmod.rsoffer.rssource.rs

primary_selection

device.rsmod.rsoffer.rssource.rs

seat

keyboard

ffi.rskeysyms.rsmod.rsstate.rs

pointer

mod.rstheme.rs

mod.rs

shell

mod.rswl.rsxdg.rszxdg.rs

shm

mempool.rsmod.rs

window

concept_frame.rsmod.rs

environment.rsevent_loop.rslazy_global.rslib.rsoutput.rssurface.rs

spin_sleep

lib.rsloop_helper.rs

syn

gen

clone.rsdebug.rseq.rsgen_helper.rshash.rsvisit.rs

attr.rsawait.rsbigint.rsbuffer.rscustom_keyword.rscustom_punctuation.rsdata.rsderive.rsdiscouraged.rserror.rsexport.rsexpr.rsext.rsfile.rsgenerics.rsgroup.rsident.rsitem.rslib.rslifetime.rslit.rslookahead.rsmac.rsmacros.rsop.rsparse.rsparse_macro_input.rsparse_quote.rspat.rspath.rsprint.rspunctuated.rsreserved.rssealed.rsspan.rsspanned.rsstmt.rsthread.rstoken.rstt.rsty.rsverbatim.rswhitespace.rs

texture

lib.rsops.rs

tiff

decoder

ifd.rsmod.rsstream.rs

encoder

colortype.rsmod.rswriter.rs

bytecast.rserror.rslib.rstags.rs

ttf_parser

tables

avar.rscbdt.rscblc.rscff.rscff2.rscmap.rsfvar.rsgdef.rsglyf.rsgvar.rshead.rshhea.rshmtx.rshvar.rskern.rsloca.rsmaxp.rsmod.rsmvar.rsname.rsos2.rspost.rssbix.rssvg.rsvhea.rsvorg.rs

ggg.rslib.rsparser.rsvar_store.rswriter.rs

unicode_xid

lib.rstables.rs

vecmath

lib.rstraits.rs

viewport

lib.rs

walkdir

dent.rserror.rslib.rsutil.rs

wayland_client

native_lib

display.rsevent_queue.rsmod.rsproxy.rs

display.rsevent_queue.rsglobals.rslib.rsproxy.rs

wayland_commons

debug.rsfilter.rslib.rsmap.rssocket.rsuser_data.rswire.rs

wayland_cursor

lib.rs

wayland_egl

lib.rs

wayland_protocols

lib.rsmisc.rsprotocol_macro.rsstable.rsunstable.rswlr.rs

wayland_sys

client.rscommon.rsegl.rslib.rsserver.rs

weezl

decode.rsencode.rserror.rslib.rs

window

lib.rsno_window.rs

winit

platform

mod.rsrun_return.rsunix.rs

platform_impl

linux

wayland

event_loop

mod.rsproxy.rssink.rsstate.rs

seat

keyboard

handlers.rskeymap.rsmod.rs

pointer

data.rshandlers.rsmod.rs

text_input

handlers.rsmod.rs

touch

handlers.rsmod.rs

mod.rs

window

mod.rsshim.rs

env.rsmod.rsoutput.rs

x11

ime

callbacks.rscontext.rsinner.rsinput_method.rsmod.rs

util

atom.rsclient_msg.rscursor.rsformat.rsgeometry.rshint.rsicon.rsinput.rskeys.rsmemory.rsmod.rsmodifiers.rsrandr.rswindow_property.rswm.rs

dnd.rsevent_processor.rsevents.rsffi.rsmod.rsmonitor.rswindow.rsxdisplay.rs

mod.rs

mod.rs

dpi.rserror.rsevent.rsevent_loop.rsicon.rslib.rsmonitor.rswindow.rs

x11_dl

dpms.rserror.rsglx.rsinternal.rskeysym.rslib.rslink.rsold_xrandr.rsxcursor.rsxf86vmode.rsxfixes.rsxft.rsxinerama.rsxinput.rsxinput2.rsxlib.rsxlib_xcb.rsxmd.rsxmu.rsxrandr.rsxrecord.rsxrender.rsxss.rsxt.rsxtest.rs

xcursor

lib.rsparser.rs

xdg

lib.rs

xml

reader

parser

inside_cdata.rsinside_closing_tag_name.rsinside_comment.rsinside_declaration.rsinside_doctype.rsinside_opening_tag.rsinside_processing_instruction.rsinside_reference.rsmod.rsoutside_tag.rs

config.rserror.rsevents.rslexer.rsmod.rs

writer

config.rsemitter.rsevents.rsmod.rs

attribute.rscommon.rsescape.rslib.rsmacros.rsname.rsnamespace.rsutil.rs

>

//! Interoperability library for Rust Windowing applications.
//!
//! This library provides standard types for accessing a window's platform-specific raw window
//! handle. This does not provide any utilities for creating and managing windows; instead, it
//! provides a common interface that window creation libraries (e.g. Winit, SDL) can use to easily
//! talk with graphics libraries (e.g. gfx-hal).
//!
//! ## Platform handle initialization
//!
//! Each platform handle struct is purposefully non-exhaustive, so that additional fields may be
//! added without breaking backwards compatibility. Each struct provides an `empty` method that may
//! be used along with the struct update syntax to construct it. See each specific struct for
//! examples.
//!
#![cfg_attr(feature = "nightly-docs", feature(doc_cfg))]
#![no_std]

#[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "android")))]
#[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "android"))]
pub mod android;
#[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "ios")))]
#[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "ios"))]
pub mod ios;
#[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "macos")))]
#[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "macos"))]
pub mod macos;
#[cfg_attr(
    feature = "nightly-docs",
    doc(cfg(any(
        target_os = "linux",
        target_os = "dragonfly",
        target_os = "freebsd",
        target_os = "netbsd",
        target_os = "openbsd"
    )))
)]
#[cfg_attr(
    not(feature = "nightly-docs"),
    cfg(any(
        target_os = "linux",
        target_os = "dragonfly",
        target_os = "freebsd",
        target_os = "netbsd",
        target_os = "openbsd"
    ))
)]
pub mod unix;
#[cfg_attr(feature = "nightly-docs", doc(cfg(target_arch = "wasm32")))]
#[cfg_attr(not(feature = "nightly-docs"), cfg(target_arch = "wasm32"))]
pub mod web;
#[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "windows")))]
#[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "windows"))]
pub mod windows;

mod platform {
    #[cfg(target_os = "android")]
    pub use crate::android::*;
    #[cfg(target_os = "macos")]
    pub use crate::macos::*;
    #[cfg(any(
        target_os = "linux",
        target_os = "dragonfly",
        target_os = "freebsd",
        target_os = "netbsd",
        target_os = "openbsd"
    ))]
    pub use crate::unix::*;
    #[cfg(target_os = "windows")]
    pub use crate::windows::*;
    // mod platform;
    #[cfg(target_os = "ios")]
    pub use crate::ios::*;
    #[cfg(target_arch = "wasm32")]
    pub use crate::web::*;
}

/// Window that wraps around a raw window handle.
///
/// # Safety guarantees
///
/// Users can safely assume that non-`null`/`0` fields are valid handles, and it is up to the
/// implementer of this trait to ensure that condition is upheld. However, It is entirely valid
/// behavior for fields within each platform-specific `RawWindowHandle` variant to be `null` or
/// `0`, and appropriate checking should be done before the handle is used.
///
/// Despite that qualification, implementers should still make a best-effort attempt to fill in all
/// available fields. If an implementation doesn't, and a downstream user needs the field, it should
/// try to derive the field from other fields the implementer *does* provide via whatever methods the
/// platform provides.
///
/// The exact handles returned by `raw_window_handle` must remain consistent between multiple calls
/// to `raw_window_handle`, and must be valid for at least the lifetime of the `HasRawWindowHandle`
/// implementer.
pub unsafe trait HasRawWindowHandle {
    fn raw_window_handle(&self) -> RawWindowHandle;
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum RawWindowHandle {
    #[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "ios")))]
    #[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "ios"))]
    IOS(ios::IOSHandle),

    #[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "macos")))]
    #[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "macos"))]
    MacOS(macos::MacOSHandle),

    #[cfg_attr(
        feature = "nightly-docs",
        doc(cfg(any(
            target_os = "linux",
            target_os = "dragonfly",
            target_os = "freebsd",
            target_os = "netbsd",
            target_os = "openbsd"
        )))
    )]
    #[cfg_attr(
        not(feature = "nightly-docs"),
        cfg(any(
            target_os = "linux",
            target_os = "dragonfly",
            target_os = "freebsd",
            target_os = "netbsd",
            target_os = "openbsd"
        ))
    )]
    Xlib(unix::XlibHandle),

    #[cfg_attr(
        feature = "nightly-docs",
        doc(cfg(any(
            target_os = "linux",
            target_os = "dragonfly",
            target_os = "freebsd",
            target_os = "netbsd",
            target_os = "openbsd"
        )))
    )]
    #[cfg_attr(
        not(feature = "nightly-docs"),
        cfg(any(
            target_os = "linux",
            target_os = "dragonfly",
            target_os = "freebsd",
            target_os = "netbsd",
            target_os = "openbsd"
        ))
    )]
    Xcb(unix::XcbHandle),

    #[cfg_attr(
        feature = "nightly-docs",
        doc(cfg(any(
            target_os = "linux",
            target_os = "dragonfly",
            target_os = "freebsd",
            target_os = "netbsd",
            target_os = "openbsd"
        )))
    )]
    #[cfg_attr(
        not(feature = "nightly-docs"),
        cfg(any(
            target_os = "linux",
            target_os = "dragonfly",
            target_os = "freebsd",
            target_os = "netbsd",
            target_os = "openbsd"
        ))
    )]
    Wayland(unix::WaylandHandle),

    #[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "windows")))]
    #[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "windows"))]
    Windows(windows::WindowsHandle),

    #[cfg_attr(feature = "nightly-docs", doc(cfg(target_arch = "wasm32")))]
    #[cfg_attr(not(feature = "nightly-docs"), cfg(target_arch = "wasm32"))]
    Web(web::WebHandle),

    #[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "android")))]
    #[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "android"))]
    Android(android::AndroidHandle),

    #[doc(hidden)]
    #[deprecated = "This field is used to ensure that this struct is non-exhaustive, so that it may be extended in the future. Do not refer to this field."]
    __NonExhaustiveDoNotUse(seal::Seal),
}

mod seal {
    #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
    pub struct Seal;
}