18 lines
16 KiB
HTML
18 lines
16 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A display that acts as a wrapper around a display handle."><title>HasDisplayHandle in raw_window_handle - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="raw_window_handle" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../raw_window_handle/index.html">raw_<wbr>window_<wbr>handle</a><span class="version">0.6.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">HasDisplay<wbr>Handle</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.display_handle" title="display_handle">display_handle</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-HasDisplayHandle-for-%26H" title="&H">&H</a></li><li><a href="#impl-HasDisplayHandle-for-%26mut+H" title="&mut H">&mut H</a></li><li><a href="#impl-HasDisplayHandle-for-Arc%3CH%3E" title="Arc<H>">Arc<H></a></li><li><a href="#impl-HasDisplayHandle-for-Box%3CH%3E" title="Box<H>">Box<H></a></li><li><a href="#impl-HasDisplayHandle-for-Rc%3CH%3E" title="Rc<H>">Rc<H></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate raw_<wbr>window_<wbr>handle</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">raw_window_handle</a></span><h1>Trait <span class="trait">HasDisplayHandle</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/raw_window_handle/borrowed.rs.html#33-36">Source</a> </span></div><pre class="rust item-decl"><code>pub trait HasDisplayHandle {
|
|
// Required method
|
|
fn <a href="#tymethod.display_handle" class="fn">display_handle</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle">DisplayHandle</a><'_>, <a class="enum" href="enum.HandleError.html" title="enum raw_window_handle::HandleError">HandleError</a>>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A display that acts as a wrapper around a display handle.</p>
|
|
<p>Objects that implement this trait should be able to return a <a href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle"><code>DisplayHandle</code></a> for the display
|
|
that they are associated with. This handle should last for the lifetime of the object, and should
|
|
return an error if the application is inactive.</p>
|
|
<p>Implementors of this trait will be windowing systems, like <a href="https://crates.io/crates/winit"><code>winit</code></a> and <a href="https://crates.io/crates/sdl2"><code>sdl2</code></a>. These windowing
|
|
systems should implement this trait on types that represent the top-level display server. It
|
|
should be implemented by tying the lifetime of the <a href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle"><code>DisplayHandle</code></a> to the lifetime of the
|
|
display object.</p>
|
|
<p>Users of this trait will include graphics libraries, like <a href="https://crates.io/crates/wgpu"><code>wgpu</code></a> and <a href="https://crates.io/crates/glutin"><code>glutin</code></a>. These APIs
|
|
should be generic over a type that implements <code>HasDisplayHandle</code>, and should use the
|
|
<a href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle"><code>DisplayHandle</code></a> type to access the display handle.</p>
|
|
<p>Note that these requirements are not enforced on <code>HasDisplayHandle</code>, rather, they are enforced on the
|
|
constructors of <a href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle"><code>DisplayHandle</code></a>. This is because the <code>HasDisplayHandle</code> trait is safe to implement.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.display_handle" class="method"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#35">Source</a><h4 class="code-header">fn <a href="#tymethod.display_handle" class="fn">display_handle</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle">DisplayHandle</a><'_>, <a class="enum" href="enum.HandleError.html" title="enum raw_window_handle::HandleError">HandleError</a>></h4></section></summary><div class="docblock"><p>Get a handle to the display controller of the windowing system.</p>
|
|
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-HasDisplayHandle-for-%26H" class="impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#38-42">Source</a><a href="#impl-HasDisplayHandle-for-%26H" class="anchor">§</a><h3 class="code-header">impl<H: <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&H</a></h3></section></summary><div class="impl-items"><section id="method.display_handle" class="method trait-impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#39-41">Source</a><a href="#method.display_handle" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.display_handle" class="fn">display_handle</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle">DisplayHandle</a><'_>, <a class="enum" href="enum.HandleError.html" title="enum raw_window_handle::HandleError">HandleError</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-HasDisplayHandle-for-%26mut+H" class="impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#44-48">Source</a><a href="#impl-HasDisplayHandle-for-%26mut+H" class="anchor">§</a><h3 class="code-header">impl<H: <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut H</a></h3></section></summary><div class="impl-items"><section id="method.display_handle-1" class="method trait-impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#45-47">Source</a><a href="#method.display_handle-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.display_handle" class="fn">display_handle</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle">DisplayHandle</a><'_>, <a class="enum" href="enum.HandleError.html" title="enum raw_window_handle::HandleError">HandleError</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-HasDisplayHandle-for-Box%3CH%3E" class="impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#52-56">Source</a><a href="#impl-HasDisplayHandle-for-Box%3CH%3E" class="anchor">§</a><h3 class="code-header">impl<H: <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><H></h3></section></summary><div class="impl-items"><section id="method.display_handle-2" class="method trait-impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#53-55">Source</a><a href="#method.display_handle-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.display_handle" class="fn">display_handle</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle">DisplayHandle</a><'_>, <a class="enum" href="enum.HandleError.html" title="enum raw_window_handle::HandleError">HandleError</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-HasDisplayHandle-for-Rc%3CH%3E" class="impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#60-64">Source</a><a href="#impl-HasDisplayHandle-for-Rc%3CH%3E" class="anchor">§</a><h3 class="code-header">impl<H: <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><H></h3></section></summary><div class="impl-items"><section id="method.display_handle-3" class="method trait-impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#61-63">Source</a><a href="#method.display_handle-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.display_handle" class="fn">display_handle</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle">DisplayHandle</a><'_>, <a class="enum" href="enum.HandleError.html" title="enum raw_window_handle::HandleError">HandleError</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-HasDisplayHandle-for-Arc%3CH%3E" class="impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#68-72">Source</a><a href="#impl-HasDisplayHandle-for-Arc%3CH%3E" class="anchor">§</a><h3 class="code-header">impl<H: <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><H></h3></section></summary><div class="impl-items"><section id="method.display_handle-4" class="method trait-impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#69-71">Source</a><a href="#method.display_handle-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.display_handle" class="fn">display_handle</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle">DisplayHandle</a><'_>, <a class="enum" href="enum.HandleError.html" title="enum raw_window_handle::HandleError">HandleError</a>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-HasDisplayHandle-for-DisplayHandle%3C'a%3E" class="impl"><a class="src rightside" href="../src/raw_window_handle/borrowed.rs.html#136-140">Source</a><a href="#impl-HasDisplayHandle-for-DisplayHandle%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.HasDisplayHandle.html" title="trait raw_window_handle::HasDisplayHandle">HasDisplayHandle</a> for <a class="struct" href="struct.DisplayHandle.html" title="struct raw_window_handle::DisplayHandle">DisplayHandle</a><'a></h3></section></div><script src="../trait.impl/raw_window_handle/borrowed/trait.HasDisplayHandle.js" data-ignore-extern-crates="alloc" async></script></section></div></main></body></html> |