|
|
|
|
|
<!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="API documentation for the Rust `Sampler` struct in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, Sampler"><title>vulkano::sampler::Sampler - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../vulkano/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/vulkano-rs/vulkano/master/logo.png' alt='logo'></div></a><p class='location'>Struct Sampler</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.compare">compare</a><a href="#method.compare_mode">compare_mode</a><a href="#method.is_unnormalized">is_unnormalized</a><a href="#method.new">new</a><a href="#method.simple_repeat_linear">simple_repeat_linear</a><a href="#method.simple_repeat_linear_no_mipmap">simple_repeat_linear_no_mipmap</a><a href="#method.unnormalized">unnormalized</a><a href="#method.usable_with_float_formats">usable_with_float_formats</a><a href="#method.usable_with_int_formats">usable_with_int_formats</a><a href="#method.usable_with_swizzling">usable_with_swizzling</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-DeviceOwned">DeviceOwned</a><a href="#impl-Drop">Drop</a><a href="#impl-VulkanObject">VulkanObject</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-Content">Content</a><a href="#impl-DeviceOwned">DeviceOwned</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='../index.html'>vulkano</a>::<wbr><a href='index.html'>sampler</a></p><script>window.sidebarCurrent = {name: 'Sampler', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section
|
|
|
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/vulkano/sampler.rs.html#92-473' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.simple_repeat_linear' class="method"><code id='simple_repeat_linear.v'>pub fn <a href='#method.simple_repeat_linear' class='fnname'>simple_repeat_linear</a>(device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/device/struct.Device.html" title="struct vulkano::device::Device">Device</a>>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a>></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#103-116' title='goto source code'>[src]</a></h4><div class='docblock'><p>Shortcut for creating a sampler with linear sampling, linear mipmaps, and with the repeat
|
|
|
|
|
|
mode for borders.</p>
|
|
|
|
|
|
<p>Useful for prototyping, but can also be used in real projects.</p>
|
|
|
|
|
|
<h1 id="panic" class="section-header"><a href="#panic">Panic</a></h1>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>Panics if out of memory or the maximum number of samplers has exceeded.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div><h4 id='method.simple_repeat_linear_no_mipmap' class="method"><code id='simple_repeat_linear_no_mipmap.v'>pub fn <a href='#method.simple_repeat_linear_no_mipmap' class='fnname'>simple_repeat_linear_no_mipmap</a>(device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/device/struct.Device.html" title="struct vulkano::device::Device">Device</a>>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a>></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#128-141' title='goto source code'>[src]</a></h4><div class='docblock'><p>Shortcut for creating a sampler with linear sampling, that only uses the main level of
|
|
|
|
|
|
images, and with the repeat mode for borders.</p>
|
|
|
|
|
|
<p>Useful for prototyping, but can also be used in real projects.</p>
|
|
|
|
|
|
<h1 id="panic-1" class="section-header"><a href="#panic-1">Panic</a></h1>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>Panics if out of memory or the maximum number of samplers has exceeded.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>(<br> device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/device/struct.Device.html" title="struct vulkano::device::Device">Device</a>>, <br> mag_filter: <a class="enum" href="../../vulkano/sampler/enum.Filter.html" title="enum vulkano::sampler::Filter">Filter</a>, <br> min_filter: <a class="enum" href="../../vulkano/sampler/enum.Filter.html" title="enum vulkano::sampler::Filter">Filter</a>, <br> mipmap_mode: <a class="enum" href="../../vulkano/sampler/enum.MipmapMode.html" title="enum vulkano::sampler::MipmapMode">MipmapMode</a>, <br> address_u: <a class="enum" href="../../vulkano/sampler/enum.SamplerAddressMode.html" title="enum vulkano::sampler::SamplerAddressMode">SamplerAddressMode</a>, <br> address_v: <a class="enum" href="../../vulkano/sampler/enum.SamplerAddressMode.html" title="enum vulkano::sampler::SamplerAddressMode">SamplerAddressMode</a>, <br> address_w: <a class="enum" href="../../vulkano/sampler/enum.SamplerAddressMode.html" title="enum vulkano::sampler::SamplerAddressMode">SamplerAddressMode</a>, <br> mip_lod_bias: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> max_anisotropy: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> min_lod: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> max_lod: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a>>, <a class="enum" href="../../vulkano/sampler/enum.SamplerCreationError.html" title="enum vulkano::sampler::SamplerCreationError">SamplerCreationError</a>></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#169-186' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new <code>Sampler</code> with the given behavior.</p>
|
|
|
|
|
|
<p><code>mag_filter</code> and <code>min_filter</code> define how the implementation should sample from the image
|
|
|
|
|
|
when it is respectively larger and smaller than the original.</p>
|
|
|
|
|
|
<p><code>mipmap_mode</code> defines how the implementation should choose which mipmap to use.</p>
|
|
|
|
|
|
<p><code>address_u</code>, <code>address_v</code> and <code>address_w</code> define how the implementation should behave when
|
|
|
|
|
|
sampling outside of the texture coordinates range <code>[0.0, 1.0]</code>.</p>
|
|
|
|
|
|
<p><code>mip_lod_bias</code> is a value to add to .</p>
|
|
|
|
|
|
<p><code>max_anisotropy</code> must be greater than or equal to 1.0. If greater than 1.0, the
|
|
|
|
|
|
implementation will use anisotropic filtering. Using a value greater than 1.0 requires
|
|
|
|
|
|
the <code>sampler_anisotropy</code> feature to be enabled when creating the device.</p>
|
|
|
|
|
|
<p><code>min_lod</code> and <code>max_lod</code> are respectively the minimum and maximum mipmap level to use.
|
|
|
|
|
|
<code>max_lod</code> must always be greater than or equal to <code>min_lod</code>.</p>
|
|
|
|
|
|
<h1 id="panic-2" class="section-header"><a href="#panic-2">Panic</a></h1>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>Panics if multiple <code>ClampToBorder</code> values are passed and the border color is different.</li>
|
|
|
|
|
|
<li>Panics if <code>max_anisotropy < 1.0</code>.</li>
|
|
|
|
|
|
<li>Panics if <code>min_lod > max_lod</code>.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div><h4 id='method.compare' class="method"><code id='compare.v'>pub fn <a href='#method.compare' class='fnname'>compare</a>(<br> device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/device/struct.Device.html" title="struct vulkano::device::Device">Device</a>>, <br> mag_filter: <a class="enum" href="../../vulkano/sampler/enum.Filter.html" title="enum vulkano::sampler::Filter">Filter</a>, <br> min_filter: <a class="enum" href="../../vulkano/sampler/enum.Filter.html" title="enum vulkano::sampler::Filter">Filter</a>, <br> mipmap_mode: <a class="enum" href="../../vulkano/sampler/enum.MipmapMode.html" title="enum vulkano::sampler::MipmapMode">MipmapMode</a>, <br> address_u: <a class="enum" href="../../vulkano/sampler/enum.SamplerAddressMode.html" title="enum vulkano::sampler::SamplerAddressMode">SamplerAddressMode</a>, <br> address_v: <a class="enum" href="../../vulkano/sampler/enum.SamplerAddressMode.html" title="enum vulkano::sampler::SamplerAddressMode">SamplerAddressMode</a>, <br> address_w: <a class="enum" href="../../vulkano/sampler/enum.SamplerAddressMode.html" title="enum vulkano::sampler::SamplerAddressMode">SamplerAddressMode</a>, <br> mip_lod_bias: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> max_anisotropy: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> min_lod: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> max_lod: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> compare: <a class="enum" href="../../vulkano/pipeline/depth_stencil/enum.Compare.html" title="enum vulkano::pipeline::depth_stencil::Compare">Compare</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a>>, <a class="enum" href="../../vulkano/sampler/enum.SamplerCreationError.html" title="enum vulkano::sampler::SamplerCreationError">SamplerCreationError</a>></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#205-223' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new <code>Sampler</code> with the given behavior.</p>
|
|
|
|
|
|
<p>Contrary to <code>new</code>, this creates a sampler that is used to compare depth values.</p>
|
|
|
|
|
|
<p>A sampler like this can only operate on depth or depth-stencil textures. Instead of
|
|
|
|
|
|
returning the value of the texture, this sampler will return a value between 0.0 and 1.0
|
|
|
|
|
|
indicating how much the reference value (passed by the shader) compares to the value in the
|
|
|
|
|
|
texture.</p>
|
|
|
|
|
|
<p>Note that it doesn't make sense to create a compare-mode sampler with an integer border
|
|
|
|
|
|
color, as such a sampler would be unusable.</p>
|
|
|
|
|
|
<h1 id="panic-3" class="section-header"><a href="#panic-3">Panic</a></h1>
|
|
|
|
|
|
<p>Same panic reasons as <code>new</code>.</p>
|
|
|
|
|
|
</div><h4 id='method.unnormalized' class="method"><code id='unnormalized.v'>pub fn <a href='#method.unnormalized' class='fnname'>unnormalized</a>(<br> device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/device/struct.Device.html" title="struct vulkano::device::Device">Device</a>>, <br> filter: <a class="enum" href="../../vulkano/sampler/enum.Filter.html" title="enum vulkano::sampler::Filter">Filter</a>, <br> address_u: <a class="enum" href="../../vulkano/sampler/enum.UnnormalizedSamplerAddressMode.html" title="enum vulkano::sampler::UnnormalizedSamplerAddressMode">UnnormalizedSamplerAddressMode</a>, <br> address_v: <a class="enum" href="../../vulkano/sampler/enum.UnnormalizedSamplerAddressMode.html" title="enum vulkano::sampler::UnnormalizedSamplerAddressMode">UnnormalizedSamplerAddressMode</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a>>, <a class="enum" href="../../vulkano/sampler/enum.SamplerCreationError.html" title="enum vulkano::sampler::SamplerCreationError">SamplerCreationError</a>></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#368-439' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a sampler with unnormalized coordinates. This means that texture coordinates won't
|
|
|
|
|
|
range between <code>0.0</code> and <code>1.0</code> but use plain pixel offsets.</p>
|
|
|
|
|
|
<p>Using an unnormalized sampler adds a few restrictions:</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>It can only be used with non-array 1D or 2D images.</li>
|
|
|
|
|
|
<li>It can only be used with images with a single mipmap.</li>
|
|
|
|
|
|
<li>Projection and offsets can't be used by shaders. Only the first mipmap can be accessed.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h1 id="panic-4" class="section-header"><a href="#panic-4">Panic</a></h1>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>Panics if multiple <code>ClampToBorder</code> values are passed and the border color is different.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div><h4 id='method.compare_mode' class="method"><code id='compare_mode.v'>pub fn <a href='#method.compare_mode' class='fnname'>compare_mode</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#443-445' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns true if the sampler is a compare-mode sampler.</p>
|
|
|
|
|
|
</div><h4 id='method.is_unnormalized' class="method"><code id='is_unnormalized.v'>pub fn <a href='#method.is_unnormalized' class='fnname'>is_unnormalized</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#449-451' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns true if the sampler is unnormalized.</p>
|
|
|
|
|
|
</div><h4 id='method.usable_with_float_formats' class="method"><code id='usable_with_float_formats.v'>pub fn <a href='#method.usable_with_float_formats' class='fnname'>usable_with_float_formats</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#456-458' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns true if the sampler can be used with floating-point image views. See the
|
|
|
|
|
|
documentation of the <code>sampler</code> module for more info.</p>
|
|
|
|
|
|
</div><h4 id='method.usable_with_int_formats' class="method"><code id='usable_with_int_formats.v'>pub fn <a href='#method.usable_with_int_formats' class='fnname'>usable_with_int_formats</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#463-465' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns true if the sampler can be used with integer image views. See the documentation of
|
|
|
|
|
|
the <code>sampler</code> module for more info.</p>
|
|
|
|
|
|
</div><h4 id='method.usable_with_swizzling' class="method"><code id='usable_with_swizzling.v'>pub fn <a href='#method.usable_with_swizzling' class='fnname'>usable_with_swizzling</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#470-472' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns true if the sampler can be used with image views that have non-identity swizzling.
|
|
|
|
|
|
See the documentation of the <code>sampler</code> module for more info.</p>
|
|
|
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-DeviceOwned' class='impl'><code class='in-band'>impl <a class="trait" href="../../vulkano/device/trait.DeviceOwned.html" title="trait vulkano::device::DeviceOwned">DeviceOwned</a> for <a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a></code><a href='#impl-DeviceOwned' class='anchor'></a><a class='srclink' href='../../src/vulkano/sampler.rs.html#475-480' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.device' class="method hidden"><code id='device.v'>fn <a href='../../vulkano/device/trait.DeviceOwned.html#tymethod.device' class='fnname'>device</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/device/struct.Device.html" title="struct vulkano::device::Device">Device</a>></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#477-479' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the device that owns <code>Self</code>.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-VulkanObject' class='impl'><code class='in-band'>impl <a class="trait" href="../../vulkano/trait.VulkanObject.html" title="trait vulkano::VulkanObject">VulkanObject</a> for <a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a></code><a href='#impl-VulkanObject' class='anchor'></a><a class='srclink' href='../../src/vulkano/sampler.rs.html#482-491' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Object' class="type"><code id='Object.t'>type <a href='../../vulkano/trait.VulkanObject.html#associatedtype.Object' class="type">Object</a> = <a class="type" href="../../vk_sys/type.Sampler.html" title="type vk_sys::Sampler">Sampler</a></code></h4><div class='docblock'><p>The type of the object.</p>
|
|
|
|
|
|
</div><h4 id='associatedconstant.TYPE' class="associatedconstant hidden"><code id='TYPE.v'>const <a href='../../vulkano/trait.VulkanObject.html#associatedconstant.TYPE' class="constant"><b>TYPE</b></a>: <a class="type" href="../../vk_sys/type.DebugReportObjectTypeEXT.html" title="type vk_sys::DebugReportObjectTypeEXT">DebugReportObjectTypeEXT</a></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#485' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>The <code>DebugReportObjectTypeEXT</code> of the internal Vulkan handle.</p>
|
|
|
|
|
|
</div><h4 id='method.internal_object' class="method hidden"><code id='internal_object.v'>fn <a href='../../vulkano/trait.VulkanObject.html#tymethod.internal_object' class='fnname'>internal_object</a>(&self) -> <a class="type" href="../../vk_sys/type.Sampler.html" title="type vk_sys::Sampler">Sampler</a></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#488-490' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a reference to the object.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-Drop' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a></code><a href='#impl-Drop' class='anchor'></a><a class='srclink' href='../../src/vulkano/sampler.rs.html#500-508' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.drop' class="method hidden"><code id='drop.v'>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code><a class='srclink' href='../../src/vulkano/sampler.rs.html#502-507' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
|
|
|
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/vulkano/sampler.rs.html#493-498' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code><a class='srclink' href='../../src/vulkano/sampler.rs.html#495-497' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|
|
|
|
|
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-DeviceOwned-1' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../vulkano/device/trait.DeviceOwned.html" title="trait vulkano::device::DeviceOwned">DeviceOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>,<br> <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>: <a class="trait" href="../../vulkano/device/trait.DeviceOwned.html" title="trait vulkano::device::DeviceOwned">DeviceOwned</a>, </span></code><a href='#impl-DeviceOwned-1' class='anchor'></a><a class='srclink' href='../../src/vulkano/device/mod.rs.html#557-565' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.device-1' class="method hidden"><code id='device.v-1'>fn <a href='../../vulkano/device/trait.DeviceOwned.html#tymethod.device' class='fnname'>device</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/device/struct.Device.html" title="struct vulkano::device::Device">Device</a>></code><a class='srclink' href='../../
|
|
|
|
|
|
</div></div><h3 id='impl-Content' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../vulkano/memory/trait.Content.html" title="trait vulkano::memory::Content">Content</a> for T</code><a href='#impl-Content' class='anchor'></a><a class='srclink' href='../../src/vulkano/memory/mod.rs.html#171-190' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.ref_from_ptr' class="method hidden"><code id='ref_from_ptr.v'>fn <a href='../../vulkano/memory/trait.Content.html#tymethod.ref_from_ptr' class='fnname'>ref_from_ptr</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut T</a>></code><a class='srclink' href='../../src/vulkano/memory/mod.rs.html#173-179' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Builds a pointer to this type from a raw pointer.</p>
|
|
|
|
|
|
</div><h4 id='method.is_size_suitable' class="method hidden"><code id='is_size_suitable.v'>fn <a href='../../vulkano/memory/trait.Content.html#tymethod.is_size_suitable' class='fnname'>is_size_suitable</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/vulkano/memory/mod.rs.html#182-184' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the size is suitable to store a type like this.</p>
|
|
|
|
|
|
</div><h4 id='method.indiv_size' class="method hidden"><code id='indiv_size.v'>fn <a href='../../vulkano/memory/trait.Content.html#tymethod.indiv_size' class='fnname'>indiv_size</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../../src/vulkano/memory/mod.rs.html#187-189' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the size of an individual element.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
|
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
|
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
|
|
|
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
|
|
|
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
|
|
|
|
|
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "vulkano";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
